v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB

synthetics

Update a private location

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span> <span class="operation-path">/s/{space_id}/api/synthetics/private_locations/{id}</span></div>

Refer to Spaces for more information.

Update an existing private location's label. You must have all privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges. When a private location's label is updated, all monitors using this location will also be updated to maintain data consistency.

put/api/synthetics/private_locations/{id}

Path parameters

idstring required

The unique identifier of the private location to be updated.

Request body

labelstring required

A new label for the private location. Must be at least 1 character long.

Response

A successful response.

agentPolicyIdstring

The ID of the agent policy associated with the private location.

idstring

The unique identifier of the private location.

isInvalidboolean

Indicates whether the location is invalid. If true, the location is invalid, which means the agent policy associated with the location is deleted.

labelstring

A label for the private location.

namespacestring

The namespace of the location, which is the same as the namespace of the agent policy associated with the location.