> ## Documentation Index > Fetch the complete documentation index at: https://checklyhq.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List all check groups > 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. ## OpenAPI ````yaml get /v1/check-groups openapi: 3.0.0 info: title: Checkly Public API version: v1 description: >- These are the docs for the newly released Checkly Public API. If you have any questions, please do not hesitate to get in touch with us. servers: - url: https://api.checklyhq.com security: - Bearer: [] tags: [] paths: /v1/check-groups: get: tags: - Check groups summary: List all check groups description: >- 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. operationId: getV1Checkgroups parameters: - name: x-checkly-account in: header schema: type: string description: >- Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general x-format: guid: true description: >- Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general - name: limit in: query schema: type: integer description: Limit the number of results default: 10 minimum: 1 maximum: 100 description: Limit the number of results - name: page in: query schema: type: number description: Page number default: 1 x-constraint: sign: positive description: Page number - name: tag in: query schema: type: array description: >- Filters check groups by tags. Returns check groups that have at least one of the specified tags. x-constraint: single: true items: type: string description: >- Filters check groups by tags. Returns check groups that have at least one of the specified tags. style: form explode: true - name: name in: query schema: type: array description: >- Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names. x-constraint: single: true items: type: string description: >- Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names. style: form explode: true responses: '200': description: Successful content: application/json: schema: $ref: '#/components/schemas/CheckGroupList' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsError' components: schemas: CheckGroupList: type: array items: $ref: '#/components/schemas/CheckGroup' UnauthorizedError: type: object properties: statusCode: type: number enum: - 401 error: $ref: '#/components/schemas/error' message: type: string example: Bad Token attributes: $ref: '#/components/schemas/attributes' required: - statusCode - error ForbiddenError: type: object properties: statusCode: type: number enum: - 403 error: $ref: '#/components/schemas/Model1' message: type: string example: Forbidden required: - statusCode - error TooManyRequestsError: type: object properties: statusCode: type: number enum: - 429 error: $ref: '#/components/schemas/Model2' message: type: string example: Too Many Requests attributes: $ref: '#/components/schemas/attributes' required: - statusCode - error CheckGroup: type: object properties: id: type: number example: 1 name: type: string description: The name of the check group. example: Check group activated: type: boolean description: Determines if the checks in the group are running or not. muted: type: boolean description: >- Determines if any notifications will be send out when a check in this group fails and/or recovers. tags: $ref: '#/components/schemas/CheckGroupTagList' locations: $ref: '#/components/schemas/CheckGroupLocationList' concurrency: type: number description: >- Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API. default: 3 minimum: 1 x-constraint: sign: positive apiCheckDefaults: $ref: '#/components/schemas/CheckGroupAPICheckDefaults' browserCheckDefaults: type: string environmentVariables: $ref: '#/components/schemas/EnvironmentVariableList' doubleCheck: type: boolean description: >- [Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead. useGlobalAlertSettings: type: boolean description: >- When true, the account level alert setting will be used, not the alert setting defined on this check group. nullable: true alertSettings: $ref: '#/components/schemas/CheckGroupAlertSettings' alertChannelSubscriptions: $ref: '#/components/schemas/AlertChannelSubscriptionCreateList' setupSnippetId: type: number description: >- An ID reference to a snippet to use in the setup phase of an API check in this group. example: null nullable: true tearDownSnippetId: type: number description: >- An ID reference to a snippet to use in the teardown phase of an API check in this group. example: null nullable: true localSetupScript: type: string description: >- A valid piece of Node.js code to run in the setup phase of an API check in this group. example: null nullable: true localTearDownScript: type: string description: >- A valid piece of Node.js code to run in the teardown phase of an API check in this group. example: null nullable: true runtimeId: $ref: '#/components/schemas/runtimeId' privateLocations: $ref: '#/components/schemas/privateLocations' retryStrategy: description: Either a retry strategy object or the literal string "FALLBACK". anyOf: - $ref: '#/components/schemas/RetryStrategy' - $ref: '#/components/schemas/FallbackRetryStrategy' created_at: type: string format: date updated_at: type: string nullable: true format: date-time runParallel: type: boolean description: >- When true, the checks in the group will run in parallel in all selected locations. default: false nullable: true required: - name - activated - concurrency - apiCheckDefaults error: type: string enum: - Unauthorized attributes: type: object Model1: type: string enum: - Forbidden Model2: type: string enum: - Too Many Requests CheckGroupTagList: type: array description: Tags for organizing and filtering checks. example: - production items: type: string CheckGroupLocationList: type: array description: An array of one or more data center locations where to run the checks. example: - us-east-1 - eu-central-1 items: $ref: '#/components/schemas/Model39' CheckGroupAPICheckDefaults: type: object properties: url: type: string description: >- The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks. example: https://api.example.com/v1 default: '' nullable: true headers: $ref: '#/components/schemas/HeaderList' queryParameters: $ref: '#/components/schemas/QueryParameterList' assertions: $ref: '#/components/schemas/AssertionList' basicAuth: $ref: '#/components/schemas/BasicAuth' EnvironmentVariableList: type: array nullable: true items: $ref: '#/components/schemas/EnvironmentVariableGet' CheckGroupAlertSettings: type: object description: Alert settings. default: escalationType: RUN_BASED runBasedEscalation: failedRunThreshold: 1 reminders: amount: 0 interval: 5 parallelRunFailureThreshold: enabled: false percentage: 10 properties: escalationType: $ref: '#/components/schemas/escalationType' reminders: $ref: '#/components/schemas/AlertSettingsReminders' sslCertificates: $ref: '#/components/schemas/AlertSettingsSSLCertificates' runBasedEscalation: $ref: '#/components/schemas/AlertSettingsRunBasedEscalation' timeBasedEscalation: $ref: '#/components/schemas/AlertSettingsTimeBasedEscalation' parallelRunFailureThreshold: $ref: '#/components/schemas/parallelRunFailureThreshold' AlertChannelSubscriptionCreateList: type: array description: List of alert channel subscriptions. items: $ref: '#/components/schemas/Model40' runtimeId: type: string description: >- The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group. example: null enum: - '2026.04' - '2025.04' - '2024.09' - '2024.02' - '2023.09' - '2023.02' - '2022.10' nullable: true privateLocations: type: array description: An array of one or more private locations where to run the check. example: - data-center-eu nullable: true items: type: string RetryStrategy: type: object description: The strategy to determine how failed checks are retried. nullable: true properties: type: $ref: '#/components/schemas/RetryStrategyType' baseBackoffSeconds: type: number description: The number of seconds to wait before the first retry attempt. default: 60 sameRegion: type: boolean description: >- Whether retries should be run in the same region as the initial check run. default: true maxRetries: type: number description: >- The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY minimum: 1 maximum: 10 maxDurationSeconds: type: number description: >- The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY minimum: 0 maximum: 600 onlyOn: $ref: '#/components/schemas/RetryOnlyOn' required: - type FallbackRetryStrategy: type: string enum: - FALLBACK Model39: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - ca-central-1 - sa-east-1 - eu-west-1 - eu-central-1 - eu-west-2 - eu-west-3 - eu-north-1 - eu-south-1 - me-south-1 - ap-southeast-1 - ap-northeast-1 - ap-east-1 - ap-southeast-2 - ap-southeast-3 - ap-northeast-2 - ap-northeast-3 - ap-south-1 - af-south-1 HeaderList: type: array example: - key: Cache-Control value: no-store items: $ref: '#/components/schemas/KeyValue' QueryParameterList: type: array example: - key: Page value: '1' items: $ref: '#/components/schemas/KeyValue' AssertionList: type: array description: >- Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field. example: - source: STATUS_CODE comparison: NOT_EMPTY target: '200' items: $ref: '#/components/schemas/Assertion' BasicAuth: type: object nullable: true properties: username: type: string example: admin default: '' password: type: string example: abc12345 default: '' required: - username - password EnvironmentVariableGet: type: object properties: key: type: string description: The key of the environment variable (this value cannot be changed). example: API_KEY value: type: string locked: type: boolean description: Used only in the UI to hide the value like a password. default: false secret: type: boolean description: >- Set an environment variable as secret. Once set, its value cannot be unlocked. default: false required: - key - value escalationType: type: string description: Determines what type of escalation to use. default: RUN_BASED enum: - RUN_BASED - TIME_BASED AlertSettingsReminders: type: object properties: amount: type: number description: How many reminders to send out after the initial alert notification. default: 0 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 100000 interval: type: number description: At what interval the reminders should be send. default: 5 enum: - 1 - 2 - 3 - 4 - 5 - 10 - 15 - 30 AlertSettingsSSLCertificates: type: object description: >- [DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version. properties: enabled: type: boolean description: >- Determines if alert notifications should be send for expiring SSL certificates. alertThreshold: type: integer description: At what moment in time to start alerting on SSL certificates. AlertSettingsRunBasedEscalation: type: object properties: failedRunThreshold: type: number description: >- After how many failed consecutive check runs an alert notification should be send. enum: - 1 - 2 - 3 - 4 - 5 AlertSettingsTimeBasedEscalation: type: object properties: minutesFailingThreshold: type: number description: >- After how many minutes after a check starts failing an alert should be send. enum: - 5 - 10 - 15 - 30 parallelRunFailureThreshold: type: object properties: enabled: type: boolean description: Determines if parallel run threshold is enabled default: false percentage: type: number description: >- The percentage of parallel runs that should fail before an alert is triggered default: 10 enum: - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 80 - 90 - 100 Model40: type: object description: Alert channel subscription. properties: alertChannelId: type: number activated: type: boolean default: true required: - alertChannelId - activated RetryStrategyType: type: string description: Determines which type of retry strategy to use. enum: - FIXED - LINEAR - EXPONENTIAL - SINGLE_RETRY RetryOnlyOn: type: array x-constraint: length: 1 unique: true single: true items: $ref: '#/components/schemas/RetryOnlyOnValue' KeyValue: type: object properties: key: type: string value: type: string default: '' locked: type: boolean default: false required: - key - value Assertion: type: object properties: source: $ref: '#/components/schemas/AssertionSource' comparison: $ref: '#/components/schemas/AssertionComparison' property: type: string default: '' target: type: string default: '' regex: type: string default: '' nullable: true RetryOnlyOnValue: type: string description: >- The HTTP request could not be completed due to a network error: no response status code was received enum: - NETWORK_ERROR AssertionSource: type: string enum: - STATUS_CODE - JSON_BODY - HEADERS - TEXT_BODY - RESPONSE_TIME AssertionComparison: type: string enum: - EQUALS - NOT_EQUALS - HAS_KEY - NOT_HAS_KEY - HAS_VALUE - NOT_HAS_VALUE - IS_EMPTY - NOT_EMPTY - GREATER_THAN - LESS_THAN - CONTAINS - NOT_CONTAINS - IS_NULL - NOT_NULL securitySchemes: Bearer: type: http scheme: bearer bearerFormat: Bearer description: >- The Checkly Public API uses API keys to authenticate requests. You can get the API Key [here](https://app.checklyhq.com/settings/user/api-keys). 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]"` ````