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

Checkly Checks API

The Checks API from Checkly — 18 operation(s) for checks.

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

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

This API exposes 18 operations across 15 paths, and defines 129 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

18 operations 15 paths 129 schemas 1 DELETE6 GET6 POST5 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 Checks 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 18

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

Checks 18
GET
/v1/checks
List all checks
getV1Checks 9 params → 200400401403429
POST
/v1/checksdeprecated
Create a check
postV1Checks 2 params body → 201400401402403429
POST
/v1/checks/api
Create an API check
postV1ChecksApi 2 params body → 201400401402403429
PUT
/v1/checks/api/{id}
Update an API check
putV1ChecksApiId 3 params body → 200400401403429
POST
/v1/checks/browser
Create a browser check
postV1ChecksBrowser 2 params body → 201400401402403429
PUT
/v1/checks/browser/{id}
Update a browser check
putV1ChecksBrowserId 3 params body → 200400401403429
POST
/v1/checks/dns
Create an DNS monitor
postV1ChecksDns 2 params body → 201400401402403429
POST
/v1/checks/multistep
Create a multi-step check
postV1ChecksMultistep 2 params body → 201400401402403429
PUT
/v1/checks/multistep/{id}
Update a multi-step check
putV1ChecksMultistepId 3 params body → 200400401403429
POST
/v1/checks/tcp
Create a TCP check
postV1ChecksTcp 2 params body → 201400401402403429
PUT
/v1/checks/tcp/{id}
Update an TCP check
putV1ChecksTcpId 3 params body → 200400401403429
DELETE
/v1/checks/{id}
Delete a check
deleteV1ChecksId 2 params → 204400401403429
GET
/v1/checks/{id}
Retrieve a check
getV1ChecksId 4 params → 200400401403404429
PUT
/v1/checks/{id}deprecated
Update a check
putV1ChecksId 3 params body → 200400401403429
GET
/v2/checks
List all checks
getV2Checks 9 params → 200400401403429
GET
/v2/checks/{id}
Retrieve a check
getV2ChecksId 4 params → 200400401403404429
GET
/v3/checks
List all checks
getV3Checks 9 params → 200400401403429
GET
/v3/checks/{id}
Retrieve a check
getV3ChecksId 4 params → 200400401403404429

Schemas 129

The contract defines 129 schemas that model the data the API accepts and returns. The most detailed are ChecksV1GenericCheck (47 properties), ChecksV3GenericCheck (43 properties), ChecksV2GenericCheck (43 properties), ChecksV1ApiCheck (39 properties). Each schema is shown below with its type and property counts.

