IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create Private Location API Get Private Locations API »
Elastic Docs ›Kibana Guide [8.13] ›REST API ›Synthetics APIs

Delete Private Location API

edit

Delete Private Location API

edit

Deletes a private location using the provided location ID.

Request

edit

DELETE <kibana host>:<port>/api/synthetics/private_locations/<location_id>

DELETE <kibana host>:<port>/s/<space_id>/api/synthetics/private_locations/<location_id>

Prerequisites

edit

You must have all privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges.

Path Parameters

edit
location_id
(Required, string) The unique identifier of the private location to be deleted. It must be between 1 and 1024 characters.

Example

edit

Here is an example of a DELETE request to delete a private location:

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.

« Create Private Location API Get Private Locations API »