v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Private locations

Create a private location

Creates a new private location.

post/v1/private-locations

Headers

x-checkly-accountstring

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

Request body

namestring required

The name assigned to the private location.

slugNamestring required

Valid slug name.

iconstring

proxyUrlstring nullable

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

Example request

{
  "name": "New Private Location",
  "slugName": "new-private-location",
  "icon": "location",
  "proxyUrl": "https://user:password@164.92.149.127:3128"
}

Response

Created

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.

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