/servers (POST)

POST

/servers

curl --request POST \
  --url https://example.com/api/v1/servers \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "host": "example", "sshPort": 1, "sshUser": "example" }'

Request Body ^required

Media type application/json

object

name

required

string

>= 1 characters <= 100 characters

host

required

string

>= 1 characters

sshPort

integer

>= 1 <= 65535

sshUser

string

Example ^generated

{
  "name": "example",
  "host": "example",
  "sshPort": 1,
  "sshUser": "example"
}

Responses

201

Default Response

Media type application/json

object

id

required

string

organizationId

required

string

name

required

string

host

required

string

sshPort

required

integer

role

required

Any of:

string

string

Allowed values: control

string

string

Allowed values: worker

status

required

Any of:

string

string

Allowed values: adding

string

string

Allowed values: bootstrapping

string

string

Allowed values: ready

string

string

Allowed values: error

string

string

Allowed values: unreachable

dockerOk

required

boolean

caddyOk

required

boolean

createdAt

required

string format: date-time

publicKey

required

string

Example

{
  "role": "control",
  "status": "adding"
}