Turn an alert rule on or off and choose where it sends
PUT
consoleSessioncookie
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 <= lengthruleId*stringOne of the seven alert rules; any other value is not_found.
Value in
"slow-answer""cut-off""job-failed""slow-join""plain-phone""recording-lost""ingress-error"application/json- body
on*booleanWhether the rule sends. Off still opens incidents.
to*array<>Channel kinds the rule sends to.
The rule as saved.
application/json- response
ruleId*stringIdentifier of an existing console rule.
Value in
"slow-answer""cut-off""job-failed""slow-join""plain-phone""recording-lost""ingress-error"on*booleanWhether the rule sends; true when never saved. A rule that is off still opens incidents.
to*array<>Channel kinds the rule sends to. No webhook URLs or credentials.
Example Request
curl -X PUT 'https://example.com/api/v1/org/string/project/string/alert-rules/slow-answer' \ -H 'Content-Type: application/json' \ -d '{ "on": true, "to": [ "email" ]}'Example Response
{ "ruleId": "slow-answer", "on": true, "to": [ "slack" ]}Was this page helpful?