Get a private location

Base URL
https://{kibana_url}
  • GET /api/synthetics/private_locations/{id}
  • GET /s/{space_id}/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.

Required authorization

Privileges uptime-read

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

id string · min length: 1 · max length: 1024 required

A private location identifier or label.

Responses

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.

lat number required

The latitude of the location.

lon number required

The longitude of 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.

spaces string[]

The space IDs where the private location is available.

tags string[]

An array of tags to categorize the private location.

404

No private location matches the given ID or label.

Base URL
https://{kibana_url}