Get all connectors

Base URL: https://{kibana_url}

GET /api/actions/connectors
GET /s/{space_id}/api/actions/connectors

Refer to Spaces for more information.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Response

200

Indicates a successful call.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/actions/connectors

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/actions/connectors" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

[
  {
    "id": "preconfigured-email-connector",
    "name": "my-preconfigured-email-notification",
    "connector_type_id": ".email",
    "is_preconfigured": true,
    "is_deprecated": false,
    "referenced_by_count": 0,
    "is_system_action": false
  },
  {
    "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81",
    "name": "my-index-connector",
    "config": {
      "index": "test-index",
      "refresh": false,
      "executionTimeField": "null"
    },
    "connector_type_id": ".index",
    "is_preconfigured": false,
    "is_deprecated": false,
    "referenced_by_count": 2,
    "is_missing_secrets": false,
    "is_system_action": false
  }
]