Retrieve Wireguard Gateway

Returns the WireGuard Gateway by ID.

To retrieve the WireGuard Gateway, perform a GET request.

Endpoint

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

Request

Note: The following request contains a sample gatewayId. Replace them with the gatewayId value, whose information you want to retrieve.

curl--location \--request GET'https://vpn.de-fra.ionos.com/wireguardgateways/85c79b4b-5b40-570a-b788-58dd46ea71e2' \--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO'

You can update the gatewayId value to get a specific WireGuard Gateway:

Path Parameter
Type
Description
Example

gatewayId

string

The ID (UUID) of the WireGuard Gateway.

85c79b4b-5b40-570a-b788-58dd46ea71e2

Response

200 Successful operation

{"id":"85c79b4b-5b40-570a-b788-58dd46ea71e2","type":"wireguardgateway","href":"/wireguardgateways/85c79b4b-5b40-570a-b788-58dd46ea71e2","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,"publicKey":"-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VuAyEApNLcmIfCLRwyGYN16teusuGPkdGo2C8OxiqaJLgOig4=\n-----END PUBLIC KEY-----\n" },"properties": {"name":"My Company Gateway","description":"This gateway allows connections to Datacenter LAN X.","gatewayIP":"81.173.1.2","interfaceIPv4CIDR":"172.16.0.1/30","interfaceIPv6CIDR":"fd00::2/128","connections": [ {"datacenterId":"5a029f4a-72e5-11ec-90d6-0242ac120003","lanId":"2","ipv4CIDR":"192.168.1.100/24","ipv6CIDR":"fd28:5f8d:d9fe:08bd::/64" } ],"listenPort":51820,"tier":"STANDARD","maintenanceWindow": {"time":"16:30:59","dayOfTheWeek":"Monday" } }}

Last updated

Was this helpful?

close