IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete connector API Get all connectors API »

› › ›

Get connector API

edit

Get connector API

edit

Retrieves a connector by ID.

For the most up-to-date API details, refer to the open API specification.

Request

edit

GET <kibana host>:<port>/api/actions/connector/<id>

GET <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>

Prerequisites

edit

You must have read privileges for the Actions and Connectors feature in the Management section of the Kibana feature privileges.

Path parameters

edit

id: (Required, string) The ID of the connector.
space_id: (Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Response codes

edit

200: Indicates a successful call.

Examples

edit

GET api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad

The API returns the following:

{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "connector_type_id": ".index",
  "name": "my-connector",
  "config": {
    "index": "test-index",
    "refresh": false,
    "executionTimeField": null
  },
  "is_preconfigured": false,
  "is_deprecated": false,
  "is_missing_secrets": false
}

« Delete connector API Get all connectors API »