List action types API | Kibana Guide [7.11]

IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

« Get all actions API Create action API »

List action types APIedit

Retrieves a list of all action types.

Requestedit

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

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

Path parametersedit

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

Response codeedit

200: Indicates a successful call.

Exampleedit

$ 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.

« Get all actions API Create action API »