kibana/docs/api/actions-and-connectors/delete.asciidoc
Mike Côté 03db229e2d
Changes to the connector API doc URLs (#95515)
* Initial commit

* Remove 'API' from title abbreviations

* Merge deprecated warning w/ alternative solution
2021-03-26 14:55:39 -04:00

40 lines
935 B
Plaintext

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