servers.show

GET

/servers/{serverId}

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

Reads one deployment target with proxy status and usage rollups. Public docs: /docs/servers/register-connect/#server-deployment-target

Parameters

Path Parameters

serverId

required

string

>= 1 characters

Query Parameters

includeRollups

Any of:

boolean

Responses

200

application/json

object

schemaVersion

required

string

Allowed value: servers.show/v1

server

required

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

rollups

object

resources

required

object

total

required

number

deployedResourceIds

required

Array<string>

deployments

required

object

total

required

number

statusCounts

required

Array<object>

object

status

required

string

Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back

count

required

number

latestDeploymentId

string

latestDeploymentStatus

string

Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back

domains

required

object

total

required

number

statusCounts

required

Array<object>

object

status

required

string

Allowed values: requested pending_verification bound certificate_pending ready not_ready failed

count

required

number

latestDomainBindingId

string

latestDomainBindingStatus

string

Allowed values: requested pending_verification bound certificate_pending ready not_ready failed

generatedAt

required

string

Example

{
  "schemaVersion": "servers.show/v1",
  "server": {
    "lifecycleStatus": "active",
    "edgeProxy": {
      "kind": "none",
      "status": "pending"
    },
    "credential": {
      "kind": "local-ssh-agent"
    }
  },
  "rollups": {
    "deployments": {
      "statusCounts": [
        {
          "status": "created"
        }
      ],
      "latestDeploymentStatus": "created"
    },
    "domains": {
      "statusCounts": [
        {
          "status": "requested"
        }
      ],
      "latestDomainBindingStatus": "requested"
    }
  }
}