Update WireGuard server peer

PUT

/network/wireguard/server/peer/{peerId}

curl --request PUT \
  --url https://sylve.lan:8181/api/network/wireguard/server/peer/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "clientIPs": [ "example" ], "enabled": true, "name": "example", "persistentKeepalive": true, "preSharedKey": "example", "privateKey": "example", "routableIPs": [ "example" ], "routeIPs": true }'

Replace the configurable settings for a WireGuard server peer and apply the updated runtime configuration

Authorizations

• BearerAuth

Parameters

Path Parameters

peerId

required

integer

>= 1

WireGuard Server Peer ID

Request Body

WireGuard Server Peer Request

Media typeapplication/json

object

clientIPs

required

Array<string>

>= 1 items <= 256 items

enabled

boolean

name

required

string

<= 128 characters

persistentKeepalive

boolean

preSharedKey

string

privateKey

string

routableIPs

Array<string>

<= 256 items

routeIPs

boolean

Example^generated

{
  "clientIPs": [
    "example"
  ],
  "enabled": true,
  "name": "example",
  "persistentKeepalive": true,
  "preSharedKey": "example",
  "privateKey": "example",
  "routableIPs": [
    "example"
  ],
  "routeIPs": true
}

Responses

200

Success

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Payload Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}