Sign in
Synthetics

Create a private location

Create a new Synthetic private location.

post/api/v1/synthetics/private-locations

Request body

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 request

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

Response

OK

configobject

Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.

Example response

{
  "private_location": {
    "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 endpoint across all 1 revision of this API.