ACacronis

GET /customer_alerts

Fetches alerts of the specified customers. This API uses extended barrier mode by default.

Request

  • Base URL
    https://dev-cloud.acronis.com/api/alert_manager/v1
  • 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

Query parameters

customer_idstring[] required

IDs of the customers whose alerts must be returned.

[
  "14",
  "22"
]
deleted_atstring

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
idUuid[]

Case-insensitive IDs of the alerts to return in the results.

[
  "c106fd7b-338b-4635-8e61-31f6255482d5",
  "f71fdcdb-fc43-4b2f-9830-c53fb213de7b"
]
querystring

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_deletedboolean

If true, dismissed alerts will be included in the response.

show_deleted_onlyboolean

If true, only dismissed alerts will be included in the response.

sourcestring

A filter by the alert producer.

source_time_stampstring

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
typestring[]

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_atstring

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_atstring

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
categorystring[]

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
planIdstring[]

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)

resourceIdstring[]

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)

planNamestring[]

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)

resourceNamestring[]

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)

Response

List of customer alerts grouped per customer.

Example response

{
  "items": [
    {
      "customer_id": "14",
      "alerts": [
        {
          "id": "01C2D69A-112B-4DE1-98AE-8688223C5F4B",
          "type": "BackupFailed",
          "details": {
            "activity": {
              "id": "D028B06E-36D6-43FF-9242-35E8A9917E3A"
            },
            "activityId": "D028B06E-36D6-43FF-9242-35E8A9917E3A"
          },
          "createdAt": "2021-04-05T20:41:41Z",
          "_source": "6852F263-2B5E-48BF-B78B-486182D9BDBE",
          "_sourceTimeStamp": 3246,
          "severity": "critical",
          "receivedAt": "2021-04-01T22:16:19.71025511Z",
          "updatedAt": "2021-04-05T20:41:42.352636392Z",
          "tenant": {
            "id": "56",
            "locator": "/1/3/14/56/"
          },
          "category": "Backup"
        }
      ]
    },
    {
      "customer_id": "22",
      "alerts": [
        {
          "id": "BACA9625-A993-4722-B03F-F2807C85E76F",
          "type": "DrInternetTrafficUnblocked",
          "details": {},
          "createdAt": "2021-04-05T23:41:55.089638934Z",
          "severity": "warning",
          "receivedAt": "2021-04-05T23:41:55.089638324Z",
          "updatedAt": "2021-04-05T23:41:55.089638934Z",
          "tenant": {
            "id": "88",
            "locator": "/1/3/22/88"
          },
          "category": "Disaster recovery"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.