WireguardGateways

Operations to create and manage WireGuard VPN Gateways.

This tag groups all operations for wireguardgateways.

Retrieve all WireguardGateways

get

/wireguardgateways

This endpoint enables retrieving all WireguardGateways using pagination and optional filters.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Query parameters

offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100

Responses

200

Returned all requested WireguardGateways successfully.

application/json

Pagination information. The offset and limit parameters are used to navigate the list of elements. The _links object contains URLs to navigate the different pages.

idstring · uuidRequired

ID of the list of WireguardGateway resources.

Example: 55871672-381f-589c-8809-4ffbecd8b27c

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of WireguardGateway resources.

Example: /wireguardgateways

offsetintegerRead-onlyRequired

The offset specified in the request (if none was specified, the default offset is 0).

Example: 0

limitintegerRead-onlyRequired

The limit specified in the request (if none was specified, use the endpoint's default pagination limit).

Example: 42

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/wireguardgateways

GET /wireguardgateways HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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/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"
        }
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create WireguardGateway

post

/wireguardgateways

Creates a new WireguardGateway.

The full WireguardGateway needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Body

metadataanyOptional

Metadata

Responses

201

WireguardGateway successfully created.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

post

/wireguardgateways

POST /wireguardgateways HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "metadata": {},
  "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"
      }
    ],
    "privateKey": "0HpE4BNwGHabeaC4aY/GFxB6fBSc0d49Db0qAzRVSVc=",
    "listenPort": 51820,
    "tier": "STANDARD",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    }
  }
}

{
  "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"
    }
  }
}

Retrieve WireguardGateway

get

/wireguardgateways/{gatewayId}

Returns the WireguardGateway by ID.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

Responses

200

Getting WireguardGateway was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the WireguardGateway.

Example: /wireguardgateways/85c79b4b-5b40-570a-b788-58dd46ea71e2

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/wireguardgateways/{gatewayId}

GET /wireguardgateways/{gatewayId} HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
    }
  }
}

Ensure WireguardGateway

put

/wireguardgateways/{gatewayId}

Ensures that the WireguardGateway with the provided ID is created or modified. The full WireguardGateway needs to be provided to ensure (either update or create) the WireguardGateway. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

Body

idstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

metadataanyOptional

Metadata

Responses

200

WireguardGateway successfully updated.

application/json

idstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the WireguardGateway.

Example: /wireguardgateways/85c79b4b-5b40-570a-b788-58dd46ea71e2

201

WireguardGateway successfully ensured.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

409

Conflict

The UUID is already taken by another party, follow the guides to generate UUIDs uniquely.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

put

/wireguardgateways/{gatewayId}

PUT /wireguardgateways/{gatewayId} HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 579

{
  "id": "85c79b4b-5b40-570a-b788-58dd46ea71e2",
  "metadata": {},
  "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"
      }
    ],
    "privateKey": "0HpE4BNwGHabeaC4aY/GFxB6fBSc0d49Db0qAzRVSVc=",
    "listenPort": 51820,
    "tier": "STANDARD",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    }
  }
}

{
  "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"
    }
  }
}

Delete WireguardGateway

delete

/wireguardgateways/{gatewayId}

Deletes the specified WireguardGateway.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

Responses

202

Deleting WireguardGateway was successful.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

delete

/wireguardgateways/{gatewayId}

DELETE /wireguardgateways/{gatewayId} HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousVPN Gateway NextWireguardPeers

Last updated 2 months ago

Was this helpful?

Good evening

hashtagRetrieve all WireguardGateways

Bad Request

Unauthorized

Not Allowed

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagCreate WireguardGateway

Bad Request

Unauthorized

Not Allowed

Unsupported Media Type

Unprocessable Entity

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagRetrieve WireguardGateway

Bad Request

Unauthorized

Not Allowed

Not Found

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagEnsure WireguardGateway

Bad Request

Unauthorized

Not Allowed

Not Found

Conflict

Unsupported Media Type

Unprocessable Entity

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagDelete WireguardGateway

Bad Request

Unauthorized

Not Allowed

Not Found

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

Retrieve all WireguardGateways

Create WireguardGateway

Retrieve WireguardGateway

Ensure WireguardGateway

Delete WireguardGateway