delete-connector-api.asciidoc 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. [[delete-connector-api]]
  2. === Delete connector API
  3. ++++
  4. <titleabbrev>Delete connector</titleabbrev>
  5. ++++
  6. preview::[]
  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. * The `connector_id` parameter should reference an existing connector.
  16. [[delete-connector-api-path-params]]
  17. ==== {api-path-parms-title}
  18. `<connector_id>`::
  19. (Required, string)
  20. [[delete-connector-api-response-codes]]
  21. ==== {api-response-codes-title}
  22. `400`::
  23. The `connector_id` was not provided.
  24. `404` (Missing resources)::
  25. No connector matching `connector_id` could be found.
  26. [[delete-connector-api-example]]
  27. ==== {api-examples-title}
  28. The following example deletes the connector with ID `my-connector`:
  29. ////
  30. [source, console]
  31. --------------------------------------------------
  32. PUT _connector/my-connector
  33. {
  34. "index_name": "search-google-drive",
  35. "name": "My Connector",
  36. "service_type": "google_drive"
  37. }
  38. --------------------------------------------------
  39. // TESTSETUP
  40. ////
  41. [source,console]
  42. ----
  43. DELETE _connector/my-connector
  44. ----
  45. [source,console-result]
  46. ----
  47. {
  48. "acknowledged": true
  49. }
  50. ----