CAcaveman

POST /projects/{projectId}/metric-alerts

POST /api/v1/projects/{projectId}/metric-alerts on the Caveman Cloud control plane. Requires the dashboard:write scope. Exposed to autonomous agents as the create action of the caveman_alerts_write tool (write access). Create, change, pause and delete metric alerts. A firing or resolved alert files an Inbox item and emails the organization's owners and admins, at most once per notify interval; it can also post to a webhook an admin already configured.

post/projects/{projectId}/metric-alerts

Request

  • Base URL
    https://api.caveman.so/api/v1
  • URL
    https://api.caveman.so/api/v1/projects/{projectId}/metric-alerts
  • Auth
    • OAuth 2
      Authorization code: /api/v1/oauth/authorize
      Token URL: /api/v1/oauth/token scopes: dashboard:write
    • or HTTP bearer
    • or API key in cookie cave_access
    • or API key in cookie __Secure-cave_identity.session_token

Request body

namestring required
dashboard_idstring nullable
chart_idstring nullable
comparator'>' | '>=' | '<' | '<=' required
thresholdnumber required
window_minutesinteger required
notify_interval_minutesinteger required
no_data'keep' | 'resolve' | 'trigger'
webhook_idstring uuid nullable
pausedboolean

Response

Successful response. Exact status depends on synchronous or durable delivery outcome.

Changes

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