get-connector-api.asciidoc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. [[get-connector-api]]
  2. === Get connector API
  3. ++++
  4. <titleabbrev>Get connector</titleabbrev>
  5. ++++
  6. beta::[]
  7. Retrieves the details about a connector.
  8. To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
  9. [[get-connector-api-request]]
  10. ==== {api-request-title}
  11. `GET _connector/<connector_id>`
  12. [[get-connector-api-prereq]]
  13. ==== {api-prereq-title}
  14. * To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
  15. [[get-connector-api-path-params]]
  16. ==== {api-path-parms-title}
  17. `<connector_id>`::
  18. (Required, string)
  19. [[get-connector-api-response-codes]]
  20. ==== {api-response-codes-title}
  21. `400`::
  22. The `connector_id` was not provided.
  23. `404` (Missing resources)::
  24. No connector matching `connector_id` could be found.
  25. [[get-connector-api-example]]
  26. ==== {api-examples-title}
  27. The following example gets the connector `my-connector`:
  28. ////
  29. [source,console]
  30. --------------------------------------------------
  31. PUT _connector/my-connector
  32. {
  33. "index_name": "search-google-drive",
  34. "name": "Google Drive Connector",
  35. "service_type": "google_drive"
  36. }
  37. --------------------------------------------------
  38. // TESTSETUP
  39. [source,console]
  40. --------------------------------------------------
  41. DELETE _connector/my-connector
  42. --------------------------------------------------
  43. // TEARDOWN
  44. ////
  45. [source,console]
  46. ----
  47. GET _connector/my-connector
  48. ----