Management APIs / Clusters

Get a cluster monitor

GEThttps://api.spice.ai/v1/clusters/{clusterId}/monitors/{alertId}

Returns a live cluster monitor. Requires monitors:read and organization membership.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • clusterIdstringRequired

  • alertIdstring (uuid)Required

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200Monitor

400Invalid monitor ID

401Unauthorized

403Insufficient scope or role

404Cluster or monitor not found

500Internal server error

curl "https://api.spice.ai/v1/clusters/<clusterId>/monitors/<alertId>" \
  -H "Authorization: Bearer <token>"

No response body

GEThttps://api.spice.ai/v1/orgs/{orgId}/clusters/{clusterId}/monitors/{alertId}

The org is orgId in the path. Returns a live cluster monitor. Requires monitors:read and organization membership.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • orgIdintegerRequired

    The org id from GET /v1/orgs

    • Minimum: 1

  • clusterIdstringRequired

  • alertIdstring (uuid)Required

Header parameters

  • X-Org-Namestring

    When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org_path_mismatch (400).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200Monitor

400Bad Request

Invalid monitor ID. orgId is not a valid org id (invalid_org_id), or X-Org-Name does not name that org (org_path_mismatch).

401Unauthorized

403Forbidden

Insufficient scope or role. The caller is not a member of the org (org_forbidden). A machine credential named a different org (org_assertion_mismatch). The org is deleted (org_deleted).

404Cluster or monitor not found

500Internal server error

OpenAPIapi.spice.ai/openapi.json

curl "https://api.spice.ai/v1/orgs/<orgId>/clusters/<clusterId>/monitors/<alertId>" \
  -H "Authorization: Bearer <token>"

No response body