Cloady Docs
API ReferenceEndpointsApplications

Read an app's CPU, memory, disk and network usage

Returns one metrics reading; `network` and `requestsPerSec` are null until a second sample exists, so they are null on a one-shot read. Sending `Accept: text/event-stream` instead follows usage live, a frame every five seconds, which never completes on its own.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/metrics

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/metrics"
{  "ts": 0,  "cpu": {    "used": 0  },  "memory": {    "used": 0  },  "components": {    "property1": {      "cpu": 0,      "memory": 0    },    "property2": {      "cpu": 0,      "memory": 0    }  },  "disk": {    "used": 0,    "capacity": 0  },  "network": {    "rxBytesPerSec": 0,    "txBytesPerSec": 0  },  "requestsPerSec": 0}

Read an app's live status: per-service state, capacity waits, in-flight deploy GET

Returns one status frame. Sending `Accept: text/event-stream` instead follows the status live, a frame every five seconds, which never completes on its own.

Read a container's recent logs GET

Returns the last 200 log lines of one container as `{container, state, logs}`; `state` is `no-pod` when nothing is running. `serviceName` is a compose service. Sending `Accept: text/event-stream` instead follows the log live as server-sent events, one bare `data:` frame per line, which never completes on its own.