Get a private location

Base URL: https://{kibana_url}

GET /api/synthetics/private_locations/{id}

Auth

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

Path parameters

id string required: A private location identifier or label.

Response

A successful response.

application/json

agentPolicyId string: The ID of the agent policy associated with the private location.
geo object: Geographic coordinates (WGS84) for the location.
id string: The unique identifier of the private location.
isInvalid boolean: Indicates whether the location is invalid. If true, the location is invalid, which means the agent policy associated with the location is deleted.
label string: A label for the private location.
namespace string: The namespace of the location, which is the same as the namespace of the agent policy associated with the location.

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/synthetics/private_locations/ID

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/synthetics/private_locations/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
    "label": "Test private location",
    "id": "test-private-location-id",
    "agentPolicyId": "test-private-location-id",
    "isServiceManaged": false,
    "isInvalid": false,
    "geo": {
        "lat": 0,
        "lon": 0
    },
    "namespace": "default"
}