Get available connectors

Base URL: https://{kibana_url}

GET /api/workflows/connectors

Auth

Retrieve the Kibana action connectors that can be used in workflow steps, grouped by connector type. Each type includes its configured instances and availability status.

Required privileges

Privileges workflowsManagement:read

Response

200

Indicates a successful response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/workflows/connectors

curl Shell

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

Response

Example response with available connector types and their instances

{
  "connectorTypes": {
    ".email": {
      "actionTypeId": ".email",
      "displayName": "Email",
      "enabled": true,
      "enabledInConfig": true,
      "enabledInLicense": true,
      "instances": [],
      "minimumLicenseRequired": "gold",
      "subActions": [
        {
          "displayName": "Send",
          "name": "send"
        }
      ]
    },
    ".slack_api": {
      "actionTypeId": ".slack_api",
      "displayName": "Slack",
      "enabled": true,
      "enabledInConfig": true,
      "enabledInLicense": true,
      "instances": [
        {
          "id": "slack-connector-1",
          "isDeprecated": false,
          "isPreconfigured": false,
          "name": "Team Notifications"
        }
      ],
      "minimumLicenseRequired": "gold",
      "subActions": [
        {
          "displayName": "Post Message",
          "name": "postMessage"
        }
      ]
    }
  },
  "totalConnectors": 1
}