Get a private location

Base URL: https://{kibana_url}

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

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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Response

A successful response.

application/json

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"
}