Overview
The Update Check Group endpoint allows you to modify existing check groups, including group settings, shared configurations, and group-level properties that apply to all member checks. Common Use Cases:- Group Configuration Updates
- Shared Settings Modification
- Group Name Changes
- Environment Updates
Authorizations
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
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Path Parameters
Query Parameters
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.
Body
The name of the check group.
"Check group"
Determines if the checks in the group are running or not.
Determines if any notifications will be send out when a check in this group fails and/or recovers.
Tags for organizing and filtering checks.
["production"]An array of one or more data center locations where to run the checks.
["us-east-1", "eu-central-1"]Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
x >= 1{
"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"
}
}The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
2025.04, 2024.09, 2024.02, 2023.09, 2023.02, 2022.10 50[Deprecated] Retry failed check runs. This property is deprecated, and retryStrategy can be used instead.
When true, the account level alert setting will be used, not the alert setting defined on this check group.
Alert settings.
List of alert channel subscriptions.
[]An ID reference to a snippet to use in the setup phase of an API check in this group.
null
An ID reference to a snippet to use in the teardown phase of an API check in this group.
null
A valid piece of Node.js code to run in the setup phase of an API check in this group.
null
A valid piece of Node.js code to run in the teardown phase of an API check in this group.
null
An array of one or more private locations where to run the checks.
["data-center-eu"]When true, the checks in the group will run in parallel in all selected locations.
The strategy to determine how failed checks are retried.
Response
Successful
The name of the check group.
"Check group"
Determines if the checks in the group are running or not.
Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
x >= 11
Determines if any notifications will be send out when a check in this group fails and/or recovers.
Tags for organizing and filtering checks.
["production"]An array of one or more data center locations where to run the checks.
["us-east-1", "eu-central-1"]50[Deprecated] Retry failed check runs. This property is deprecated, and retryStrategy can be used instead.
When true, the account level alert setting will be used, not the alert setting defined on this check group.
Alert settings.
List of alert channel subscriptions.
An ID reference to a snippet to use in the setup phase of an API check in this group.
null
An ID reference to a snippet to use in the teardown phase of an API check in this group.
null
A valid piece of Node.js code to run in the setup phase of an API check in this group.
null
A valid piece of Node.js code to run in the teardown phase of an API check in this group.
null
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
2025.04, 2024.09, 2024.02, 2023.09, 2023.02, 2022.10 null
An array of one or more private locations where to run the check.
["data-center-eu"]The strategy to determine how failed checks are retried.
When true, the checks in the group will run in parallel in all selected locations.