Get connector information

Base URL: https://{kibana_url}

GET /api/actions/connector/{id}

Auth

Path parameters

id string required: An identifier for the connector.

Responses

Indicates a successful call.

application/json

auth_mode enum: The authentication mode used for the connector.; Values: shared per-user
config map string to object
connector_type_id string required: The connector type identifier.
id string required: The identifier for the connector.
is_connector_type_deprecated boolean required: Indicates whether the connector type is deprecated.
is_deprecated boolean required: Indicates whether the connector is deprecated.
is_missing_secrets boolean: Indicates whether the connector is missing secrets.
is_preconfigured boolean required: Indicates whether the connector is preconfigured. If true, the config and is_missing_secrets properties are omitted from the response.
is_system_action boolean required: Indicates whether the connector is used for system actions.
name string required: The name of the connector.

403

Indicates that this call is forbidden.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/actions/connector/ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "id": "df770e30-8b8b-11ed-a780-3b746c987a81",
  "name": "my_server_log_connector",
  "config": {},
  "connector_type_id": ".server-log",
  "is_preconfigured": false,
  "is_deprecated": false,
  "is_missing_secrets": false,
  "is_system_action": false
}