delete-connector-api.asciidoc 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. [[delete-connector-api]]
  2. === Delete connector API
  3. preview::[]
  4. ++++
  5. <titleabbrev>Delete connector</titleabbrev>
  6. ++++
  7. Removes a connector and its associated data.
  8. This is a destructive action that is not recoverable.
  9. [[delete-connector-api-request]]
  10. ==== {api-request-title}
  11. `DELETE _connector/<connector_id>`
  12. [[delete-connector-api-prereq]]
  13. ==== {api-prereq-title}
  14. * To sync data using connectors, it's essential to have the Elastic connectors service running.
  15. [[delete-connector-api-path-params]]
  16. ==== {api-path-parms-title}
  17. `<connector_id>`::
  18. (Required, string)
  19. [[delete-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. [[delete-connector-api-example]]
  26. ==== {api-examples-title}
  27. The following example deletes the connector with ID `my-connector`:
  28. ////
  29. [source, console]
  30. --------------------------------------------------
  31. PUT _connector/my-connector
  32. {
  33. "index_name": "search-google-drive",
  34. "name": "My Connector",
  35. "service_type": "google_drive"
  36. }
  37. --------------------------------------------------
  38. // TESTSETUP
  39. ////
  40. [source,console]
  41. ----
  42. DELETE _connector/my-connector
  43. ----
  44. [source,console-result]
  45. ----
  46. {
  47. "acknowledged": true
  48. }
  49. ----