ELelastic
synthetics

Get a private location

Spaces method and path for this operation:

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

Refer to Spaces for more information.

You must have read privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges.<br/><br/>[Required authorization] Route required privileges: uptime-read.

get/api/synthetics/private_locations/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/synthetics/private_locations/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

idstring required

A private location identifier or label.

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.

spacesstring[]

The space IDs where the private location is available.

tagsstring[]

An array of tags to categorize the private location.

Changes

No operation changes recorded.