Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Synthetics

Get a private location

Get a Synthetic private location.

get/api/v1/synthetics/private-locations/{location_id}

Path parameters

location_idstring required

The ID of the private location.

Response

OK

descriptionstring required

Description of the private location.

idstring

Unique identifier of the private location.

namestring required

Name of the private location.

tagsstring[] required

Array of tags attached to the private location.

Example response

{
  "description": "Description of private location",
  "metadata": {
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  },
  "name": "New private location",
  "tags": [
    "team:front"
  ]
}