HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

List alert configurations

Retrieves alert configurations for a given scope. Each configuration defines the threshold rules, severity mappings, and settings for a specific alert type. Configurations may be locally defined or inherited from a parent scope.

Scope types:

ValueDescription
GLOBALTenant-level scope (default)
SITESite-level scope
DEVICEDevice-level scope

Pagination:

Use limit and next together to page through large result sets. When limit is supplied the response includes total (total available configurations) and offset (zero-based index of the first item returned), enabling clients to determine whether additional pages exist.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The scope identifier for which alert configurations are retrieved.

string
enum
Defaults to GLOBAL

The scope type. Determines the level at which the configuration applies.

ValueDescription
GLOBALTenant-level scope (default)
SITESite-level scope
DEVICEDevice-level scope
Allowed:
integer
1 to 100
Defaults to 20

Maximum number of alert configurations to return per page. Defaults to 20 when not specified.

integer
≥ 0
Defaults to 0

Zero-based offset of the first alert configuration to return. Use together with limit to paginate through results. Defaults to 0 when not specified.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json