Cloady Docs
API ReferenceEndpointsWorkspaces

Get the workspace's status page

Returns the page's address and what it shows: one component per production app with an alert rule that posts to the status page, with 60 days of uptime, and those rules' incidents. Without such a rule the page does not exist.

GET
/api/workspaces/{workspaceSlug}/status

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/status"
{  "page": {    "url": "string",    "public": true,    "preview": {      "title": "string",      "state": "operational",      "components": [        {          "name": "string",          "state": "operational",          "uptime": 0,          "days": [            {              "day": "string",              "up": 0,              "total": 0            }          ]        }      ],      "incidents": [        {          "id": "string",          "component": "string",          "title": "string",          "impact": "down",          "startedAt": "string",          "resolvedAt": "string"        }      ],      "checkedAt": "string"    }  }}

Read a trace GET

Returns the spans the workspace's apps sent in a trace, in tree order, with each span's service, timing, status, first exception and attributes. Spans from outside the workspace are left out. Answers 404 when no span of the trace belongs to the workspace, it was sampled out, or it is older than 7 days.

Preview a public repository or template POST

Read a public GitHub repository, or a template, and preview what it would deploy. Public: no token needed. Answers 429 when GitHub's rate limit, shared by every caller, runs out. Signed in, use inspectSource.