This endpoint enables retrieving all Wireguard Gateways using pagination and optional filters.
curl --location \
--request GET 'https://vpn.de-fra.ionos.com/wireguardgateways?limit=100&offset=0' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO'
Below is the list of optional Path Parameters:
Query Parameters | Type | Description | Example |
---|
| | The first element (of the total list of elements) to include in the response. Use together with limit for pagination. Default: 0 | |
| | The maximum number of elements to return. Use together with offset for pagination. Default: 100 | |
To make authenticated requests to the API, the following fields are mandatory in the request header:
Header Parameters | Required | Type | Description |
---|
| | | The Bearer token enables requests to authenticate using a JSON Web Token (JWT). |
| | | Set this to application/json . |
{
"id": "55871672-381f-589c-8809-4ffbecd8b27c",
"type": "collection",
"href": "/wireguardgateways",
"items": [
{
"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/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
}
}
],
"offset": 0,
"limit": 42,
"_links": {
"prev": "http://PREVIOUS-PAGE-URI",
"self": "http://THIS-PAGE-URI",
"next": "http://NEXT-PAGE-URI"
}
}