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

« Get connector API List connector types API »

› › ›

Get all connectors API

edit

Get all connectors API

edit

Retrieves all connectors.

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

Request

edit

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

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

Prerequisites

edit

You must have read privileges for the Actions and Connectors feature in the Management section of the Kibana feature privileges.

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 codes

edit

200: Indicates a successful call.

Examples

edit

GET api/actions/connectors

The API returns the following:

[
  {
    "id": "preconfigured-mail-connector",
    "connector_type_id": ".email",
    "name": "email: preconfigured-mail-connector",
    "is_preconfigured": true,
    "is_deprecated": false,
    "referenced_by_count": 0 
  },
  {
    "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
    "connector_type_id": ".index",
    "name": "my-connector",
    "config": {
      "index": "test-index",
      "refresh": false,
      "executionTimeField": null
    },
    "is_preconfigured": false,
    "is_deprecated": false,
    "is_missing_secrets": false,
    "referenced_by_count": 3
  }
]

referenced_by_count indicates the number of saved objects that reference the connector. This value is not calculated if is_preconfigured is true.

« Get connector API List connector types API »