Create an alert rule
p95 and errors exist only for the service the app's address routes to. A rule that fires emails members who keep incident emails on (when `email`), posts to its channels, and with `statusPage` puts the app on the workspace's status page. Answers 400 `bad_rule` when the rule does not fit the metric.
Authorization
cloady Personal API token (cldy_…)
In: header
Path Parameters
Query Parameters
Value in
- "production"
- "preview"
- "development"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/workspaces/string/apps/string/alerts" \ -H "Content-Type: application/json" \ -d '{ "metric": "p95" }'{ "alert": { "id": "string", "service": "string", "metric": "p95", "comparison": ">", "threshold": 0, "window": "2m", "for": "1m", "email": true, "channels": [ "string" ], "statusPage": true, "enabled": true, "state": "ok", "open": [ { "service": "string", "state": "pending", "since": "string", "value": 0 } ], "lastFiredAt": "string", "evaluatedAt": "string", "sentence": "string", "query": "string", "createdAt": "string" }}List an app's alert rules GET
Returns the app's alert rules with their state, the services they are firing on and when each last fired. Rules live in the app's own alerting tenant, evaluated once a minute. A production app gets two default rules the first time its alerts are read: down for 2 minutes, and more than 3 restarts within 15 minutes, both emailing members. With `service`, only rules that watch that compose service, and state for it alone.
Change an alert rule PATCH
Changes the threshold, durations, notifications or the on/off switch. Turning a rule off silences it, so it stops notifying and leaves the status page.