v1

latestOpenAPI 3.0.1CC BY-NC-SA 3.0 US2026-07-145251,1312.6 MB
Alerts

Return All Alerts from One Project

Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set.

This resource remains under revision and may change.

get/api/atlas/v2/groups/{groupId}/alerts

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCountboolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPageinteger

Number of items that the response returns per page.

pageNuminteger

Number of the page that displays the current set of the total objects that the response returns.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

status'OPEN' | 'TRACKING' | 'CLOSED'

Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.

Response

OK