Read saved alert rule configuration
GET
cookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthAuthorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.
application/json- response
items*array<>channels*array<>The project's configured channels, each with its latest delivery. A kind not listed is not configured.
emailAvailable*booleanWhether this server sends email (VOICEGATEWAY_SMTP_URL is set). Without it the email channel cannot be configured.
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/alert-setup'Example Response
{ "items": [ { "ruleId": "slow-answer", "on": true, "to": [ "slack" ] } ], "channels": [ { "kind": "email", "target": "string", "recipients": [ "string" ], "broken": true, "updatedAt": "2019-08-24T14:15:22Z", "lastDelivery": { "id": "string", "channel": "email", "change": "firing", "state": "pending", "attempts": 0, "nextAttemptAt": "2019-08-24T14:15:22Z", "status": "string", "message": "string", "deliveredAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" } } ], "emailAvailable": true}Was this page helpful?