Cloady Docs
API ReferenceEndpointsApplications

Change an alert rule

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.

PATCH
/api/workspaces/{workspaceSlug}/apps/{appSlug}/alerts/{alertId}

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
alertId*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The metric and the service stay as created; delete the rule and create another to change them

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/workspaces/string/apps/string/alerts/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  }}

Create an alert rule POST

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.

Delete an alert rule DELETE

Past incidents stay in the history.