Get the alert types Deprecated

GET /api/alerts/alerts/list_alert_types

Deprecated in 7.13.0. Use the get rule types API instead.

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • actionGroups array[object]

      An explicit list of groups for which the alert type can schedule actions, each with the action group's unique ID and human readable name. Alert actions validation uses this configuration to ensure that groups are valid.

      Hide actionGroups attributes Show actionGroups attributes object
    • A list of action variables that the alert type makes available via context and state in action parameter templates, and a short human readable description. The Alert UI will use this information to prompt users for these variables in action parameter editors.

      Hide actionVariables attributes Show actionVariables attributes object
    • The list of the plugins IDs that have access to the alert type.

    • The default identifier for the alert type group.

    • Indicates whether the rule type is enabled based on the subscription.

    • id string

      The unique identifier for the alert type.

    • Indicates whether the alert type is exportable in Saved Objects Management UI.

    • The subscriptions required to use the alert type.

    • name string

      The descriptive name of the alert type.

    • producer string

      An identifier for the application that produces this alert type.

    • An action group to use when an alert instance goes from an active state to an inactive one. If it is not specified, the default recovered action group is used.

      Hide recoveryActionGroup attributes Show recoveryActionGroup attributes object
  • 401 application/json; Elastic-Api-Version=2023-10-31

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
GET /api/alerts/alerts/list_alert_types
curl \
 -X GET https://localhost:5601/api/alerts/alerts/list_alert_types
Response examples (200)
[
  {
    "actionGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "actionVariables": {
      "context": [
        {
          "description": "string",
          "name": "string"
        }
      ],
      "params": [
        {
          "description": "string",
          "name": "string"
        }
      ],
      "state": [
        {
          "description": "string",
          "name": "string"
        }
      ]
    },
    "authorizedConsumers": {},
    "defaultActionGroupId": "string",
    "enabledInLicense": true,
    "id": "string",
    "isExportable": true,
    "minimumLicenseRequired": "string",
    "name": "string",
    "producer": "string",
    "recoveryActionGroup": {
      "id": "string",
      "name": "string"
    }
  }
]
Response examples (401)
{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}