Skip to main content

​
Overview

Check groups allow you to organize related checks together and apply shared settings like alert channels, locations, and environment variables. This endpoint returns all check groups in your account.

​
Response Example

{
  "data": [
    {
      "id": "group_123456789",
      "name": "Production API Checks",
      "activated": true,
      "muted": false,
      "tags": ["production", "api"],
      "locations": ["us-east-1", "eu-west-1", "ap-southeast-1"],
      "frequency": 5,
      "environmentVariables": [
        {
          "key": "BASE_URL",
          "value": "https://api.production.com",
          "locked": false
        },
        {
          "key": "API_KEY",
          "value": "***masked***",
          "locked": true
        }
      ],
      "localSetupScript": "// Setup script for all checks in this group\nconsole.log('Setting up API tests');",
      "localTearDownScript": "// Cleanup script\nconsole.log('Cleaning up after tests');",
      "checksCount": 12,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-20T14:45:00.000Z"
    },
    {
      "id": "group_987654321",
      "name": "E-commerce User Flows",
      "activated": true,
      "muted": false,
      "tags": ["ecommerce", "user-flows"],
      "locations": ["us-east-1", "us-west-2"],
      "frequency": 10,
      "environmentVariables": [
        {
          "key": "SHOP_URL",
          "value": "https://shop.example.com",
          "locked": false
        }
      ],
      "checksCount": 8,
      "createdAt": "2024-01-10T08:15:00.000Z",
      "updatedAt": "2024-01-18T16:20:00.000Z"
    }
  ],
  "meta": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 2,
    "limit": 10
  }
}

​
Check Group Benefits

Apply common settings across multiple checks:
  • Alert channels
  • Monitoring locations
  • Environment variables
  • Runtime settings
  • Retry strategies
Group related checks by:
  • Application or service
  • Environment (production, staging)
  • Team ownership
  • Criticality level
  • Testing type
Perform actions on multiple checks simultaneously:
  • Enable/disable all checks in a group
  • Update shared environment variables
  • Change monitoring frequency
  • Modify alert subscriptions
Define common setup and teardown scripts that run before and after each check in the group, reducing code duplication.

​
Additional Examples

curl -X GET "https://api.checklyhq.com/v1/check-groups?tags=production&activated=true" \
  -H "Authorization: Bearer cu_1234567890abcdef" \
  -H "X-Checkly-Account: 550e8400-e29b-41d4-a716-446655440000"

​
Use Cases

Service Monitoring

Group all checks for a specific microservice or application

Environment Separation

Organize checks by environment (prod, staging, dev)

Team Organization

Create groups for different teams or departments

Batch Management

Manage multiple related checks as a single unit
Check groups are essential for organizing and managing checks at scale. They allow you to apply consistent settings across related checks and simplify maintenance operations.