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.

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