resources.health

GET

/resources/{resourceId}/health

const url = 'https://example.com/api/resources/example/health?mode=cached';
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/resources/example/health?mode=cached'

Reads current resource health. Public docs: /docs/observe/logs-health/#observe-health-summary

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Query Parameters

mode

string

default: cached

Allowed values: cached live

includeChecks

Any of:

boolean

includePublicAccessProbe

Any of:

boolean

includeRuntimeProbe

Any of:

boolean

Responses

200

application/json

object

schemaVersion

required

string

Allowed value: resources.health/v1

resourceId

required

string

generatedAt

required

string

observedAt

string

overall

required

string

Allowed values: healthy degraded unhealthy starting stopped not-deployed unknown

latestDeployment

object

required

string

status

required

string

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

createdAt

required

string

startedAt

string

finishedAt

string

serverId

required

string

destinationId

required

string

lastError

object

timestamp

required

string

phase

required

string

Allowed values: detect plan package deploy verify rollback

message

required

string

runtime

required

object

lifecycle

required

string

Allowed values: not-deployed starting running restarting degraded stopped exited unknown

health

required

string

Allowed values: healthy unhealthy unknown not-configured

observedAt

string

runtimeKind

string

Allowed values: docker-container docker-compose-stack host-process

reasonCode

string

message

string

healthPolicy

required

object

status

required

string

Allowed values: configured not-configured unsupported

enabled

required

boolean

type

string

Allowed values: http command

path

string

port

number

expectedStatusCode

number

intervalSeconds

number

timeoutSeconds

number

retries

number

startPeriodSeconds

number

reasonCode

string

publicAccess

required

object

status

required

string

Allowed values: ready not-ready failed unknown not-configured

url

string

kind

string

Allowed values: durable-domain server-applied-domain generated-latest generated-planned

reasonCode

string

phase

string

proxy

required

object

status

required

string

Allowed values: ready not-ready failed unknown not-configured

providerKey

string

lastRouteRealizationDeploymentId

string

reasonCode

string

checks

required

Array<object>

object

name

required

string

target

required

string

Allowed values: runtime container command public-access proxy-route

status

required

string

Allowed values: passed failed skipped unknown

observedAt

required

string

durationMs

number

statusCode

number

exitCode

number

message

string

reasonCode

string

phase

string

retriable

boolean

metadata

object

key

additional properties

string

sourceErrors

required

Array<object>

object

source

required

string

Allowed values: deployment runtime health-policy health-check proxy public-access domain-binding

code

required

string

category

required

string

phase

required

string

retriable

required

boolean

relatedEntityId

string

relatedState

string

message

string

Example

{
  "schemaVersion": "resources.health/v1",
  "overall": "healthy",
  "latestDeployment": {
    "status": "created",
    "lastError": {
      "phase": "detect"
    }
  },
  "runtime": {
    "lifecycle": "not-deployed",
    "health": "healthy",
    "runtimeKind": "docker-container"
  },
  "healthPolicy": {
    "status": "configured",
    "type": "http"
  },
  "publicAccess": {
    "status": "ready",
    "kind": "durable-domain"
  },
  "proxy": {
    "status": "ready"
  },
  "checks": [
    {
      "target": "runtime",
      "status": "passed"
    }
  ],
  "sourceErrors": [
    {
      "source": "deployment"
    }
  ]
}