---
type: api
title: Connector
description: The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/group/endpoint-connector
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/group/endpoint-connector
products:
  - Elasticsearch
---

# Connector

`connector`

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.

[Check out the connector API tutorial.](https://www.elastic.co/docs/reference/search-connectors/api-tutorial)

- [Check in a connector](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-check-in): `PUT` `/_connector/{connector_id}/_check_in`
- [Get a connector](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-get): `GET` `/_connector/{connector_id}`
- [Create or update a connector
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-put): `PUT` `/_connector/{connector_id}`, `PUT` `/_connector`
- [Delete a connector](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-delete): `DELETE` `/_connector/{connector_id}`
- [Get all connectors](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-list): `GET` `/_connector`
- [Create a connector](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-post): `POST` `/_connector`
- [Cancel a connector sync job](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel): `PUT` `/_connector/_sync_job/{connector_sync_job_id}/_cancel`
- [Check in a connector sync job](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in): `PUT` `/_connector/_sync_job/{connector_sync_job_id}/_check_in`
- [Claim a connector sync job](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim): `PUT` `/_connector/_sync_job/{connector_sync_job_id}/_claim`
- [Get a connector sync job](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get): `GET` `/_connector/_sync_job/{connector_sync_job_id}`
- [Delete a connector sync job](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete): `DELETE` `/_connector/_sync_job/{connector_sync_job_id}`
- [Set a connector sync job error](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error): `PUT` `/_connector/_sync_job/{connector_sync_job_id}/_error`
- [Get all connector sync jobs](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list): `GET` `/_connector/_sync_job`
- [Create a connector sync job](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post): `POST` `/_connector/_sync_job`
- [Set the connector sync job stats](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats): `PUT` `/_connector/_sync_job/{connector_sync_job_id}/_stats`
- [Activate the connector draft filter](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-active-filtering): `PUT` `/_connector/{connector_id}/_filtering/_activate`
- [Update the connector API key ID](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id): `PUT` `/_connector/{connector_id}/_api_key_id`
- [Update the connector configuration](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration): `PUT` `/_connector/{connector_id}/_configuration`
- [Update the connector error field](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-error): `PUT` `/_connector/{connector_id}/_error`
- [Update the connector features](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-features): `PUT` `/_connector/{connector_id}/_features`
- [Update the connector filtering](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering): `PUT` `/_connector/{connector_id}/_filtering`
- [Update the connector draft filtering validation](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation): `PUT` `/_connector/{connector_id}/_filtering/_validation`
- [Update the connector index name](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name): `PUT` `/_connector/{connector_id}/_index_name`
- [Update the connector name and description](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-name): `PUT` `/_connector/{connector_id}/_name`
- [Update the connector is_native flag](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-native): `PUT` `/_connector/{connector_id}/_native`
- [Update the connector pipeline](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline): `PUT` `/_connector/{connector_id}/_pipeline`
- [Update the connector scheduling](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling): `PUT` `/_connector/{connector_id}/_scheduling`
- [Update the connector service type](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type): `PUT` `/_connector/{connector_id}/_service_type`
- [Update the connector status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-connector-update-status): `PUT` `/_connector/{connector_id}/_status`