List action types API

edit

Retrieves a list of all action types.

Request

edit

GET <kibana host>:<port>/api/actions/list_action_types

GET <kibana host>:<port>/s/<space_id>/api/actions/list_action_types

Path parameters

edit
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Response code

edit
200
Indicates a successful call.

Example

edit
$ curl -X GET api/actions/list_action_types

The API returns the following:

[
  {
    "id": ".email", 
    "name": "Email", 
    "minimumLicenseRequired": "gold", 
    "enabled": false, 
    "enabledInConfig": true, 
    "enabledInLicense": false 
  },
  {
    "id": ".index",
    "name": "Index",
    "minimumLicenseRequired": "basic",
    "enabled": true,
    "enabledInConfig": true,
    "enabledInLicense": true
  }
]

id - The unique ID of the action type.

name - The name of the action type.

minimumLicenseRequired - The license required to use the action type.

enabled - Specifies if the action type is enabled or disabled in Kibana.

enabledInConfig - Specifies if the action type is enabled or enabled in the Kibana .yml file.

enabledInLicense - Specifies if the action type is enabled or disabled in the license.