AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

WireguardPeers

Operations to create and manage WireGuard VPN Gateway peers.

This tag groups all operations for wireguardpeers.

Retrieve all WireguardPeers

get

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

Authorizations
Path parameters
gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

Example: 85c79b4b-5b40-570a-b788-58dd46ea71e2
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 WireguardPeers successfully.
application/json
Responseall of
and
get
GET /wireguardgateways/{gatewayId}/peers HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "7c33f158-b93c-5fe7-83c6-84dde2357a33",
  "type": "collection",
  "href": "/wireguardgateways/{gatewayId}/peers",
  "items": [
    {
      "id": "b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
      "type": "wireguardpeer",
      "href": "/wireguardgateways/{gatewayId}/peers/b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
      "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 Peer",
        "description": "Allows local machine A to connect to Datacenter LAN Y.",
        "endpoint": {
          "host": "1.2.3.4",
          "port": 51820
        },
        "allowedIPs": [
          "1.2.3.4/32"
        ],
        "publicKey": "no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI="
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create WireguardPeer

post

Creates a new WireguardPeer.

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

Authorizations
Path parameters
gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

Metadata

Responses
201
WireguardPeer successfully created.
application/json
post
POST /wireguardgateways/{gatewayId}/peers HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "metadata": {},
  "properties": {
    "name": "My Company Gateway Peer",
    "description": "Allows local machine A to connect to Datacenter LAN Y.",
    "endpoint": {
      "host": "1.2.3.4",
      "port": 51820
    },
    "allowedIPs": [
      "1.2.3.4/32"
    ],
    "publicKey": "no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI="
  }
}
{
  "id": "b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "type": "wireguardpeer",
  "href": "/wireguardgateways/{gatewayId}/peers/b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "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 Peer",
    "description": "Allows local machine A to connect to Datacenter LAN Y.",
    "endpoint": {
      "host": "1.2.3.4",
      "port": 51820
    },
    "allowedIPs": [
      "1.2.3.4/32"
    ],
    "publicKey": "no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI="
  }
}

Retrieve WireguardPeer

get

Returns the WireguardPeer by ID.

Authorizations
Path parameters
gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

The ID (UUID) of the WireguardPeer.

Example: b62b3a40-adee-5b6c-b98d-be20bfcbdd91
Responses
200
Getting WireguardPeer was successful.
application/json
get
GET /wireguardgateways/{gatewayId}/peers/{peerId} HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "type": "wireguardpeer",
  "href": "/wireguardgateways/{gatewayId}/peers/b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "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 Peer",
    "description": "Allows local machine A to connect to Datacenter LAN Y.",
    "endpoint": {
      "host": "1.2.3.4",
      "port": 51820
    },
    "allowedIPs": [
      "1.2.3.4/32"
    ],
    "publicKey": "no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI="
  }
}

Ensure WireguardPeer

put

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

Authorizations
Path parameters
gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

The ID (UUID) of the WireguardPeer.

Example: b62b3a40-adee-5b6c-b98d-be20bfcbdd91
Body
idstring · uuidRequired

The ID (UUID) of the WireguardPeer.

Example: b62b3a40-adee-5b6c-b98d-be20bfcbdd91
metadataanyOptional

Metadata

Responses
200
WireguardPeer successfully updated.
application/json
put
PUT /wireguardgateways/{gatewayId}/peers/{peerId} HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "id": "b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "metadata": {},
  "properties": {
    "name": "My Company Gateway Peer",
    "description": "Allows local machine A to connect to Datacenter LAN Y.",
    "endpoint": {
      "host": "1.2.3.4",
      "port": 51820
    },
    "allowedIPs": [
      "1.2.3.4/32"
    ],
    "publicKey": "no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI="
  }
}
{
  "id": "b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "type": "wireguardpeer",
  "href": "/wireguardgateways/{gatewayId}/peers/b62b3a40-adee-5b6c-b98d-be20bfcbdd91",
  "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 Peer",
    "description": "Allows local machine A to connect to Datacenter LAN Y.",
    "endpoint": {
      "host": "1.2.3.4",
      "port": 51820
    },
    "allowedIPs": [
      "1.2.3.4/32"
    ],
    "publicKey": "no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI="
  }
}

Delete WireguardPeer

delete

Deletes the specified WireguardPeer.

Authorizations
Path parameters
gatewayIdstring · uuidRequired

The ID (UUID) of the WireguardGateway.

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

The ID (UUID) of the WireguardPeer.

Example: b62b3a40-adee-5b6c-b98d-be20bfcbdd91
Responses
202
Deleting WireguardPeer was successful.
delete
DELETE /wireguardgateways/{gatewayId}/peers/{peerId} HTTP/1.1
Host: vpn.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

No content
PreviousWireguardGatewaysNextIPSecGateways

Was this helpful?