Skip to content
SYLVE

Create WireGuard client

POST
/network/wireguard/clients
curl --request POST \
  --url https://sylve.lan:8181/api/network/wireguard/clients \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "addresses": [ "example" ], "allowedIPs": [ "example" ], "enabled": true, "endpointHost": "example", "endpointPort": 1, "fib": 1, "listenPort": 1, "metric": 1, "mtu": 1, "name": "example", "peerPublicKey": "example", "persistentKeepalive": true, "preSharedKey": "example", "privateKey": "example", "routeAllowedIPs": true }'

Create and apply an outbound WireGuard client configuration

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

WireGuard Client Request

Media typeapplication/json
object
addresses
required
Array<string>
>= 1 items <= 256 items
allowedIPs
required
Array<string>
>= 1 items <= 256 items
enabled
boolean
endpointHost
required
string
<= 253 characters
endpointPort
required
integer
>= 1 <= 65535
fib
integer
listenPort
integer
<= 65535
metric
integer
mtu
integer
>= 576 <= 9000
name
required
string
<= 128 characters
peerPublicKey
required
string
persistentKeepalive
boolean
preSharedKey
string
privateKey
required
string
routeAllowedIPs
boolean
Examplegenerated
{
  "addresses": [
    "example"
  ],
  "allowedIPs": [
    "example"
  ],
  "enabled": true,
  "endpointHost": "example",
  "endpointPort": 1,
  "fib": 1,
  "listenPort": 1,
  "metric": 1,
  "mtu": 1,
  "name": "example",
  "peerPublicKey": "example",
  "persistentKeepalive": true,
  "preSharedKey": "example",
  "privateKey": "example",
  "routeAllowedIPs": true
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
data
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": 1,
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Payload Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}