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 /v2/check-sessions/{checkSessionId}/completion or GET /v2/check-sessions/{checkSessionId} endpoints to track progress.

Use POST /v1/check-sessions/{checkSessionId}/cancel to cancel an in-progress check session.

Standard alerting rules apply to finished check runs.

Equivalent to the Schedule Now button in the UI.

POST /v2/check-sessions/trigger

Trigger a new check session

cURL

curl --request POST \
  --url https://api.checklyhq.com/v2/check-sessions/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": {
    "matchTags": [
      [
        "<string>"
      ]
    ],
    "checkId": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "refreshCache": false
}
'

201

{
  "sessions": [
    {
      "checkSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "checkSessionLink": "<string>",
      "checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startedAt": "2023-11-07T05:31:56Z",
      "stoppedAt": "2023-11-07T05:31:56Z",
      "timeElapsed": 123,
      "runLocations": [
        "<string>"
      ],
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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 to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string<uuid>

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

Body

application/json

target · object

Optional filters selecting which checks to trigger.

Show child attributes

refreshCache · boolean · default: false

Refresh the selected checks cache before triggering the sessions.

Response

201

application/json

Created

sessions · object[] · required

Show child attributes