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.

Required authorization

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

Responses

A successful response.

application/json

404

No private location matches the given ID or label.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/synthetics/private_locations/location-id

curl Shell

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

Response

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