ACacronis

GET /types/{id}

Fetch registered alert type 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 type.

Response

Alert type was successfully fetched.

idstring required
enabledboolean required

Alerts of disabled types are treated as non-existent for any GET request until type is enabled again.

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

Alert severity level.

contextKeysstring[] required

Deprecated. A list of context keys that are used for validation of completeness and correctness of alert context object.

searchableDetailsstring[] required

A list of keys by which the alert type could be found and filtered.

supportedOSOSType[] required

A list of operating systems that are supported by the alert type.

notificationTypestring

If specified, a notification of the specified type will be triggered on alert creation.

notificationExtraRecipientsNotificationRecipient[]

A list of additional notification targets that will receive notifications for alerts of this type. By default notification is sent to the alert's tenant and its children.

categorystring required

Alert type category.

cti_namestring

A cti-name used as an event subject type while sending events to event manager.

aliasstring

Alert type name alias.

Example response

{
  "id": "BackupFailed",
  "severity": "critical",
  "enabled": true,
  "contextKeys": [
    "planId",
    "resourceId"
  ],
  "searchableDetails": [
    "planName",
    "resourceName"
  ],
  "exportable": [
    {
      "name": "planId",
      "acep_name": "plan_id"
    },
    {
      "name": "resourceId",
      "acep_name": "resource_id"
    },
    {
      "name": "errorMessage",
      "acep_name": "error_reason",
      "acep_path": "reason"
    },
    {
      "name": "planName",
      "acep_name": "plan_name"
    },
    {
      "name": "taskType",
      "acep_name": "task_type"
    }
  ],
  "supportedOS": [
    "ios",
    "linux",
    "macos",
    "windows"
  ],
  "category": "Backup",
  "cti_name": "cti.a.p.am.alerts.v1.0~a.backup.failed.v1.0"
}

Changes

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