Create a server

POST/servers

Deploys the server before it answers, which can take a while when the image is new to the machine. A 201 is a running server; a failed deploy leaves nothing behind.

Needs the servers:write scope.

Authorization

apiKey

AuthorizationBearer <token>

An API key: tp_….

In: header

Header Parameters

Idempotency-Key?string

A retry with the same key within 24 hours gets the first reply back (with Idempotent-Replayed: true) instead of running again.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Unique across the panel.

Lengthlength <= 64

node_id?integer

The machine to run on, from GET /nodes; 0, the default, is the panel's own.

address?string

The server's address and subnet, such as 10.20.0.1/22, between /16 and /30. Defaults to a free /24.

max_devices?integer

Instead of address: the smallest free subnet, /24 or larger, that holds this many devices.

Range1 <= value <= 65533

endpoint?string

Host clients dial, without a port. Defaults to the panel's public host, or the node's.

listen_port?integer

UDP; unique per machine. Defaults to the next free one from 51820.

Range1 <= value <= 65535

dns?array<string>

dns_on_server?boolean

Devices ask a caching resolver on the server's tunnel address, which forwards to dns. dns can then change without new client configs; turning this on or off changes the configs. Needs at least one dns entry, and client_allowed_ips that include the server's address.

mtu?integer

1280 to 1500, or 0 for the default.

persistent_keepalive?integer

Range0 <= value <= 65535

client_allowed_ips?array<string>

What clients send through the tunnel; defaults to everything.

country?string

ISO 3166-1 alpha-2. Guessed from the endpoint on create when left out.

city?string

Lengthlength <= 64

Response Body

`application/json`

curl -X POST "https://example.com/servers" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": 0,  "name": "string",  "node": {    "id": 0,    "name": "string"  },  "country": "DE",  "city": "string",  "status": "running",  "endpoint": "string",  "listen_port": 0,  "public_key": "string",  "address": "10.8.0.1/24",  "subnet": "10.8.0.0/24",  "dns": [    "string"  ],  "dns_on_server": true,  "mtu": 0,  "persistent_keepalive": 0,  "client_allowed_ips": [    "string"  ],  "device_count": 0,  "capacity": 0,  "created_at": "2019-08-24T14:15:22Z"}

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

401application/json

403application/json

409application/json

422application/json

429application/json

502application/json

503application/json

Authorization

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`