Checkly

Checkly Badges API

The Badges API from Checkly — 2 operation(s) for badges.

GitHub OpenAPI

Operations 2

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/badges/checks/{checkId} Get a status badge for a check · Get V1Badges checks checkid #
Ask an LLM
“How do I embed a live status badge for one check in my README?”
“Can a check badge show response time and a dark theme?”
Tell an agent
Get the status badge for check {checkId}.
Get check {checkId}'s badge in style {style} with theme {theme}.
GET /v1/badges/groups/{groupId} Get a status badge for a check group · Get V1Badges groups groupid #
Ask an LLM
“Can I show one badge for the overall status of a check group?”
“Does a group badge need badges enabled in account settings?”
Tell an agent
Fetch the group-level badge for check group {groupId}.
Get group {groupId}'s badge with response time {responseTime}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-badges-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-badges-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-badges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkly Public Badges 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: Badges
paths:
  /v1/badges/checks/{checkId}:
    get:
      operationId: getV1BadgesChecksCheckid
      description: Get check status badge. You can enable the badges feature in account settings
      tags:
      - Badges
      responses:
        '200':
          description: Successful
          content:
            image/svg+xml:
              schema:
                $ref: '#/components/schemas/BadgeSvgResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
      parameters:
      - schema:
          type: string
          x-format:
            guid: true
        required: true
        name: checkId
        in: path
      - schema:
          $ref: '#/components/schemas/BadgeStyle'
        required: false
        name: style
        in: query
      - schema:
          $ref: '#/components/schemas/BadgeTheme'
        required: false
        name: theme
        in: query
      - schema:
          type: boolean
          default: false
        required: false
        name: responseTime
        in: query
      summary: Get V1Badges checks checkid
      x-summary-source: derived
  /v1/badges/groups/{groupId}:
    get:
      operationId: getV1BadgesGroupsGroupid
      description: Get group status badge. You can enable the badges feature in account settings
      tags:
      - Badges
      responses:
        '200':
          description: Successful
          content:
            image/svg+xml:
              schema:
                $ref: '#/components/schemas/BadgeSvgResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
      parameters:
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: true
        name: groupId
        in: path
      - schema:
          $ref: '#/components/schemas/BadgeStyle'
        required: false
        name: style
        in: query
      - schema:
          $ref: '#/components/schemas/BadgeTheme'
        required: false
        name: theme
        in: query
      - schema:
          type: boolean
          default: false
        required: false
        name: responseTime
        in: query
      summary: Get V1Badges groups groupid
      x-summary-source: derived
components:
  schemas:
    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
    attributes:
      type: object
    BadgeStyle:
      type: string
      enum:
      - flat
      - plastic
      - flat-square
      - for-the-badge
      - social
      default: flat
    BadgeTheme:
      type: string
      enum:
      - light
      - dark
      - default
      default: default
    BadgeSvgResponse:
      type: string
      pattern: (<svg)([^<]*|[^>]*)
      description: An SVG image containing the current Checkly check or group status.
    Model2:
      type: string
      enum:
      - Too Many Requests
    ApiError:
      type: object
      properties:
        statusCode:
          type: number
        error:
          type: string
        message:
          type: string
      required:
      - statusCode
      - error
      - message
  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>'