Retrieve alert rule
GET {{baseUrl}}/alerts/rules/:ruleId?aid=1234
Returns detailed information about an alert rule using the ruleId. If the ruleId doesn’t exist or is inaccessible by your account, an empty response is returned.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
aid | number | A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"alertType":"http-server","expression":"((hops((hopDelay \u003e= 100 ms))))","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"ruleName":"The End of the Internet","ruleId":"127094","direction":"to-target","notifyOnClear":true,"isDefault":true,"minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","includeCoveredPrefixes":true,"sensitivityLevel":"medium","severity":"major","notifications":{"email":{"recipients":["noreply@thousandeyes.com"],"message":"Notification message"},"thirdParty":[{"integrationId":"sl-101","integrationType":"slack"},{"integrationId":"sl-101","integrationType":"slack"}],"webhook":[{"integrationId":"wb-201","integrationType":"webhook"},{"integrationId":"wb-201","integrationType":"webhook"}],"customWebhook":[{"integrationId":"cwb-201","integrationType":"custom-webhook","integrationName":"My webhook","target":"https://example.com/test/webhooks/notifications"},{"integrationId":"cwb-201","integrationType":"custom-webhook","integrationName":"My webhook","target":"https://example.com/test/webhooks/notifications"}]},"tests":[{"interval":60,"alertsEnabled":true,"enabled":true,"alertRules":[{"ruleId":"127094","ruleName":"The End of the Internet","expression":"((hops((hopDelay \u003e= 100 ms))))","direction":"to-target","isDefault":true,"alertType":"http-server","minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"sensitivityLevel":"medium","severity":"major"},{"ruleId":"127094","ruleName":"The End of the Internet","expression":"((hops((hopDelay \u003e= 100 ms))))","direction":"to-target","isDefault":true,"alertType":"http-server","minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"sensitivityLevel":"medium","severity":"major"}]},{"interval":60,"alertsEnabled":true,"enabled":true,"alertRules":[{"ruleId":"127094","ruleName":"The End of the Internet","expression":"((hops((hopDelay \u003e= 100 ms))))","direction":"to-target","isDefault":true,"alertType":"http-server","minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"sensitivityLevel":"medium","severity":"major"},{"ruleId":"127094","ruleName":"The End of the Internet","expression":"((hops((hopDelay \u003e= 100 ms))))","direction":"to-target","isDefault":true,"alertType":"http-server","minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"sensitivityLevel":"medium","severity":"major"}]}],"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"dolore occaecat laboris","deprecation":"irure Lorem sed","name":"exercitation sunt ad laborum dolor","profile":"dolor minim in","title":"ut consectetur et","hreflang":"velit officia"}}}