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 Check sessions API

The Check sessions API from Checkly — 7 operation(s) for check sessions.

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

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

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

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

7 operations 7 paths 43 schemas 4 GET3 POST

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 Check sessions 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 7

Across 7 paths, the API surfaces 7 operations — 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Check sessions 7
POST
/v1/check-sessions/triggerdeprecated
Trigger a new check session
postV1ChecksessionsTrigger body → 201401402403404429
GET
/v1/check-sessions/{checkSessionId}deprecated
Retrieve a check session
getV1ChecksessionsChecksessionid 1 param → 200401403404429
POST
/v1/check-sessions/{checkSessionId}/cancel
Cancel a check session
postV1ChecksessionsChecksessionidCancel 2 params body → 204400401403404429
GET
/v1/check-sessions/{checkSessionId}/completiondeprecated
Await the completion of a check session
getV1ChecksessionsChecksessionidCompletion 2 params → 200401403404408429
POST
/v2/check-sessions/trigger
Trigger a new check session
postV2ChecksessionsTrigger 1 param body → 201400401402403404429
GET
/v2/check-sessions/{checkSessionId}
Retrieve a check session
getV2ChecksessionsChecksessionid 2 params → 200400401403404429
GET
/v2/check-sessions/{checkSessionId}/completion
Await the completion of a check session
getV2ChecksessionsChecksessionidCompletion 3 params → 200400401403404408429

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are CheckSessionConciseCheckResult (15 properties), CheckSessionsV2CheckResult (15 properties), FindOneCheckSessionResponse (12 properties), CheckSessionsV2FindOneResponse (12 properties). Each schema is shown below with its type and property counts.

attributes
object
TriggerCheckSessionResponse
object
Returns a check session for each check matching target conditions.
1 property 1 required
Model30
string
The final status of the check session.
TriggerCheckSessionRequestPayload
object
2 properties
CheckSessionsV2FindOneResponse
object
12 properties 11 required
checkId
array
Match checks with the given identifiers.
Model23
array
Model2
string
UnauthorizedError
object
4 properties 2 required
TooManyRequestsError
object
4 properties 2 required
Model24
string
CheckSessionsV1CancelRequest
object
1 property
CheckSessionsV2CheckSession
object
11 properties 10 required
PaymentRequiredError
object
4 properties 2 required
results
array
The results of the check session. Only partial results are available until the check session has completed.
CheckSessionNotFoundErrorResponse
object
No such check session exists.
3 properties 1 required
resultType
stringnull
The type of the result.
Model27
string
The status of the check session.
FindOneCheckSessionResponse
object
The current state of the check session.
12 properties 8 required
Model25
string
The status of the check session.
runLocations
array
The run locations of the check session.
NoMatchingChecksFoundErrorResponse
object
Returned when there are no matching checks.
3 properties 1 required
CheckSessionsV2CompletionResponse
object
12 properties 11 required
sessions
array
A list of check sessions, with one check session for each check.
Model31
array
The results of the check session.
Model26
string
runSource
stringnull
The source that triggered the check session.
CheckSessionsV2CheckResult
object
15 properties 12 required
ForbiddenError
object
3 properties 2 required
Model28
string
ApiError
object
3 properties 3 required
AwaitCheckSessionCompletionTryAgainResponse
object
The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the Retry-After heade…
3 properties 1 required
AwaitCheckSessionCompletionResponse
object
Returned when the check session has finished running.
12 properties 9 required
CheckSession
object
11 properties 8 required
Model3
string
matchTags
array
Match checks with the given tags. Group tags also match. The value is a two-dimensional array. The top level array defines OR conditions, and the second level…
error
string
CheckSessionsV2TriggerRequest
object
2 properties
TriggerCheckSessionTarget
object
2 properties
Model1
string
CheckSessionConciseCheckResult
object
15 properties 11 required
Model29
string
CheckSessionsV2TriggerResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-check-sessions-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 Checks API
Checkly Dashboards API
Checkly Heartbeats API
Checkly Incidents API
Checkly Maintenance Windows API
Where this information came from

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