Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks15

Client certificates4

Dashboards5

Deployment Triggers2

Elements2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors14

Private locations8

Reporting1

Rocky AI3

Runtimes2

Secret scans1

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Status Pages V37

Status Pages V3 Automation Rules5

Status Pages V3 Components5

Status Pages V3 Incidents11

Status Pages V3 Subscribers3

Test Session Error Groups4

Test sessions7

Triggers6

Usage8

Test sessions

Triggers

Trigger a new test session

Changed on Oct 31, 2026

Starts a tests session with checks matching the provided target filters. If no filters are given, matches all eligible checks.

This endpoint does not wait for the test session to complete. Use the GET /v1/test-sessions/{testSessionId}/completion or GET /v1/test-sessions/{testSessionId} endpoints to track progress if needed.

Test sessions do not produce alerts.

Equivalent to the npx checkly trigger command of the Checkly CLI.

post/v1/test-sessions/trigger

Request

Base URL
https://api.checklyhq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v1/test-sessions/trigger/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-checkly-accountstring uuid

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

Request body

namestring required

The name of the test session.

runLocationstring required

A public region code or private location slug name.

refreshCacheboolean

Skip existing caches and install dependencies from scratch.

Response

Created

testSessionIdstring uuid required

testSessionLinkstring uri required

namestring required

status'RUNNING' | 'FAILED' | 'PASSED' | 'CANCELLED' required

errorGroupIdsstring[] required

IDs of the test-session error groups observed in this test session.

startedAtstring date-time required

stoppedAtstring date-time nullable

timeElapsednumber required

Changes

Oct 31, 2026bc90d1bfa738 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Jul 13, 2026a4fea1ad9b9a Revision changes
- warning
  added the new GRPC enum value to the // response property for the response status
- warning
  added the new SSL enum value to the // response property for the response status
- warning
  added the new TRACEROUTE enum value to the // response property for the response status
- info
  added the new optional request property /
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history