Checkly

Checkly Check sessions API

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

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/check-sessions/trigger Trigger check sessions (v1) · Trigger a new check session #
Ask an LLM
“How do I kick off my checks on demand from CI with the v1 endpoint?”
“Can I trigger only checks matching certain filters using v1?”
Tell an agent
Trigger a v1 check session for checks matching {target}.
Run all eligible checks now via the v1 trigger, refreshing caches {refreshCache}.
GET /v1/check-sessions/{checkSessionId} Get a check session (v1) · Retrieve a check session #
Ask an LLM
“What results has a v1 check session produced so far?”
“Does a v1 check session show a final result per run location?”
Tell an agent
Show v1 check session {checkSessionId}.
Get the current v1 results of check session {checkSessionId}.
POST /v1/check-sessions/{checkSessionId}/cancel Cancel a running check session · Cancel a check session #
Ask an LLM
“How do I stop a Playwright check suite run that's still in progress?”
“Can I cancel only some parallel runs within a check session?”
Tell an agent destructive · confirm first
Cancel check session {checkSessionId}.
Cancel sequences {sequenceId} in check session {checkSessionId}.
GET /v1/check-sessions/{checkSessionId}/completion Wait for a check session to finish (v1) · Await the completion of a check session #
Ask an LLM
“How can my pipeline block until a v1 check session passes or fails?”
“What happens if a v1 check session takes longer than I'm willing to wait?”
Tell an agent
Wait for v1 check session {checkSessionId} to complete.
Await v1 check session {checkSessionId} for up to {maxWaitSeconds} seconds.
POST /v2/check-sessions/trigger Trigger check sessions (v2) · Trigger a new check session #
Ask an LLM
“How do I trigger check sessions with the newer v2 endpoint?”
“Can the v2 trigger refresh the check cache before running?”
Tell an agent
Trigger a v2 check session for checks matching {target}.
Start v2 check sessions for all eligible checks with cache refresh {refreshCache}.
GET /v2/check-sessions/{checkSessionId} Get a check session (v2) · Retrieve a check session #
Ask an LLM
“How do I read a check session's results using the v2 endpoint?”
“Can I see in-progress results for a v2 check session?”
Tell an agent
Show v2 check session {checkSessionId}.
Get the v2 results so far for check session {checkSessionId}.
GET /v2/check-sessions/{checkSessionId}/completion Wait for a check session to finish (v2) · Await the completion of a check session #
Ask an LLM
“Does the v2 completion wait also return when a session is degraded or cancelled?”
“What does the v2 endpoint return if my check session times out while waiting?”
Tell an agent
Wait for v2 check session {checkSessionId} to reach a final state.
Await v2 check session {checkSessionId}, giving up after {maxWaitSeconds} seconds.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-check-sessions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/checkly:checkly-check-sessions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

checkly-check-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkly Public Check sessions API
  version: v1
  description: 'These are the docs for the newly released Checkly Public API.

    If you have any questions, please do not hesitate to get in touch with us.'
servers:
- url: https://api.checklyhq.com
security:
- Bearer: []
tags:


# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-check-sessions-api-openapi.yml