v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Check sessions

Triggers

Trigger a new check session

Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.

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

Standard alerting rules apply to finished check runs.

Equivalent to the Schedule Now button in the UI.

post/v1/check-sessions/trigger

Request body

refreshCacheboolean

If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.

Example request

{
  "target": {
    "matchTags": [
      [
        "production",
        "!skip-e2e"
      ]
    ],
    "checkId": [
      "a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"
    ]
  }
}

Response

Returns a check session for each check matching target conditions.

Example response

{
  "sessions": [
    {
      "checkSessionId": "8166fa86-c9b4-4162-8541-d380c6c212d8",
      "checkSessionLink": "https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8",
      "checkId": "a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a",
      "checkType": "API",
      "name": "Example API Check",
      "status": "PASSED",
      "startedAt": "2025-08-28T18:23:40.262Z",
      "stoppedAt": "2025-08-28T18:28:40.993Z",
      "timeElapsed": 300731,
      "runLocations": [
        "us-east-1",
        "eu-central-1"
      ],
      "runSource": "TRIGGER_API"
    }
  ]
}