ChecksV1IcmpRequestPatch
object
4 properties 1 required
ChecksV1KeyValuePatch
object
3 properties 2 required
ChecksV1CheckIntent
objectnull
3 properties 1 required
ChecksV2TracerouteMonitor
object
31 properties 1 required
ChecksV1ApiAssertion
object
5 properties
ChecksV2SslMonitor
object
31 properties 1 required
ChecksV1DnsRequest
object
6 properties 2 required
ChecksV3CheckIntent
objectnull
2 properties 1 required
ChecksV1DnsMonitorCreate
object
35 properties 2 required
ChecksV1SslMonitor
object
35 properties 1 required
ChecksV1DnsAssertion
object
5 properties
ChecksV1AlertSettingsCreate
object
6 properties
ApiError
object
3 properties 3 required
ChecksV2MultiStepCheck
object
29 properties 2 required
ChecksV1DnsMonitorMutationResponse
object
30 properties 1 required
ChecksV1AlertSms
object
2 properties 1 required
ChecksV1Check
ChecksV1MultiStepCheckCreate
object
26 properties 2 required
ChecksV1IcmpMonitor
object
35 properties 1 required
ChecksV1TcpCheck
object
35 properties 1 required
ChecksV3CheckIntentConstraintType
string
Whether the statement is an outcome the check must prove or behavior a repair must preserve.
ChecksV1DependencyList
arraynull
ChecksV1TcpCheckMutationResponse
object
30 properties 1 required
ChecksV1BrowserCheckCreate
object
27 properties 2 required
ChecksV2HeartbeatCheck
object
23 properties 1 required
ChecksV1PlaywrightCheck
object
37 properties 2 required
ChecksV2Check
ChecksV3IcmpMonitor
object
31 properties 1 required
ChecksV1Heartbeat
object
6 properties 4 required
ChecksV1HeartbeatCheck
object
27 properties 1 required
ChecksV1SslSecurityBaselineRead
object
10 properties
ChecksV1TracerouteAssertionRead
object
5 properties
ChecksV1ApiCheckMutationResponse
object
34 properties 1 required
ChecksV1UrlAssertionPatch
object
5 properties
ChecksV2GrpcMonitor
object
31 properties 1 required
ChecksV3CheckList
array
ChecksV1AlertSettingsPatch
objectnull
6 properties
ChecksV1AlertEmail
object
1 property
ProjectBindingV1
object
2 properties 2 required
ChecksV1EnvironmentVariablePatch
object
4 properties 2 required
ChecksV1Dependency
object
2 properties 2 required
ChecksV1GrpcConfigRead
object
10 properties
ChecksV3GenericCheck
object
43 properties 2 required
ChecksV1EnvironmentVariable
object
4 properties 2 required
ChecksV1AlertSettingsRunBasedEscalation
object
1 property
ChecksV1SslConfigRead
object
9 properties 1 required
ChecksV1SslConfigPatch
object
9 properties 1 required
ChecksV1GrpcMonitor
object
35 properties 1 required
ChecksV1IcmpAssertion
object
5 properties
ChecksV1SslConfig
object
9 properties 1 required
ChecksV2BrowserCheck
object
30 properties 2 required
ChecksV1DnsMonitor
object
35 properties 1 required
ChecksV1ApiCheckCreate
object
30 properties 2 required
ChecksV1TracerouteMonitor
object
35 properties 1 required
ChecksV1SslSecurityBaselinePatch
object
10 properties
ChecksV1CheckUpdate
object
36 properties
ChecksV3TracerouteMonitor
object
31 properties 1 required
ChecksV3UrlMonitor
object
31 properties 1 required
ChecksV1TracerouteRequestRead
object
9 properties
ChecksV1GenericCheck
object
47 properties 2 required
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
ChecksV1AlertSettingsCreatePatch
object
6 properties
ChecksV1GrpcAssertionRead
object
5 properties
ChecksV3CheckIntentConstraint
object
2 properties 2 required
ChecksV3BrowserCheck
object
30 properties 2 required
ChecksV1AlertChannelSubscription
object
2 properties 2 required
ChecksV3ApiCheck
object
35 properties 1 required
ChecksV1IcmpRequest
object
4 properties 1 required
ChecksV1AlertSlack
object
1 property
ChecksV1TcpAssertion
object
5 properties
ChecksV3PlaywrightCheck
object
33 properties 2 required
ChecksV1IcmpAssertionPatch
object
5 properties
ChecksV1TcpRequest
object
7 properties 1 required
ChecksV1BasicAuth
objectnull
2 properties 2 required
ChecksV1AlertSettingsTimeBasedEscalation
object
1 property
ChecksV1CheckType
string
ChecksV1BrowserCheck
object
34 properties 2 required
ChecksV1AlertWebhook
object
5 properties
ProjectBindingDetailsV1
object
The resource's side of this binding.
2 properties 2 required
ChecksV1UrlMonitor
object
35 properties 1 required
BindingProjectV1
object
The project this binding is to.
3 properties 3 required
ChecksV1BrowserCheckUpdate
object
27 properties
ChecksV2ApiCheck
object
35 properties 1 required
ChecksV1GrpcMetadataItem
object
2 properties 2 required
ChecksV1TcpAssertionPatch
object
5 properties
ChecksV2CheckList
array
ChecksV1SslRequestPatch
object
3 properties 1 required
ChecksV3DnsMonitor
object
31 properties 1 required
ChecksV2PlaywrightCheck
object
33 properties 2 required
ChecksV1MultiStepCheck
object
33 properties 2 required
ChecksV1CheckList
array
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
ChecksV1RetryStrategyPatch
objectnull
6 properties 1 required
ChecksV1ApiRequest
object
11 properties 2 required
ChecksV1SslAssertion
object
5 properties 2 required
ChecksV1CheckProject
objectnull
The project that manages this check, or null when the check is not managed by code. When a check has more than one binding, this reports the preferred one.
3 properties
ChecksV1TcpCheckUpdate
object
26 properties
ChecksV1SslRequestRead
object
3 properties 1 required
ChecksV1TcpCheckCreate
object
26 properties 2 required
ChecksV1TcpRequestPatch
object
7 properties 1 required
ChecksV3MultiStepCheck
object
29 properties 2 required
ChecksV3TcpCheck
object
31 properties 1 required
ChecksV1ApiAssertionPatch
object
5 properties
ChecksV1AlertChannels
objectnull
4 properties
ChecksV1RetryStrategy
objectnull
6 properties 1 required
ChecksV1ApiRequestPatch
object
11 properties 2 required
ChecksV3HeartbeatCheck
object
23 properties 1 required
ChecksV3Check
ChecksV3SslMonitor
object
31 properties 1 required
ChecksV3GrpcMonitor
object
31 properties 1 required
ChecksV2UrlMonitor
object
31 properties 1 required
ChecksV2DnsMonitor
object
31 properties 1 required
ChecksV1ApiCheck
object
39 properties 1 required
ChecksV1CheckCreate
object
36 properties 2 required
ChecksV2TcpCheck
object
31 properties 1 required
ChecksV2GenericCheck
object
43 properties 2 required
ChecksV1MultiStepCheckUpdate
object
26 properties
ChecksV1SslAssertionPatch
object
5 properties 2 required
ChecksV1SslRequest
object
3 properties 1 required
ChecksV1UrlAssertion
object
5 properties
ChecksV1KeyValue
object
3 properties 2 required
ChecksV1UrlRequest
object
6 properties 1 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
ChecksV1AlertSettings
objectnull
6 properties
ChecksV1ApiCheckUpdate
object
30 properties
ChecksV1UrlRequestPatch
object
6 properties 1 required
ChecksV2IcmpMonitor
object
31 properties 1 required
ChecksV1GrpcRequestRead
object
7 properties
ChecksV1TriggerIncident
objectnull
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-checks-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly Accounts API
Checkly Alert Channels API
Checkly Analytics API
Checkly Check Alerts API
Checkly Check Groups API
Checkly Check Results API
Checkly Dashboards API
Checkly Heartbeats API
Checkly Incidents API
Checkly Maintenance Windows API
Checkly Private Locations API
Where this information came from

This is an independent, third-party profile of Checkly Checks 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.