Delete a private location

DELETE /api/synthetics/private_locations/{id}
Api key auth Basic auth

Spaces method and path for this operation:

delete /s/{space_id}/api/synthetics/private_locations/{id}

Refer to Spaces for more information.

You must have all privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges. The API does not return a response body for deletion, but it will return an appropriate status code upon successful deletion. 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.

Path parameters

  • id string Required

    The unique identifier of the private location to be deleted.

    Minimum length is 1, maximum length is 1024.

DELETE /api/synthetics/private_locations/{id} 
curl \
 --request DELETE 'https://localhost:5601/api/synthetics/private_locations/{id}' \
 --header "Authorization: $API_KEY"