--- title: "GET /alerts" method: GET path: "/alerts" --- # GET /alerts `GET /alerts` ## Request - Base URL: `https://dev-cloud.acronis.com/api/alert_manager/v1` - URL: `https://dev-cloud.acronis.com/api/alert_manager/v1/alerts` - Auth: OAuth 2 - Authorization code: `https://dev-cloud.acronis.com/api/2/idp/authorize` - Client credentials - Password - Token URL: `https://dev-cloud.acronis.com/api/2/idp/token` scopes: `urn:acronis.com::alert_manager::viewer` Fetches all alerts by optional filtering parameters. ## Query parameters - `limit` integer: A limit on number of objects to be returned. - `skip` Uuid[]: IDs of the alerts to exclude from the response. - `deleted_at` string: A filter by date when the alert was dismissed. Must be a Unix timestamp in nanoseconds. Available operators: * `eq` - equals * `lt` - less than * `gt` - greater than * `le` - less than or equals * `ge` - greater than or equals - `id` Uuid[]: Case-insensitive IDs of the alerts to return in the results. - `query` string: A text to search for within `planName` or `resourceName` fields of the alerts. The search is case-insensitive. - `severity` 'ok' | 'information' | 'warning' | 'error' | 'critical': A filter by the alert severity. Available operators: * `eq` - equals to the specified value: eq(warning) * `or` - equals to one of the specified values: or(warning,critical) * `lt` - less than the specified value: lt(warning) * `gt` - greater than the specified value: gt(warning) * `le` - less than or equals to the specified value: le(warning) * `ge` - greater than or equals to the specified value: ge(warning) - `show_deleted` boolean: If true, dismissed alerts will be included in the response. - `show_deleted_only` boolean: If true, only dismissed alerts will be included in the response. - `source` string: A filter by the alert producer. - `source_time_stamp` string: A filter by timestamp that was provided by an alert producer. The timestamp may be an arbitrary integer value. Available operators: * `eq` - equals * `lt` - less than * `gt` - greater than * `le` - less than or equals * `ge` - greater than or equals - `type` string[]: A filter by list of alert types. A list of registered types can be obtained by sending a GET request to the `/types` endpoint. - `updated_at` string: A filter by date when the alert was created or dismissed. Must be a Unix timestamp in nanoseconds. Available operators: * `eq` - equals * `lt` - less than * `gt` - greater than * `le` - less than or equals * `ge` - greater than or equals - `created_at` string: A filter by date when the alert was created. Must be a Unix timestamp in nanoseconds. Available operators: * `eq` - equals * `lt` - less than * `gt` - greater than * `le` - less than or equals * `ge` - greater than or equals - `category` string[]: A filter by list of alert categories. A list of registered categories can be obtained by sending a GET request to the `/categories` endpoint. * Example: `category=Backup&category=Monitoring` - `planId` string[]: Case-insensitive filter for alerts with the specified plan IDs. The following rules are applied: * planId=BackupPlan01 - matches the exact `BackupPlan01` string in the corresponding parameter * planId=or(BackupPlan01,BackupPlan02) - matches the exact `BackupPlan01` or `BackupPlan02` strings in the corresponding parameter Examples: `planId=A1111&planId=B2222` `planId=or(A1111,B2222)` - `resourceId` string[]: Case-insensitive filter for alerts with the specified resource IDs. The following rules are applied: * resourceId=FileResource01 - matches the exact `FileResource01` string in the corresponding parameter * resourceId=or(FileResource01,FileResource02) - matches the exact `FileResource01` or `FileResource02` strings in the corresponding parameter Examples: `resourceId=A1111&resourceId=B2222` `resourceId=or(A1111,B2222)` - `planName` string[]: Case-insensitive filter for alerts with the specified plan names. The following rules are applied: * planName=Plan01 - matches the substring `Plan01` in the corresponding parameter * planName=eq(BackupPlan01) - matches the exact `BackupPlan01` string in the corresponding parameter * planName=or(BackupPlan01,BackupPlan02) - matches the exact `BackupPlan01` or `BackupPlan02` strings in the corresponding parameter Examples: `planName=Plan1&planName=eq(BackupPlan2)` `planName=Plan1&planName=or(BackupPlan2,BackupPlan3)` - `resourceName` string[]: Case-insensitive filter for alerts with the specified resource names. The following rules are applied: * resourceName=Resource01 - matches the substring `Resource01` in the corresponding parameter * resourceName=eq(FileResource01) - matches the exact `FileResource01` string in the corresponding parameter * resourceName=or(FileResource01,FileResource02) - matches the exact `FileResource01` or `FileResource02` strings in the corresponding parameter Examples: `resourceName=Resource1&resourceName=eq(FileResource2)` `resourceName=Resource1&resourceName=or(FileResource2,FileResource3)` - `tenant` string[]: A filter by the alert tenant ID. - `order` string: An ordering filter that orders the results by parameter value. If no operator provided, the results will be ordered in ascending order. Following parameters can be used: * `created_at` * `type` * `severity` * `source` * `source_time_stamp` * `updated_at` * `deleted_at` * `category` * `planId` * `planName` * `resourceId` * `resourceName` Available operators: * `asc` - ascending * `desc` - descending ## Response `200` List of alerts. - object - `items` AlertView[], required - `id` string, required - `type` string, required - `severity` 'ok' | 'information' | 'warning' | 'error' | 'critical', required: Alert severity level. - `affinity` string: Alert synchronization affinity (e.g., agent ID). - `createdAt` string, required: A client-side date and time when alert was created. Equals to the `receivedAt` field if not set by client. - `deletedAt` string: A date and time when the alert was dismissed. - `details` object, required: Copy of context is merged to details. Null if details and context are empty. - `receivedAt` string, required: A server-side date and time when the alert was received. - `_source` string: An identifier of the alert producer. - `_sourceTimeStamp` integer - `tenant` object, required - `id` string, required: An identifier of the alert owner. - `locator` string, required: Ascending hierarchy of tenant IDs separated by '/'. - `updatedAt` string, required: A date and time when the alert has been activated, deleted or dismissed. - `category` string, required: Alert category. - `falsePositive` boolean: Specifies whether alert is false positive or not. - `paging` Paging: Paging format. - `cursors` Cursors, required: Cursors before and after the current page. - `before` string: Specific location in some collection. - `after` string: Specific location in some collection. ## Other responses - `401`: Request is refused because authentication parameters are invalid. - `403`: A security error due to an issue with tenant security claim: invalid tenant in the access token, tenant resolution failed and etc. --- [API](https://skmtc.dev/acronis/apis/alert-manager-api.md) - [All operations](https://skmtc.dev/acronis/apis/alert-manager-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acronis/apis/alert-manager-api/revisions/540eec169663?raw)