connector-apis.asciidoc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. [[connector-apis]]
  2. == Connector APIs
  3. preview::[]
  4. ++++
  5. <titleabbrev>Connector APIs</titleabbrev>
  6. ++++
  7. ---
  8. The connector and sync jobs API provides a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
  9. This API provides an alternative to relying solely on {kib} UI for connector and sync job management. The API comes with a set of
  10. validations and assertions to ensure that the state representation in the internal index remains valid.
  11. [discrete]
  12. [[elastic-connector-apis]]
  13. === Connector APIs
  14. You can use these APIs to create, get, delete and update connectors.
  15. Use the following APIs to manage connectors:
  16. * <<create-connector-api>>
  17. * <<delete-connector-api>>
  18. * <<get-connector-api>>
  19. * <<list-connector-api>>
  20. [discrete]
  21. [[sync-job-apis]]
  22. === Sync Job APIs
  23. You can use these APIs to create, cancel, delete and update sync jobs.
  24. Use the following APIs to manage sync jobs:
  25. * <<cancel-connector-sync-job-api>>
  26. * <<check-in-connector-sync-job-api>>
  27. * <<create-connector-sync-job-api>>
  28. * <<delete-connector-sync-job-api>
  29. * <<get-connector-sync-job-api>>
  30. * <<list-connector-sync-jobs-api>>
  31. include::cancel-connector-sync-job-api.asciidoc[]
  32. include::check-in-connector-sync-job-api.asciidoc[]
  33. include::create-connector-api.asciidoc[]
  34. include::create-connector-sync-job-api.asciidoc[]
  35. include::delete-connector-api.asciidoc[]
  36. include::delete-connector-sync-job-api.asciidoc[]
  37. include::get-connector-api.asciidoc[]
  38. include::get-connector-sync-job-api.asciidoc[]
  39. include::list-connectors-api.asciidoc[]
  40. include::list-connector-sync-jobs-api.asciidoc[]