Get a connector

GET /_connector/{connector_id}

Get the details about a connector.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

api_key_id string
api_key_secret_id string
configuration object required
custom_scheduling object required
deleted boolean required
description string
error union string nullable: One of: string
features object
filtering object[] required
id string
index_name union string nullable
is_native boolean required
language string
last_access_control_sync_error string
last_access_control_sync_scheduled_at union
last_access_control_sync_status enum: Values: canceling canceled completed error in_progress pending suspended
last_deleted_document_count number
last_incremental_sync_scheduled_at union
last_indexed_document_count number
last_seen union
last_sync_error string
last_sync_scheduled_at union
last_sync_status enum: Values: canceling canceled completed error in_progress pending suspended
last_synced union
name string
pipeline object
scheduling object required
service_type string
status enum required: Values: created needs_configuration configured connected error
sync_cursor object
sync_now boolean required

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _connector/my-connector-id

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.get({
  connector_id: "my-connector-id",
});

Python Elasticsearch Python Client

resp = client.connector.get(
    connector_id="my-connector-id",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_connector/my-connector-id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.connector().get(g -> g
    .connectorId("my-connector-id")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->get([
    "connector_id" => "my-connector-id",
]);

Ruby Elasticsearch Ruby Client

response = client.connector.get(
  connector_id: "my-connector-id"
)

Response

No example