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 that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure:

Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud
Self-managed connectors (Connector clients) are self-managed on your 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.

Check out the connector API tutorial

29 endpoints

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