Ensure Wireguard Peer
Ensures that the WireGuard Peer with the provided ID is created or modified. Remember to provide the full WireGuard Peer specification to ensure the WireGuard Peer with the respective ID is created or updated. When left empty, they are filled with default values or remain empty; previously provided values are not used for these empty fields.
To ensure that the WireGuard Peer with the provided ID is created or modified, perform PUT
request.
Note: If WireGuard Peer for a given peerId
does not exist, a new one is created instead.
Endpoint
Use a region-specific endpoint to ensure that the WireGuard Peer is created or modified: https://vpn.{region}.ionos.com/wireguardgateways/{gatewayId}/peers/{peerId}
.
Request
Note: The following request contains a sample gatewayId
and peerId
. Replace them with the gatewayId
and peerId
values whose information you want to update.
Below is the list of mandatory path parameters:
Path Parameters | Type | Description | Example |
---|---|---|---|
| string | The ID (UUID) of the WireGuard Gateway. |
|
| string | The ID (UUID) of the WireGuard Peer. |
|
Below is the list of fields returned in the response for a WireGuard Peer:
Response Parameters | Type | Description | Example |
---|---|---|---|
| string | The unique identifier (UUID) for the WireGuard Peer. |
|
| object | Metadata related to the WireGuard Peer. |
|
| object | Properties of the WireGuard Peer. | |
| string | The human-readable name of the WireGuard Peer. |
|
| string | Human-readable description of the WireGuard Peer. |
|
| object | Endpoint details for the WireGuard Peer. | |
| string | The host IP address or domain for the WireGuard Peer. |
|
| integer | The port number for the WireGuard Peer. |
|
| array | The subnet CIDRs that are allowed to connect to the WireGuard Gateway. |
|
| string | The public key for the WireGuard Peer. |
|
To make authenticated requests to the API, the following fields are mandatory in the request header:
Header Parameters | Required | Type | Description |
---|---|---|---|
| yes | string | The Bearer token enables requests to authenticate using a JSON Web Token (JWT). |
| yes | string | Set this to |
Response
200 Successful operation
Following is an example of when a WireGuard Peer is successfully created.
Result: The WireGuard Peer is successfully updated or created.
Last updated