GET /types

Fetches all registered alert types.

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

categorystring[]

A filter by list of type categories. A list of registered categories can be obtained by sending a GET request to the /categories endpoint.

  • Example: category=Backup&category=Monitoring
os_typeOSType[] required

A filter by the list of operating systems supported by the alert types.

orderstring

An ordering filter that orders the results by column name. If no operator provided, the column will be ordered in ascending order.

Following columns can be used:

  • id
  • severity
  • category

Available operators:

  • asc - ascending
  • desc - descending

Response

A list of registered alerts types.

Example response

{
  "items": [
    {
      "id": "BackupFailed",
      "severity": "critical",
      "enabled": true,
      "contextKeys": [
        "planId",
        "resourceId"
      ],
      "searchableDetails": [
        "planName",
        "resourceName"
      ],
      "supportedOS": [
        "ios",
        "linux",
        "macos",
        "windows"
      ],
      "category": "Backup",
      "cti_name": "cti.a.p.am.alerts.v1.0~a.backup.failed.v1.0"
    },
    {
      "id": "cti.a.p.am.alert.v1.0~a.test.type.v1.0",
      "severity": "error",
      "enabled": true,
      "contextKeys": [],
      "searchableDetails": [],
      "supportedOS": [
        "ios",
        "linux",
        "macos",
        "windows"
      ],
      "category": "cti.a.p.am.alert.category.v1.0~a.test.category.v1.0",
      "cti_name": "cti.a.p.am.alert.v1.0~a.test.type.v1.0",
      "alias": "test type"
    }
  ]
}

Changes

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