mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 19:13:14 -04:00
d2a54d9180
Co-authored-by: Abdul Wahab Zahid <awahab07@yahoo.com> Co-authored-by: Justin Kambic <jk@elastic.co>
41 lines
No EOL
1.4 KiB
Text
41 lines
No EOL
1.4 KiB
Text
[[delete-private-location-api]]
|
|
== Delete Private Location API
|
|
++++
|
|
<titleabbrev>Delete Private Location</titleabbrev>
|
|
++++
|
|
|
|
Deletes a private location using the provided location ID.
|
|
|
|
=== {api-request-title}
|
|
|
|
`DELETE <kibana host>:<port>/api/synthetics/private_locations/<location_id>`
|
|
|
|
`DELETE <kibana host>:<port>/s/<space_id>/api/synthetics/private_locations/<location_id>`
|
|
|
|
=== {api-prereq-title}
|
|
|
|
You must have `all` privileges for the *Synthetics and Uptime* feature in the *{observability}* section of the
|
|
<<kibana-feature-privileges,{kib} feature privileges>>.
|
|
|
|
|
|
[[private-location-delete-params]]
|
|
==== Path Parameters
|
|
|
|
`location_id`::
|
|
(Required, string) The unique identifier of the private location to be deleted. It must be between 1 and 1024 characters.
|
|
|
|
[[private-location-delete-example]]
|
|
==== Example
|
|
|
|
Here is an example of a DELETE request to delete a private location:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
DELETE /api/private-locations/<location_id>
|
|
--------------------------------------------------
|
|
|
|
The API does not return a response body for deletion, but it will return an appropriate status code upon successful deletion.
|
|
|
|
This API will delete the private location with the specified `locationId`.
|
|
|
|
A location cannot be deleted if it has associated monitors in use. You must delete all monitors associated with the location before deleting the location. |