Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Check groups

Retrieve a check group

Show details of a specific check group

get/v1/check-groups/{id}

Path parameters

idinteger required

Headers

x-checkly-accountstring

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

Response

Successful

idnumber
namestring required

The name of the check group.

activatedboolean required

Determines if the checks in the group are running or not.

mutedboolean

Determines if any notifications will be send out when a check in this group fails and/or recovers.

tagsstring[]

Tags for organizing and filtering checks.

locationsModel41[]

An array of one or more data center locations where to run the checks.

concurrencynumber required

Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.

browserCheckDefaultsstring
doubleCheckboolean

[Deprecated] Retry failed check runs. This property is deprecated, and retryStrategy can be used instead.

useGlobalAlertSettingsboolean nullable

When true, the account level alert setting will be used, not the alert setting defined on this check group.

setupSnippetIdnumber nullable

An ID reference to a snippet to use in the setup phase of an API check in this group.

tearDownSnippetIdnumber nullable

An ID reference to a snippet to use in the teardown phase of an API check in this group.

localSetupScriptstring nullable

A valid piece of Node.js code to run in the setup phase of an API check in this group.

localTearDownScriptstring nullable

A valid piece of Node.js code to run in the teardown phase of an API check in this group.

runtimeId'2026.04' | '2025.04' | '2024.09' | '2024.02' | '2023.09' | '2023.02' | '2022.10' nullable

The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.

privateLocationsstring[] nullable

An array of one or more private locations where to run the check.

created_atstring date
updated_atstring date-time nullable
runParallelboolean nullable

When true, the checks in the group will run in parallel in all selected locations.

Example response

{
  "id": 1,
  "name": "Check group",
  "tags": [
    "production"
  ],
  "locations": [
    "us-east-1",
    "eu-central-1"
  ],
  "apiCheckDefaults": {
    "url": "https://api.example.com/v1",
    "headers": [
      {
        "key": "Cache-Control",
        "value": "no-store"
      }
    ],
    "queryParameters": [
      {
        "key": "Page",
        "value": "1"
      }
    ],
    "assertions": [
      {
        "source": "STATUS_CODE",
        "comparison": "NOT_EMPTY",
        "target": "200"
      }
    ],
    "basicAuth": {
      "username": "admin",
      "password": "abc12345"
    }
  },
  "environmentVariables": [
    {
      "key": "API_KEY"
    }
  ],
  "privateLocations": [
    "data-center-eu"
  ]
}