Viewing Alert Rules and Associated Apps with the API
Use the API to view information about alert rules and the apps configured with each rule for your organization. Apps configured with one or more alert rules trigger an alert when they meet the criteria set in the rule for 30 seconds.
To view a list of apps for each alert rule, you need the following:
Subscription Locator — The Subscription Locator of the Organization you want to access. To find Subscription Locators for your organizations use the GET /v1/userinfo
method to return a list of all of the organizations for your OAuth Token with their Subscription Locators. You can use 0 as the Subscription Locator for the organization that owns the OAuth token.
Use the GET /v1/subscriptions/{subscriptionLocator}
method to return each alert rule listed with any associated apps.
To view all apps associated with a single rule, include the optional ruleId
parameter.
To view all rules associated with a single app, include the optional appId
parameter and exclude the ruleId
parameter.
Role Requirements
- Admins can view rules for their organization.
- Users can view rules for their organization.
- Read-only users can view rules for their organization.