GET /api/actions/connector_types
Api key auth

Spaces method and path for this operation:

get /s/{space_id}/api/actions/connector_types

Refer to Spaces for more information.

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

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).

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • allow_multiple_system_actions boolean

      Indicates whether multiple instances of the same system action connector can be used in a single rule.

    • enabled boolean Required

      Indicates whether the connector is enabled.

    • enabled_in_config boolean Required

      Indicates whether the connector is enabled in the Kibana configuration.

    • enabled_in_license boolean Required

      Indicates whether the connector is enabled through the license.

    • id string Required

      The identifier for the connector.

    • is_deprecated boolean Required

      Indicates whether the connector type is deprecated.

    • is_system_action_type boolean Required

      Indicates whether the action is a system action.

    • minimum_license_required string Required

      The minimum license required to enable the connector.

      Values are basic, standard, gold, platinum, enterprise, or trial.

    • name string Required

      The name of the connector type.

    • source string Required

      The source of the connector type definition.

      Values are yml, spec, or stack.

    • sub_feature string

      Indicates the sub-feature type the connector is grouped under.

      Value is endpointSecurity.

    • supported_feature_ids array[string] Required

      The list of supported features
  • 403

    Indicates that this call is forbidden.

GET /api/actions/connector_types 
curl \
 --request GET 'https://<KIBANA_URL>/api/actions/connector_types' \
 --header "Authorization: $API_KEY"
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"
  }
]