Retrieve Wireguard Peer

Returns the WireGuard Peer by ID.

To retrieve the WireGuard Peer, perform a GET request.

Endpoint

Use a region-specific endpoint to retrieve a WireGuard Peer: https://vpn.{region}.ionos.com/wireguardgateways/{gatewayId}/peers/{peerId}.

Request

curl--location \--request GET'https://api.ionos.com/wireguardgateways/55871672-381f-589c-8809-4ffbecd8b27c/peers/b62b3a40-adee-5b6c-b98d-be20bfcbdd91' \--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO'

Path Parameters

You can update the gatewayId and peerId values to get a specific WireGuard Peer for a given gateway:

Path Parameter	Type	Description	Example
gatewayId	string	The ID (UUID) of the WireGuard Gateway.	85c79b4b-5b40-570a-b788-58dd46ea71e2
peerId	string	The ID (UUID) of the WireGuard Peer.	b62b3a40-adee-5b6c-b98d-be20bfcbdd91

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameter	Required	Type	Description
Authorization	yes	string	The Bearer token to enable requests to authenticate using a JSON Web Token (JWT).
Content-Type	no	string	Set this to application/json.

Response

200 Successful operation

{"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":"198.51.100.0/24","port":51820 },"allowedIPs": ["198.51.100.0/24" ],"publicKey":"no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI=" }}

Result: The WireGuard Peer and its details for the specified gatewayId and peerId are successfully obtained.