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

    • id string
    • name string
  • actionVariables 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.

    Additional properties are allowed.

    Hide actionVariables attributes Show actionVariables attributes object

    • context array[object]
      Hide context attributes Show context attributes object

      • description string
      • name string
    • params array[object]
      Hide params attributes Show params attributes object

      • description string
      • name string
    • state array[object]
      Hide state attributes Show state attributes object

      • description string
      • name string
  • authorizedConsumers object

    The list of the plugins IDs that have access to the alert type.

    Additional properties are allowed.

  • defaultActionGroupId string

    The default identifier for the alert type group.

  • enabledInLicense boolean

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

  • id string

    The unique identifier for the alert type.

  • isExportable boolean

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

  • minimumLicenseRequired string

    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.

  • recoveryActionGroup object

    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.

    Additional properties are allowed.

    Hide recoveryActionGroup attributes Show recoveryActionGroup attributes object

    • id string
    • name string
• 401 application/json; Elastic-Api-Version=2023-10-31

  Authorization information is missing or invalid.

  Hide response attributes Show response attributes object

  • error string

    Value is Unauthorized.

  • message string
  • statusCode integer

    Value is 401.