Sign in
Private locations

Retrieve a private location

Show details of a specific private location.

get/v1/private-locations/{id}

Path parameters

idstring required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

idstring required
namestring required

The name assigned to the private location.

slugNamestring required

Valid slug name.

iconstring

The private location icon.

created_atstring date required
updated_atstring date nullable
proxyUrlstring nullable

A proxy for outgoing API check HTTP calls from your private location.

lastSeenstring date nullable
agentCountnumber nullable
minAgentVersionstring nullable

The lowest agent version currently connected to this private location.

Example response

{
  "id": "0baf2a80-7266-44af-b56c-2af7086782ee",
  "name": "New Private Location",
  "slugName": "new-private-location",
  "icon": "location",
  "keys": [
    {
      "id": "fed3ada8-7d9b-4634-a0fe-471afe0518b6",
      "rawKey": "pl_a89026d28a0c45cf9e11b4c3637f3912",
      "maskedKey": "...6a1e"
    }
  ],
  "proxyUrl": "https://user:password@164.92.149.127:3128",
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check"
        }
      }
    ]
  }
}

Changes

Changed in 1 of the 4 revisions of this API.1

  • 87d29dc7b4fe1See the full diff
    • ○

      added the optional property projectBindings to the response with the 200 status

      response-optional-property-added

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog