This endpoint enables retrieving all Wireguard Peers using pagination and optional filters.
To retrieve all the Wireguard Peers, perform a GET request.
Endpoint
Use the following endpoint to retrieve all wireguard peers: https://vpn.de-fra.ionos.com/wireguardgateways/{gatewayId}/peers.
Request
curl--location \--request GET 'https://vpn.de-fra.ionos.com/wireguardgateways/55871672-381f-589c-8809-4ffbecd8b27c/peers?limit=100&offset=0' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO'
Below is the list of optional Path Parameters:
Query Parameters
Type
Description
Example
offset
integer
The first element (of the total list of elements) to include in the response. Use together with limit for pagination. Default: 0
0
limit
integer
The maximum number of elements to return. Use together with offset for pagination. Default: 100
100
To make authenticated requests to the API, the following fields are mandatory in the request header:
Header Parameters
Required
Type
Description
Authorization
yes
string
The Bearer token enables requests to authenticate using a JSON Web Token (JWT).
Content-Type
no
string
Set this to application/json.
Response
200 Successful operation
{"id":"7c33f158-b93c-5fe7-83c6-84dde2357a33","type":"collection","href":"/wireguardgateways/{gatewayId}/peers","items": [ {"id":"b62b3a40-adee-5b6c-b98d-be20bfcbdd91","type":"wireguardpeer","href":"/wireguardgateways/{gatewayId}/peers/b62b3a40-adee-5b6c-b98d-be20bfcbdd91","metadata": {"createdDate":"2020-12-10T13:37:50+01:00","createdBy":"ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3","createdByUserId":"87f9a82e-b28d-49ed-9d04-fba2c0459cd3","lastModifiedDate":"2020-12-11T13:37:50+01:00","lastModifiedBy":"ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3","lastModifiedByUserId":"87f9a82e-b28d-49ed-9d04-fba2c0459cd3","resourceURN":"ionos:<product>:<location>:<contract>:<resource-path>","status":"AVAILABLE","statusMessage":null },"properties": {"name":"My Company Gateway Peer","description":"Allows local machine A to connect to Datacenter LAN Y.","endpoint": {"host":"1.2.3.4","port":51820 },"allowedIPs": ["1.2.3.4/32" ],"publicKey":"no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI=" } } ],"offset":0,"limit":42,"_links": {"prev":"http://PREVIOUS-PAGE-URI","self":"http://THIS-PAGE-URI","next":"http://NEXT-PAGE-URI" }}
Result: All existing Wireguard Peers and their details are successfully obtained.