Retrieve all IPSec Gateways

-Operations to create and manage IPSec VPN Gateways. -This tag groups all operations for ipsecgateways.

To retrieve all the IPSec Gateways, perform a GET request.

Endpoint

Use the following endpoint to retrieve all IPSec Gateways: https://vpn.de-fra.ionos.com/ipsecgateways.

Request

curl --location \
--request GET 'https://vpn.de-fra.ionos.com/ipsecgateways?limit=100&offset=0' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO'

Path Parameters

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

Request Header Parameters

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": "26a73a96-96e9-51d2-98d2-90043b958618",
  "type": "collection",
  "href": "/ipsecgateways",
  "items": [
    {
      "id": "66a114c7-2ddd-5119-9ddf-5a789f5a5a44",
      "type": "ipsecgateway",
      "href": "/ipsecgateways/66a114c7-2ddd-5119-9ddf-5a789f5a5a44",
      "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",
        "description": "This gateway connects site A to VDC X.",
        "gatewayIP": "81.173.1.2",
        "connections": [
          {
            "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
            "lanId": "2",
            "ipv4CIDR": "192.168.1.100/24",
            "ipv6CIDR": "2001:0db8:85a3::/24"
          }
        ],
        "version": "IKEv2"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Result: All existing IPSec Gateways and their details are successfully obtained.