Get all connector types

GET /api/actions/connector_types

Query parameters

  • feature_id string

    A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).

    Values are alerting, cases, generativeAIForSecurity, generativeAIForObservability, generativeAIForSearchPlayground, siem, or uptime.

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    Indicates a successful call.

    Hide response attributes Show response attributes object

    The properties vary for each connector type.

    • enabled boolean

      Indicates whether the connector type is enabled in Kibana.

    • enabled_in_config boolean

      Indicates whether the connector type is enabled in the Kibana configuration file.

    • enabled_in_license boolean

      Indicates whether the connector is enabled in the license.

    • id string

      The type of connector. For example, .email, .index, .jira, .opsgenie, or .server-log.

      Values are .bedrock, .gemini, .cases-webhook, .d3security, .email, .gen-ai, .index, .jira, .opsgenie, .pagerduty, .resilient, .sentinelone, .servicenow, .servicenow-itom, .servicenow-sir, .server-log, .slack, .slack_api, .swimlane, .teams, .tines, .torq, .webhook, or .xmatters.

    • is_system_action_type boolean
    • minimum_license_required string

      The license that is required to use the connector type.

    • name string

      The name of the connector type.

    • supported_feature_ids array[string]

      The feature that uses the connector.

      Values are alerting, cases, generativeAIForSecurity, generativeAIForObservability, generativeAIForSearchPlayground, siem, or uptime.
  • 401 application/json; Elastic-Api-Version=2023-10-31

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
GET /api/actions/connector_types 
curl \
 -X GET https://localhost:5601/api/actions/connector_types
Response examples (200) 
[
  {
    "id": ".gen-ai",
    "name": "OpenAI",
    "enabled": true,
    "enabled_in_config": true,
    "enabled_in_license": true,
    "is_system_action_type": false,
    "supported_feature_ids": [
      "generativeAIForSecurity",
      "generativeAIForObservability",
      "generativeAIForSearchPlayground"
    ],
    "minimum_license_required": "enterprise"
  },
  {
    "id": ".bedrock",
    "name": "AWS Bedrock",
    "enabled": true,
    "enabled_in_config": true,
    "enabled_in_license": true,
    "is_system_action_type": false,
    "supported_feature_ids": [
      "generativeAIForSecurity",
      "generativeAIForObservability",
      "generativeAIForSearchPlayground"
    ],
    "minimum_license_required": "enterprise"
  },
  {
    "id": ".gemini",
    "name": "Google Gemini",
    "enabled": true,
    "enabled_in_config": true,
    "enabled_in_license": true,
    "is_system_action_type": false,
    "supported_feature_ids": [
      "generativeAIForSecurity"
    ],
    "minimum_license_required": "enterprise"
  }
]
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}