elasticsearch/docs/reference/connector/apis/connector-apis.asciidoc

[[connector-apis]]
== Connector APIs

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs].
--

beta::[]

The connector and sync jobs APIs provide a convenient way to create and manage Elastic <<es-connectors,connectors>>.
 and sync jobs in an internal index. To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


Connectors are {es} integrations that bring content from third-party data sources, which can be deployed on {ecloud} or hosted on your own infrastructure:

* *Managed connectors* are a managed service on {ecloud}
* *Self-managed connectors* are self-hosted on your infrastructure

Find a list of all supported service types in the <<es-connectors,connectors documentation>>.

This API provides an alternative to relying solely on {kib} 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.

[TIP]
====
We also have a command-line interface for Elastic connectors. Learn more in the https://github.com/elastic/connectors/blob/main/docs/CLI.md[elastic/connectors] repository.
====

[discrete]
[[elastic-connector-apis]]
=== Connector APIs

You can use these APIs to create, get, delete and update connectors.

Use the following APIs to manage connectors:

* <<create-connector-api>>
beta:[]
* <<delete-connector-api>>
beta:[]
* <<get-connector-api>>
beta:[]
* <<list-connector-api>>
beta:[]
* <<update-connector-api-key-id-api>>
beta:[]
* <<update-connector-configuration-api>>
beta:[]
* <<update-connector-features-api>>
beta:[]
* <<update-connector-filtering-api>>
beta:[]
* <<update-connector-index-name-api>>
beta:[]
* <<update-connector-name-description-api>>
beta:[]
* <<update-connector-pipeline-api>>
beta:[]
* <<update-connector-scheduling-api>>
beta:[]
* <<update-connector-service-type-api>>
beta:[]


[discrete]
[[sync-job-apis]]
=== Sync Job APIs

You can use these APIs to create, cancel, delete and update sync jobs.

Use the following APIs to manage sync jobs:

* <<create-connector-sync-job-api>>
beta:[]
* <<cancel-connector-sync-job-api>>
beta:[]
* <<delete-connector-sync-job-api>>
beta:[]
* <<get-connector-sync-job-api>>
beta:[]
* <<list-connector-sync-jobs-api>>
beta:[]


[discrete]
[[service-apis]]
=== Service APIs

preview::[]

*Connector Service APIs* are a subset of Connector API endpoints, that represent framework-level operations defined in the https://github.com/elastic/connectors/blob/main/docs/CONNECTOR_PROTOCOL.md[Connector Protocol]. These APIs are not intended for direct connector management by users but are there to support the implementation of services that utilize the Connector Protocol to communicate with {es}.

[TIP]
====
All Elastic connectors are built using our Python connector framework. The source code is available in the https://github.com/elastic/connectors[elastic/connectors] repository on GitHub.
====

[discrete]
[[connector-service-apis]]
==== Connector Service APIs

* <<check-in-connector-api>>
preview:[]
* <<update-connector-error-api>>
preview:[]
* <<update-connector-last-sync-api>>
preview:[]
* <<update-connector-status-api>>
preview:[]

[discrete]
[[sync-job-service-apis]]
==== Sync Job Service APIs

* <<check-in-connector-sync-job-api>>
preview:[]
* <<claim-connector-sync-job-api>>
preview:[]
* <<set-connector-sync-job-error-api>>
preview:[]
* <<set-connector-sync-job-stats-api>>
preview:[]



include::create-connector-api.asciidoc[]
include::delete-connector-api.asciidoc[]
include::get-connector-api.asciidoc[]
include::list-connectors-api.asciidoc[]
include::update-connector-api-key-id-api.asciidoc[]
include::update-connector-configuration-api.asciidoc[]
include::update-connector-index-name-api.asciidoc[]
include::update-connector-features-api.asciidoc[]
include::update-connector-filtering-api.asciidoc[]
include::update-connector-name-description-api.asciidoc[]
include::update-connector-pipeline-api.asciidoc[]
include::update-connector-scheduling-api.asciidoc[]
include::update-connector-service-type-api.asciidoc[]

include::create-connector-sync-job-api.asciidoc[]
include::cancel-connector-sync-job-api.asciidoc[]
include::delete-connector-sync-job-api.asciidoc[]
include::get-connector-sync-job-api.asciidoc[]
include::list-connector-sync-jobs-api.asciidoc[]

include::check-in-connector-api.asciidoc[]
include::update-connector-error-api.asciidoc[]
include::update-connector-last-sync-api.asciidoc[]
include::update-connector-status-api.asciidoc[]

include::check-in-connector-sync-job-api.asciidoc[]
include::claim-connector-sync-job-api.asciidoc[]
include::set-connector-sync-job-error-api.asciidoc[]
include::set-connector-sync-job-stats-api.asciidoc[]