Checkly

Checkly Error Groups API

The Error Groups API from Checkly — 4 operation(s) for error groups.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/error-groups List error groups across my account · List all error groups in your account #
Ask an LLM
“Which recurring errors are my checks hitting across the whole account?”
“Can I page through all error groups?”
Tell an agent
List all error groups in my account.
Show page {page} of error groups, {limit} per page.
GET /v1/error-groups/checks/{checkId} List error groups for one check · List all error groups for a specific check #
Ask an LLM
“What distinct errors has a specific check been failing with?”
“Can I see error groups for just one check?”
Tell an agent
List error groups for check {checkId}.
Show {limit} error groups of check {checkId}.
GET /v1/error-groups/{id} Get an error group · Retrieve one error group #
Ask an LLM
“What are the details of one error group?”
“Can I look up a single error group by its ID?”
Tell an agent
Show error group {id}.
Get details of error group {id}.
PATCH /v1/error-groups/{id} Archive an error group · Update an error group. Mainly used for archiving error groups #
Ask an LLM
“How do I archive an error group so it stops cluttering my list?”
“Can an archived error group come back when the error happens again?”
Tell an agent
Archive error group {id} forever.
Archive error group {id} until the next event: {archivedUntilNextEvent}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-error-groups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/checkly:checkly-error-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

checkly-error-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkly Public Error Groups 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:
- name: Error Groups
paths:
  /v1/error-groups:
    get:
      summary: List all error groups in your account
      operationId: getV1Errorgroups
      description: List all error groups in your account.
      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
      tags:
      - Error Groups
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorGroupsList'
        '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'
  /v1/error-groups/checks/{checkId}:
    get:
      summary: List all error groups for a specific check
      operationId: getV1ErrorgroupsChecksCheckid
      description: List all error groups for a specific check.
      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: checkId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      - 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
      tags:
      - Error Groups
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorGroupsList'
        '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'
  /v1/error-groups/{id}:
    get:
      summary: Retrieve one error group
      operationId: getV1ErrorgroupsId
      description: Retrieve one error group.
      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: id
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      tags:
      - Error Groups
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorGroup'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
    patch:
      summary: Update an error group. Mainly used for archiving error groups
      operationId: patchV1ErrorgroupsId
      description: Update an error group. Mainly used for archiving error groups.
      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: id
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      tags:
      - Error Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorGroupPatch'
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorGroup'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
components:
  schemas:
    ForbiddenError:
      type: object
      properties:
        statusCode:
          type: number
          enum:
          - 403
        error:
          $ref: '#/components/schemas/Model1'
        message:
          type: string
          example: Forbidden
      required:
      - statusCode
      - error
    NotFoundError:
      type: object
      properties:
        statusCode:
          type: number
          enum:
          - 404
        error:
          $ref: '#/components/schemas/Model4'
        message:
          type: string
          example: Not Found
      required:
      - statusCode
      - error
    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
    attributes:
      type: object
    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
    ErrorGroupPatch:
      type: object
      properties:
        archiveForEver:
          type: boolean
        archivedUntilNextEvent:
          type: boolean
    ErrorGroup:
      type: object
      properties:
        id:
          type: string
        checkId:
          type: string
        errorHash:
          type: string
          description: The hash of the cleaned error message for quicker deduplication.
        rawErrorMessage:
          type:
          - string
          - 'null'
          description: The raw error message as recorded in a check result.
        cleanedErrorMessage:
          type: string
          description: The cleaned and sanitized error message used for hashing and grouping.
        firstSeen:
          type: string
          format: date
        lastSeen:
          type: string
          format: date
        archivedUntilNextEvent:
          type: boolean
        rootCauseAnalyses:
          $ref: '#/components/schemas/rootCauseAnalyses'
      required:
      - id
      - checkId
      - errorHash
      - rawErrorMessage
      - cleanedErrorMessage
      - firstSeen
      - lastSeen
      - archivedUntilNextEvent
    ErrorGroupsList:
      type: array
      items:
        $ref: '#/components/schemas/Model40'
    Model4:
      type: string
      enum:
      - Not Found
    error:
      type: string
      enum:
      - Unauthorized
    Model40:
      type: object
      properties:
        id:
          type: string
        checkId:
          type: string
        errorHash:
          type: string
          description: The hash of the cleaned error message for quicker deduplication.
        rawErrorMessage:
          type:
          - string
          - 'null'
          description: The raw error message as recorded in a check result.
        cleanedErrorMessage:
          type: string
          description: The cleaned and sanitized error message used for hashing and grouping.
        firstSeen:
          type: string
          format: date
        lastSeen:
          type: string
          format: date
        archivedUntilNextEvent:
          type: boolean
        rootCauseAnalyses:
          $ref: '#/components/schemas/rootCauseAnalyses'
      required:
      - id
      - checkId
      - errorHash
      - rawErrorMessage
      - cleanedErrorMessage
      - firstSeen
      - lastSeen
      - archivedUntilNextEvent
    Model2:
      type: string
      enum:
      - Too Many Requests
    Model1:
      type: string
      enum:
      - Forbidden
    rootCauseAnalyses:
      type: array
      items:
        $ref: '#/components/schemas/attributes'
  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 <a href="https://app.checklyhq.com/settings/user/api-keys" target="_blank">here</a>.</br>Your API key is like a password: <br>keep it secure!</br></br>Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.</br></br>For example, set <b>Authorization</b> header while using cURL: <code>curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"</code></br>'