servers.list

GET

/servers

const url = 'https://example.com/api/servers';
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/servers

Responses

200

application/json

object

items

required

Array<object>

object

required

string

name

required

string

host

required

string

port

required

number

providerKey

required

string

lifecycleStatus

required

string

Allowed values: active inactive

deactivatedAt

string

deactivationReason

string

edgeProxy

object

kind

required

string

Allowed values: none traefik caddy

status

required

string

Allowed values: pending starting ready failed disabled

lastAttemptAt

string

lastSucceededAt

string

lastErrorCode

string

lastErrorMessage

string

credential

object

kind

required

string

Allowed values: local-ssh-agent ssh-private-key

credentialId

string

credentialName

string

username

string

publicKeyConfigured

required

boolean

privateKeyConfigured

required

boolean

createdAt

required

string

Example

{
  "items": [
    {
      "lifecycleStatus": "active",
      "edgeProxy": {
        "kind": "none",
        "status": "pending"
      },
      "credential": {
        "kind": "local-ssh-agent"
      }
    }
  ]
}