GET /alerts/{id}

Fetches the information about the alert by ID.

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

Path parameters

idstring required

ID of an alert.

Query parameters

show_deletedboolean

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

Response

Alert has been fetched successfully.

idstring required
typestring required
severity'ok' | 'information' | 'warning' | 'error' | 'critical' required

Alert severity level.

affinitystring

Alert synchronization affinity (e.g., agent ID).

createdAtstring required

A client-side date and time when alert was created. Equals to the receivedAt field if not set by client.

deletedAtstring

A date and time when the alert was dismissed.

detailsobject required

Copy of context is merged to details. Null if details and context are empty.

receivedAtstring required

A server-side date and time when the alert was received.

_sourcestring

An identifier of the alert producer.

_sourceTimeStampinteger
updatedAtstring required

A date and time when the alert has been activated, deleted or dismissed.

categorystring required

Alert category.

falsePositiveboolean

Specifies whether alert is false positive or not.

Example response

{
  "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/50/53/56/"
  },
  "category": "Backup"
}

Changes

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