cloadyDocs
API ReferenceEndpointsWorkspaces

Read the health of a workspace's services

Returns each service of the workspace's apps in `env` and `region` with its CPU, memory, replicas, restarts, volumes and requests, as Monitor's service picker shows them, read from the platform's own scrape. It answers on every plan.

GET
/api/workspaces/{workspaceSlug}/monitor

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*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/monitor"
{  "services": [    {      "app": "string",      "service": "string",      "cpu": 0,      "cpuLimit": 0,      "memory": 0,      "memoryLimit": 0,      "ready": 0,      "desired": 0,      "restarts": 0,      "waiting": "string",      "up": true,      "diskUsed": 0,      "diskCapacity": 0,      "rps": 0,      "errorRate": 0,      "p95": 0,      "cpuTrend": [        0      ],      "rpsTrend": [        0      ],      "queued": 0    }  ]}

Search GitHub repositories GET

Previous Page

Query metrics across a workspace's apps GET

Runs a PromQL query at one instant across the metrics of every app in the workspace, or only those in `env` and `region`, and returns Prometheus's answer unchanged. Group by `namespace` to tell the apps apart. The labels and series are queryAppMetrics'. A query the store refuses comes back with the store's own status and `error`. The path is the store's own, so a Grafana data source can point here too.