How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Checkly

Checkly Private Locations API

The Private Locations API from Checkly — 8 operation(s) for private locations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Checkly Private Locations API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Private Locations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

8 operations 5 paths 34 schemas 2 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Private Locations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — 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 t…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Private locations 8
GET
/v1/private-locations
List all private locations
getV1Privatelocations 2 params → 200401403429
POST
/v1/private-locations
Create a private location
postV1Privatelocations 1 param body → 201401402403429
DELETE
/v1/private-locations/{id}
Remove a private location
deleteV1PrivatelocationsId 2 params → 204401403404409429
GET
/v1/private-locations/{id}
Retrieve a private location
getV1PrivatelocationsId 2 params → 200401403404429
PUT
/v1/private-locations/{id}
Update a private location
putV1PrivatelocationsId 2 params body → 200401403429
POST
/v1/private-locations/{id}/keys
Generate a new API Key for a private location
postV1PrivatelocationsIdKeys 2 params → 201401402403429
DELETE
/v1/private-locations/{id}/keys/{keyId}
Remove an existing API key for a private location
deleteV1PrivatelocationsIdKeysKeyid 3 params → 204401403429
GET
/v1/private-locations/{id}/metrics
Get private location health metrics from a window of time.
getV1PrivatelocationsIdMetrics 4 params → 200401403429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are privateLocationsSchema (13 properties), commonPrivateLocationSchemaResponse (8 properties), privateLocationKeys (5 properties), TooManyRequestsError (4 properties). Each schema is shown below with its type and property counts.

attributes
object
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
RunningAgent
object
4 properties 4 required
agents
array
Model2
string
timestamps
array
queueSize
array
UnauthorizedError
object
4 properties 2 required
runningAgents
array
A list of agent versions and their counts currently connected to this private location.
TooManyRequestsError
object
4 properties 2 required
Model16
string
PaymentRequiredError
object
4 properties 2 required
privateLocationKeys
object
5 properties 4 required
ConflictError
object
3 properties 2 required
privateLocationsSchema
object
13 properties 4 required
commonPrivateLocationSchemaResponse
object
8 properties 4 required
privateLocationsMetricsHistoryResponseSchema
object
3 properties
oldestScheduledCheckRun
array
keys
array
ProjectBindingV1
object
2 properties 2 required
ForbiddenError
object
3 properties 2 required
ProjectBindingDetailsV1
object
The resource's side of this binding.
2 properties 2 required
ProjectBindingOwnerV1
objectnull
The project that owns this resource — the one whose deploy can delete it. Null when no project owns it, including when other projects merely reference it. In t…
2 properties 2 required
BindingProjectV1
object
The project this binding is to.
3 properties 3 required
Model3
string
NotFoundError
object
3 properties 2 required
error
string
privateLocationCreate
object
4 properties 2 required
privateLocationsListSchema
array
Model4
string
Model1
string
ProjectBindingsV1
object
The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
2 properties 2 required
RunningAgentInfo
object
2 properties 2 required
privateLocationUpdate
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-private-locations-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly
AE Profile APIs.io
Checkly Accounts API
AE Profile APIs.io
Checkly Alert Channels API
AE Profile APIs.io
Checkly Analytics API
AE Profile APIs.io
Checkly Check Alerts API
AE Profile APIs.io
Checkly Check Groups API
AE Profile APIs.io
Checkly Check Results API
AE Profile APIs.io
Checkly Checks API
AE Profile APIs.io
Checkly Dashboards API
AE Profile APIs.io
Checkly Heartbeats API
AE Profile APIs.io
Checkly Incidents API
AE Profile APIs.io
Checkly Maintenance Windows API
AE Profile APIs.io
#Private Locations
← Back to C APIs
API Details
ID
checkly:checkly-private-locations-api
Base URL
https://api.checklyhq.com
Docs
https://www.checklyhq.com
Provider
Checkly
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=checkly-private-locations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/checkly-private-locations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Checkly Private Locations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.