Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Test sessions
Triggers

Trigger a new test session

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

Headers

x-checkly-accountstring uuid

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

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