---
type: api
title: Get a connector
description: Get the details about a connector.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v8/operation/operation-connector-get
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v8/operation/operation-connector-get
products:
  - Elasticsearch
---

# Get a connector

Availability: 8.12+

## Paths

- `GET` `/_connector/{connector_id}`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v8/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v8/authentication#basicauth)
- [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v8/authentication#bearerauth)

#### Path Parameters

- `connector_id` (string Id)
  The unique identifier of the connector

## Description

Get the details about a connector.

## Response

`application/json`

- `api_key_id` (string)
- `api_key_secret_id` (string)
- `configuration` (ConnectorConfiguration)
- `custom_scheduling` (ConnectorCustomScheduling)
- `description` (string)
- `error` (union string) — nullable
  One of: `string`
- `features` ({} ConnectorFeatures)
  - `document_level_security` ({} FeatureEnabled)
    Indicates whether document-level security is enabled.
    - `enabled` (boolean)
  - `incremental_sync` ({} FeatureEnabled)
    Indicates whether incremental syncs are enabled.
    - `enabled` (boolean)
  - `native_connector_api_keys` ({} FeatureEnabled)
    Indicates whether managed connector API keys are enabled.
    - `enabled` (boolean)
  - `sync_rules` ({} SyncRulesFeature)
    - `advanced` ({} FeatureEnabled)
      Indicates whether advanced sync rules are enabled.
      - `enabled` (boolean)
    - `basic` ({} FeatureEnabled)
      Indicates whether basic sync rules are enabled.
      - `enabled` (boolean)
- `filtering` ([] FilteringConfig)
  - `active` ({} FilteringRules)
    - `advanced_snippet` ({} FilteringAdvancedSnippet)
      - `created_at` (DateTime)
      - `updated_at` (DateTime)
      - `value` (object)
    - `rules` ([] FilteringRule)
      - `created_at` (DateTime)
      - `field` (string Field)
      - `id` (string Id)
      - `order` (number)
      - `policy` (enum FilteringPolicy)
        Values: `exclude`, `include`
      - `rule` (enum FilteringRuleRule)
        Values: `contains`, `ends_with`, `equals`, `regex`, `starts_with`, `>`, `<`
      - `updated_at` (DateTime)
      - `value` (string)
    - `validation` ({} FilteringRulesValidation)
      - `errors` ([] FilteringValidation)
        - `ids` ([] string Id)
        - `messages` ([] string)
      - `state` (enum FilteringValidationState)
        Values: `edited`, `invalid`, `valid`
  - `domain` (string)
  - `draft` ({} FilteringRules)
    Same fields as `active` in `filtering`
- `id` (string Id)
- `index_name` (union IndexName | string) — nullable
- `is_native` (boolean)
- `language` (string)
- `last_access_control_sync_error` (string)
- `last_access_control_sync_scheduled_at` (DateTime)
- `last_access_control_sync_status` (enum SyncStatus)
  Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
- `last_deleted_document_count` (number)
- `last_incremental_sync_scheduled_at` (DateTime)
- `last_indexed_document_count` (number)
- `last_seen` (DateTime)
- `last_sync_error` (string)
- `last_sync_scheduled_at` (DateTime)
- `last_sync_status` (enum SyncStatus)
  Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
- `last_synced` (DateTime)
- `name` (string)
- `pipeline` ({} IngestPipelineParams)
  - `extract_binary_content` (boolean)
  - `name` (string)
  - `reduce_whitespace` (boolean)
  - `run_ml_inference` (boolean)
- `scheduling` ({} SchedulingConfiguration)
  - `access_control` ({} ConnectorScheduling)
    - `enabled` (boolean)
    - `interval` (string)
      The interval is expressed using the crontab syntax
  - `full` ({} ConnectorScheduling)
    - `enabled` (boolean)
    - `interval` (string)
      The interval is expressed using the crontab syntax
  - `incremental` ({} ConnectorScheduling)
    - `enabled` (boolean)
    - `interval` (string)
      The interval is expressed using the crontab syntax
- `service_type` (string)
- `status` (enum ConnectorStatus)
  Values: `created`, `needs_configuration`, `configured`, `connected`, `error`
- `sync_cursor` (object)
- `sync_now` (boolean)
## Code Examples

#### Console

```console
GET _connector/my-connector-id
```

#### JavaScript

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

#### Python

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

#### curl

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

#### Java

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

#### PHP

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

#### Ruby

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