DAdatadog
Synthetics

Get a private location

Get a Synthetic private location.

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

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/synthetics/private-locations/{location_id}
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: synthetics_private_location_read

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

Changes

No recorded changes to this operation across all 1 revision of this API.