Connector APIsedit
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
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 third-party Elasticsearch integrations which can be deployed on Elastic Cloud or hosted on your own infrastructure:
- Native connectors are a managed service on Elastic Cloud
- Connector clients are self-managed on your infrastructure
Find a list of all supported service types in the connectors documentation.
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.
We also have a command-line interface for Elastic connectors. Learn more in the elastic/connectors repository.
Connector APIsedit
You can use these APIs to create, get, delete and update connectors.
Use the following APIs to manage connectors:
- Create connector
- Delete connector
- Get connector
- List connectors
- Check in a connector
- Update connector API key id
- Update connector configuration
- Update connector error
- Update connector filtering
- Update connector index name
- Update connector last sync stats
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Update connector status
Sync Job APIsedit
You can use these APIs to create, cancel, delete and update sync jobs.
Use the following APIs to manage sync jobs: