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 connectors API Run connector API »

› › ›

List connector types API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

List connector types API

edit

Retrieves a list of all connector types.

For the most up-to-date API details, refer to the open API specification.

Request

edit

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

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

Prerequisites

edit

You do not need any Kibana feature privileges to run this API.

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.

Query parameters

edit

feature_id: (Optional, string) Filters list of connector types to those that support the feature id.

Response codes

edit

200: Indicates a successful call.

Examples

edit

GET api/actions/connector_types

The API returns the following:

[
  {
    "id": ".email", 
    "name": "Email", 
    "minimum_license_required": "gold", 
    "enabled": false, 
    "enabled_in_config": true, 
    "enabled_in_license": true, 
    "supported_feature_ids": ["alerting"] 
  },
  {
    "id": ".index",
    "name": "Index",
    "minimum_license_required": "basic",
    "enabled": true,
    "enabled_in_config": true,
    "enabled_in_license": true,
    "supported_feature_ids": ["alerting"]
  },
  ...
]

	`id` - The unique ID of the connector type.
	`name` - The name of the connector type.
	`minimum_license_required` - The license required to use the connector type.
	`enabled` - Specifies if the connector type is enabled or disabled in Kibana.
	`enabled_in_config` - Specifies if the connector type is enabled or enabled in the Kibana `.yml` file.
	`enabled_in_license` - Specifies if the connector type is enabled or disabled in the license.
	`supported_feature_ids` - Specifies which Kibana features this connector type supports.

« Get all connectors API Run connector API »