/servers/{id} (GET)

GET

/servers/{id}

curl --request GET \
  --url https://example.com/api/v1/servers/example

Parameters

Path Parameters

id

required

string

Responses

200

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

Example

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

404

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}