Creates a new Wireguard Peer.
The full Wireguard Peer needs to be provided to create the object. Optional data will be filled with defaults or left empty.
To create a Wireguard Peer, perform a POST
request.
Use the following endpoint to create Wireguard Peer: https://vpn.de-fra.ionos.com/wireguardgateways/{gatewayId}/peers
.
Below is the list of mandatory body parameters for creating a Wireguard Peer:
You can update the gatewayId
value to get a specific WireGuard Gateway:
To make authenticated requests to the API, the following fields are mandatory in the request header:
201 Successful operation
Result: The Wireguard Peer is successfully created. the id
and other details of the created Wireguard Peer are provided in the response.
Body Parameters | Required | Type | Description | Example |
---|---|---|---|---|
Path Parameter | Type | Description | Example |
---|---|---|---|
Header Parameters | Required | Type | Description |
---|---|---|---|
metadata
no
object
Metadata related to the WireGuard peer.
{}
properties
yes
object
Properties with all data needed to create a new WireGuard peer. Note: There is a limit of 20 peers per gateway.
properties.name
yes
string
The human-readable name of the WireGuard peer.
My Company Gateway Peer
properties.description
no
string
Human-readable description of the WireGuard peer.
Allows local machine A to connect to Datacenter LAN Y.
properties.endpoint
yes
object
Properties needed to define the WireGuard endpoint.
properties.endpoint.host
yes
string
Hostname or IPV4 address that the WireGuard Server will connect to.
1.2.3.4
properties.endpoint.port
yes
integer
Port that the WireGuard Server will connect to.
51820
properties.allowedIPs
yes
array
The subnet CIDRs that are allowed to connect to the WireGuard Gateway. Specify "a.b.c.d/32" for an individual IP address. Specify "0.0.0.0/0" or "::/0" for all addresses.
["1.2.3.4/32"]
properties.publicKey
yes
string
The public key for the WireGuard peer.
no8iaSEoqfbI6PVYsdEiUU5efYdtKX8VAhKity19MWI=
gatewayId
string
The ID (UUID) of the WireGuard Gateway.
85c79b4b-5b40-570a-b788-58dd46ea71e2
Authorization
yes
string
The Bearer token to enable requests to authenticate using a JSON Web Token (JWT).
Content-Type
yes
string
Set this to application/json
.