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

# Get a connector

Authentication: required

Availability: Beta since 8.12

## Paths

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

#### Path parameters

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

## Description

Get the details about a connector.

## Query string parameters

- `include_deleted` (boolean · default: false) — optional
  A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.

## Response

`application/json`

- `api_key_id` (string)
- `api_key_secret_id` (string)
- `configuration` (object)
- `custom_scheduling` (object)
- `deleted` (boolean)
- `description` (string)
- `error` (union string) — nullable
  One of: `string`
- `features` (object)
  - `document_level_security` (object)
    Indicates whether document-level security is enabled.
    - `enabled` (boolean)
  - `incremental_sync` (object)
    Indicates whether incremental syncs are enabled.
    - `enabled` (boolean)
  - `native_connector_api_keys` (object)
    Indicates whether managed connector API keys are enabled.
    - `enabled` (boolean)
  - `sync_rules` (object)
    - `advanced` (object)
      Indicates whether advanced sync rules are enabled.
      - `enabled` (boolean)
    - `basic` (object)
      Indicates whether basic sync rules are enabled.
      - `enabled` (boolean)
- `filtering` (object[])
  - `active` (object)
    - `advanced_snippet` (object)
      - `created_at` (union oneOf)
        One of: `string` or `number`
      - `updated_at` (union oneOf)
        One of: `string` or `number`
      - `value` (object)
    - `rules` (object[])
      - `created_at` (union oneOf)
        One of: `string` or `number`
      - `field` (string)
      - `id` (string)
      - `order` (number)
      - `policy` (enum)
        Values: `exclude`, `include`
      - `rule` (enum)
        Values: `contains`, `ends_with`, `equals`, `regex`, `starts_with`, `>`, `<`
      - `updated_at` (union oneOf)
        One of: `string` or `number`
      - `value` (string)
    - `validation` (object)
      - `errors` (object[])
        - `ids` (string[])
        - `messages` (string[])
      - `state` (enum)
        Values: `edited`, `invalid`, `valid`
  - `domain` (string)
  - `draft` (object)
    Same fields as `active` in `filtering`
- `id` (string)
- `index_name` (union string) — nullable
- `is_native` (boolean)
- `language` (string)
- `last_access_control_sync_error` (string)
- `last_access_control_sync_scheduled_at` (union oneOf)
  One of: `string` or `number`
- `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 oneOf)
  One of: `string` or `number`
- `last_indexed_document_count` (number)
- `last_seen` (union oneOf)
  One of: `string` or `number`
- `last_sync_error` (string)
- `last_sync_scheduled_at` (union oneOf)
  One of: `string` or `number`
- `last_sync_status` (enum)
  Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
- `last_synced` (union oneOf)
  One of: `string` or `number`
- `name` (string)
- `pipeline` (object)
  - `extract_binary_content` (boolean)
  - `name` (string)
  - `reduce_whitespace` (boolean)
  - `run_ml_inference` (boolean)
- `scheduling` (object)
  - `access_control` (object)
    - `enabled` (boolean)
    - `interval` (string)
      The interval is expressed using the crontab syntax
  - `full` (object)
    - `enabled` (boolean)
    - `interval` (string)
      The interval is expressed using the crontab syntax
  - `incremental` (object)
    - `enabled` (boolean)
    - `interval` (string)
      The interval is expressed using the crontab syntax
- `service_type` (string)
- `status` (enum)
  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"
)
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "api_key_id": "string",
  "api_key_secret_id": "string",
  "configuration": {
    "key": {
      "category": "string",
      "default_value": 0,
      "depends_on": [
        {
          "field": "string"
        }
      ],
      "display": "textbox",
      "label": "string",
      "options": [
        {
          "label": "string"
        }
      ],
      "order": 0,
      "placeholder": "string",
      "required": false,
      "sensitive": false,
      "tooltip": "string",
      "type": "str",
      "ui_restrictions": [
        "string"
      ],
      "validations": [
        {
          "type": "less_than",
          "constraint": 0
        }
      ],
      "value": {}
    }
  },
  "custom_scheduling": {
    "key": {
      "configuration_overrides": {
        "max_crawl_depth": 0,
        "sitemap_discovery_disabled": false,
        "domain_allowlist": [
          "string"
        ],
        "sitemap_urls": [
          "string"
        ],
        "seed_urls": [
          "string"
        ]
      },
      "enabled": false,
      "interval": "string",
      "last_synced": "string",
      "name": "string"
    }
  },
  "deleted": false,
  "description": "string",
  "error": "string",
  "features": {
    "document_level_security": {
      "enabled": false
    },
    "incremental_sync": {
      "enabled": false
    },
    "native_connector_api_keys": {
      "enabled": false
    },
    "sync_rules": {
      "advanced": {
        "enabled": false
      },
      "basic": {
        "enabled": false
      }
    }
  },
  "filtering": [
    {
      "active": {
        "advanced_snippet": {
          "value": {}
        },
        "rules": [
          {
            "order": 0,
            "value": "string"
          }
        ],
        "validation": {
          "errors": [],
          "state": "edited"
        }
      },
      "domain": "string",
      "draft": {
        "advanced_snippet": {
          "value": {}
        },
        "rules": [
          {
            "order": 0,
            "value": "string"
          }
        ],
        "validation": {
          "errors": [],
          "state": "edited"
        }
      }
    }
  ],
  "id": "string",
  "index_name": "string",
  "is_native": false,
  "language": "string",
  "last_access_control_sync_error": "string",
  "last_access_control_sync_scheduled_at": "string",
  "last_access_control_sync_status": "canceling",
  "last_deleted_document_count": 0,
  "last_incremental_sync_scheduled_at": "string",
  "last_indexed_document_count": 0,
  "last_seen": "string",
  "last_sync_error": "string",
  "last_sync_scheduled_at": "string",
  "last_sync_status": "canceling",
  "last_synced": "string",
  "name": "string",
  "pipeline": {
    "extract_binary_content": false,
    "name": "string",
    "reduce_whitespace": false,
    "run_ml_inference": false
  },
  "scheduling": {
    "access_control": {
      "enabled": false,
      "interval": "string"
    },
    "full": {
      "enabled": false,
      "interval": "string"
    },
    "incremental": {
      "enabled": false,
      "interval": "string"
    }
  },
  "service_type": "string",
  "status": "created",
  "sync_cursor": {},
  "sync_now": false
}
```