You can update the gatewayId value to get a specific WireGuard Gateway:
Path Parameter
Type
Description
Example
To make authenticated requests to the API, the following fields are mandatory in the request header:
Header Parameter
Required
Type
Description
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":"192.0.2.0","interfaceIPv4CIDR":"172.16.0.1/32","interfaceIPv6CIDR":"2001:0db8:85a3::/128","connections": [ {"datacenterId":"5a029f4a-72e5-11ec-90d6-0242ac120003","lanId":"2","ipv4CIDR":"192.168.1.100/24","ipv6CIDR":"2001:0db8:85a3::/24" } ],"listenPort":51820 }}
Result: The WireGuard Gateway and its details for the specified gatewayId are successfully obtained.
gatewayId
string
The ID (UUID) of the WireGuard Gateway.
85c79b4b-5b40-570a-b788-58dd46ea71e2
Authorization
yes
string
The Bearer token to enable requests to authenticate using a JSON Web Token (JWT).