2021-03-26 19:55:39 +01:00
|
|
|
[[delete-connector-api]]
|
2021-03-05 12:49:06 +01:00
|
|
|
=== Delete connector API
|
2021-02-17 19:43:25 +01:00
|
|
|
++++
|
2021-03-26 19:55:39 +01:00
|
|
|
<titleabbrev>Delete connector</titleabbrev>
|
2021-02-17 19:43:25 +01:00
|
|
|
++++
|
|
|
|
|
2021-03-05 12:49:06 +01:00
|
|
|
Deletes an connector by ID.
|
2021-02-17 19:43:25 +01:00
|
|
|
|
2021-03-05 12:49:06 +01:00
|
|
|
WARNING: When you delete a connector, _it cannot be recovered_.
|
2021-02-17 19:43:25 +01:00
|
|
|
|
2021-03-26 19:55:39 +01:00
|
|
|
[[delete-connector-api-request]]
|
2021-02-17 19:43:25 +01:00
|
|
|
==== Request
|
|
|
|
|
2021-03-05 12:49:06 +01:00
|
|
|
`DELETE <kibana host>:<port>/api/actions/connector/<id>`
|
2021-02-17 19:43:25 +01:00
|
|
|
|
2021-03-05 12:49:06 +01:00
|
|
|
`DELETE <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`
|
2021-03-01 21:05:19 +01:00
|
|
|
|
2021-03-26 19:55:39 +01:00
|
|
|
[[delete-connector-api-path-params]]
|
2021-02-17 19:43:25 +01:00
|
|
|
==== Path parameters
|
|
|
|
|
|
|
|
`id`::
|
2021-03-05 12:49:06 +01:00
|
|
|
(Required, string) The ID of the connector.
|
2021-02-17 19:43:25 +01:00
|
|
|
|
2021-03-01 21:05:19 +01:00
|
|
|
`space_id`::
|
|
|
|
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
|
|
|
|
2021-03-26 19:55:39 +01:00
|
|
|
[[delete-connector-api-response-codes]]
|
2021-02-17 19:43:25 +01:00
|
|
|
==== Response code
|
|
|
|
|
|
|
|
`200`::
|
|
|
|
Indicates a successful call.
|
|
|
|
|
|
|
|
==== Example
|
|
|
|
|
|
|
|
[source,sh]
|
|
|
|
--------------------------------------------------
|
2021-03-05 12:49:06 +01:00
|
|
|
$ curl -X DELETE api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
|
2021-02-17 19:43:25 +01:00
|
|
|
--------------------------------------------------
|
|
|
|
// KIBANA
|