Initialize WireGuard server

POST

/network/wireguard/server

curl --request POST \
  --url https://sylve.lan:8181/api/network/wireguard/server \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "addresses": [ "example" ], "allowWireGuardPort": true, "masqueradeIPv4Interface": "example", "masqueradeIPv6Interface": "example", "mtu": 1, "port": 1, "privateKey": "example" }'

Create and start the singleton WireGuard server

Authorizations

• BearerAuth

Request Body

WireGuard Server Request

Media typeapplication/json

object

addresses

Array<string>

allowWireGuardPort

boolean

masqueradeIPv4Interface

string

masqueradeIPv6Interface

string

mtu

integer

>= 576 <= 9000

port

required

integer

>= 1 <= 65535

privateKey

string

Example^generated

{
  "addresses": [
    "example"
  ],
  "allowWireGuardPort": true,
  "masqueradeIPv4Interface": "example",
  "masqueradeIPv6Interface": "example",
  "mtu": 1,
  "port": 1,
  "privateKey": "example"
}

Responses

201

Created

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"
}

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"
}