# Elastic Connector API

**Canonical:** https://apis.io/apis/elastic/elastic-connector-api/  
**Provider:** Elastic — https://apis.io/providers/elastic/  
**Base URL:** https://api.elastic-cloud.com  
**Documentation:** https://www.elastic.co/docs/api/doc/elasticsearch

Elastic Connector API is one of 50 APIs that [Elastic](https://apis.io/providers/elastic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Connector. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index. Connectors are Elasticsearch integrations for syncing content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid. This API requires the `manage_connector` privilege or, for read-only endpoints, the `monitor_connector` privilege.

## Operations (30)

| Method | Path | Summary |
|---|---|---|
| PUT | `/_connector/{connector_id}/_check_in` | Check in a connector |
| GET | `/_connector/{connector_id}` | Get a connector |
| PUT | `/_connector/{connector_id}` | Create or update a connector |
| DELETE | `/_connector/{connector_id}` | Delete a connector |
| GET | `/_connector` | Get all connectors |
| PUT | `/_connector` | Create or update a connector |
| POST | `/_connector` | Create a connector |
| PUT | `/_connector/_sync_job/{connector_sync_job_id}/_cancel` | Cancel a connector sync job |
| PUT | `/_connector/_sync_job/{connector_sync_job_id}/_check_in` | Check in a connector sync job |
| PUT | `/_connector/_sync_job/{connector_sync_job_id}/_claim` | Claim a connector sync job |
| GET | `/_connector/_sync_job/{connector_sync_job_id}` | Get a connector sync job |
| DELETE | `/_connector/_sync_job/{connector_sync_job_id}` | Delete a connector sync job |
| PUT | `/_connector/_sync_job/{connector_sync_job_id}/_error` | Set a connector sync job error |
| GET | `/_connector/_sync_job` | Get all connector sync jobs |
| POST | `/_connector/_sync_job` | Create a connector sync job |
| PUT | `/_connector/_sync_job/{connector_sync_job_id}/_stats` | Set the connector sync job stats |
| PUT | `/_connector/{connector_id}/_filtering/_activate` | Activate the connector draft filter |
| PUT | `/_connector/{connector_id}/_api_key_id` | Update the connector API key ID |
| PUT | `/_connector/{connector_id}/_configuration` | Update the connector configuration |
| PUT | `/_connector/{connector_id}/_error` | Update the connector error field |
| PUT | `/_connector/{connector_id}/_features` | Update the connector features |
| PUT | `/_connector/{connector_id}/_filtering` | Update the connector filtering |
| PUT | `/_connector/{connector_id}/_filtering/_validation` | Update the connector draft filtering validation |
| PUT | `/_connector/{connector_id}/_index_name` | Update the connector index name |
| PUT | `/_connector/{connector_id}/_name` | Update the connector name and description |
| PUT | `/_connector/{connector_id}/_native` | Update the connector is_native flag |
| PUT | `/_connector/{connector_id}/_pipeline` | Update the connector pipeline |
| PUT | `/_connector/{connector_id}/_scheduling` | Update the connector scheduling |
| PUT | `/_connector/{connector_id}/_service_type` | Update the connector service type |
| PUT | `/_connector/{connector_id}/_status` | Update the connector status |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-connector-api-openapi.yml
- **Documentation** — https://www.elastic.co/docs/api/doc/elasticsearch
- **Documentation** — https://www.elastic.co/docs/api/doc/kibana
- **Documentation** — https://www.elastic.co/docs/api/doc/cloud
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

## Other Elastic APIs (12)

- [Elastic Account API](https://apis.io/apis/elastic/elastic-account-api/)
- [Elastic Cluster API](https://apis.io/apis/elastic/elastic-cluster-api/)
- [Elastic Deployments API](https://apis.io/apis/elastic/elastic-deployments-api/)
- [Elastic Documents API](https://apis.io/apis/elastic/elastic-documents-api/)
- [Elastic Indices API](https://apis.io/apis/elastic/elastic-indices-api/)
- [Elastic Search API](https://apis.io/apis/elastic/elastic-search-api/)
- [Elastic Security API](https://apis.io/apis/elastic/elastic-security-api/)
- [Elastic Spaces API](https://apis.io/apis/elastic/elastic-spaces-api/)
- [Elastic Status API](https://apis.io/apis/elastic/elastic-status-api/)
- [Elastic TrafficFilters API](https://apis.io/apis/elastic/elastic-trafficfilters-api/)
- [Elastic Analytics API](https://apis.io/apis/elastic/elastic-analytics-api/)
- [Elastic Cat API](https://apis.io/apis/elastic/elastic-cat-api/)

## Tags

Connector

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elastic/elastic-connector-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elastic/.