CHchecklyhq
Check groups

List all check groups

Changed on

Lists all current check groups in your account. The "checks" property is an array of check UUID's for convenient referencing. It is read only and you cannot use it to add checks to a group.

get/v1/check-groups

Request

Query parameters

limitinteger

Limit the number of results

pagenumber

Page number

tagstring[]

Filters check groups by tags. Returns check groups that have at least one of the specified tags.

namestring[]

Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names.

Headers

x-checkly-accountstring

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.

locationsModel7[]

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"
    ],
    "projectBindings": {
      "owner": {
        "binding": {
          "logicalId": "homepage-check",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      },
      "references": [
        {
          "binding": {
            "logicalId": "homepage-check",
            "sourceFile": "src/__checks__/homepage.check.ts"
          }
        }
      ]
    }
  }
]

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

  • aba5d34c749bRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status