Skip to main content
POST
/
v1
/
private-locations
Create a private location
curl --request POST \
  --url https://api.checklyhq.com/v1/private-locations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "New Private Location",
  "slugName": "new-private-location",
  "icon": "location",
  "proxyUrl": "https://user:password@164.92.149.127:3128"
}'
{
  "id": "0baf2a80-7266-44af-b56c-2af7086782ee",
  "name": "New Private Location",
  "slugName": "new-private-location",
  "icon": "location",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "checkAssignments": [
    {
      "id": "4295d566-18bd-47ef-b22b-129a64ffd589",
      "checkId": "25039e6d-8631-4ee8-950a-bf7c893c3c1c",
      "privateLocationId": "cc3f943d-7a99-49f4-94aa-bddbaaad6eb0"
    }
  ],
  "groupAssignments": [
    {
      "id": "450d2f06-2300-46ed-8982-b63cd53fc494",
      "groupId": 10,
      "privateLocationId": "895c13cc-7de2-46df-9985-cb01b995a3cf"
    }
  ],
  "keys": [
    {
      "id": "fed3ada8-7d9b-4634-a0fe-471afe0518b6",
      "rawKey": "pl_a89026d28a0c45cf9e11b4c3637f3912",
      "maskedKey": "...6a1e",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "proxyUrl": "https://user:password@164.92.149.127:3128"
}

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Body

application/json
​
name
string
required

The name assigned to the private location.

Example:

"New Private Location"

​
slugName
string
required

Valid slug name.

Example:

"new-private-location"

​
icon
string
default:location
Example:

"location"

​
proxyUrl
string

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

Example:

"https://user:password@164.92.149.127:3128"

Response

Created

​
id
string
required
Example:

"0baf2a80-7266-44af-b56c-2af7086782ee"

​
name
string
required

The name assigned to the private location.

Example:

"New Private Location"

​
slugName
string
required

Valid slug name.

Example:

"new-private-location"

​
created_at
string<date>
required
​
icon
string

The private location icon.

Example:

"location"

​
updated_at
string<date>
​
checkAssignments
object[]

The check this private location has assigned.

​
groupAssignments
object[]

The group this private location has assigned.

​
keys
object[]
​
proxyUrl
string

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

Example:

"https://user:password@164.92.149.127:3128"

⌘I