Cloady Docs
API ReferenceEndpointsApplications

List an app's alert rules

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.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/alerts

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string

Query Parameters

env?string

Value in

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

Only rules that watch this compose service, with state and history for it alone

Match^[a-z0-9][a-z0-9-]{0,29}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/alerts"
{  "alerts": [    {      "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"    }  ]}

Check a mail service's domains and reputation GET

Finds the domains the service sends from (Postfix's log and myorigin, or Stalwart's own domain list) and checks each in public DNS: SPF evaluated against the address the mail leaves from, DKIM keys for the selectors seen signing, DMARC policy and MX. Also reverse DNS of that address, the certificate offered after STARTTLS, and the address on Spamhaus, Barracuda, SpamCop and UCEPROTECT, and for Stalwart the DMARC aggregate reports it received. The address belongs to the node and is shared by every app on it. Runs the checks on every call.

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.