SPspice
Clusters

Create a cluster monitor

Creates and provisions a cluster monitor. Requires monitors:write and organization admin privileges.

post/v1/clusters/{clusterId}/monitors

Request

  • Base URL
    https://api.spice.ai
  • Auth
    HTTP bearer

Path parameters

clusterIdstring required

Headers

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).

Request body

namestring required
descriptionstring
templateId'cluster_cpu' | 'cluster_memory' | 'cluster_availability' required
recipientUserIdsinteger[]

Response

Monitor created

Changes

No recorded changes to this operation across all 1 revision of this API.