/servers (GET)

GET

/servers

const url = 'https://example.com/api/v1/servers?limit=25';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/servers?limit=25'

Parameters

Query Parameters

limit

integer

default: 25 >= 1 <= 100

cursor

string

sort

string

Responses

200

Default Response

application/json

object

data

required

Array<object>

object

required

string

organizationId

required

string

name

required

string

host

required

string

sshPort

required

integer

role

required

Any of:

string
string

string

Allowed values: control

status

required

Any of:

string

Allowed values: adding

dockerOk

required

boolean

caddyOk

required

boolean

createdAt

required

string format: date-time

page

required

object

nextCursor

required

Any of:

string
null

string

hasMore

required

boolean

Example

{
  "data": [
    {
      "role": "control",
      "status": "adding"
    }
  ]
}