Checkly

Checkly Status Pages V3 Components API

The Status Pages V3 Components API from Checkly — 5 operation(s) for status pages v3 components.

GitHub OpenAPI

Operations 5

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 /v3/status-pages/{statusPageId}/components List components on a v3 status page · List the components of a v3 status page #
Ask an LLM
“Which components appear on my status page and in what order?”
“Can I page through a status page's components?”
Tell an agent
List the components of status page {statusPageId}.
Show components of status page {statusPageId} after {nextId}.
POST /v3/status-pages/{statusPageId}/components Add a component to a v3 status page · Create a component on a v3 status page #
Ask an LLM
“How do I add a service or group component to my status page?”
“Can I nest a component under a group on my status page?”
Tell an agent
Add component {name} at position {displayOrder} to status page {statusPageId}.
Add {type} component {name} at position {displayOrder} on status page {statusPageId} under group {parentId}.
DELETE /v3/status-pages/{statusPageId}/components/{componentId} Delete a v3 status page component · Delete a component of a v3 status page #
Ask an LLM
“What happens to child components when I delete a group component?”
“How do I remove a component from my status page?”
Tell an agent destructive · confirm first
Delete component {componentId} from status page {statusPageId}.
Remove status page {statusPageId} component {componentId}.
GET /v3/status-pages/{statusPageId}/components/{componentId} Get a v3 status page component · Retrieve a single component of a v3 status page #
Ask an LLM
“What are the settings of one component on my status page?”
“Is a particular status page component hidden?”
Tell an agent
Show component {componentId} on status page {statusPageId}.
Get status page {statusPageId} component {componentId}.
PUT /v3/status-pages/{statusPageId}/components/{componentId} Replace a v3 status page component · Update a component of a v3 status page #
Ask an LLM
“Will fields I omit be reset when I update a status page component?”
“How do I reorder or hide a component on my status page?”
Tell an agent
Update component {componentId} on status page {statusPageId} to name {name} at position {displayOrder}.
Hide component {componentId} ({name}, position {displayOrder}) on status page {statusPageId}: set hidden to {hidden}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-status-pages-v3-components-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-status-pages-v3-components-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-status-pages-v3-components-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkly Public Status Pages V3 Components 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: Status Pages V3 Components
paths:
  /v3/status-pages/{statusPageId}/components:
    get:
      summary: List the components of a v3 status page
      operationId: listStatusPageV3ComponentsPublic
      description: List the components of a v3 status page in display order.
      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: statusPageId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      - name: limit
        in: query
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 100
      - name: nextId
        in: query
        schema:
          type: string
      tags:
      - Status Pages V3 Components
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStatusPageV3ComponentsPaginatedResponse'
        '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'
    post:
      summary: Create a component on a v3 status page
      operationId: createStatusPageV3ComponentPublic
      description: Add a SERVICE or GROUP component to a v3 status page. Nest it under a GROUP via parentId.
      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: statusPageId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      tags:
      - Status Pages V3 Components
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicStatusPageV3ComponentMutation'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStatusPageV3Component'
        '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'
  /v3/status-pages/{statusPageId}/components/{componentId}:
    delete:
      summary: Delete a component of a v3 status page
      operationId: deleteStatusPageV3ComponentPublic
      description: Delete a component. Child components are detached from it, not deleted.
      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: statusPageId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      - name: componentId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      tags:
      - Status Pages V3 Components
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: string
        '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'
    get:
      summary: Retrieve a single component of a v3 status page
      operationId: getStatusPageV3ComponentPublic
      description: Get a single component of a v3 status page.
      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: statusPageId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      - name: componentId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      tags:
      - Status Pages V3 Components
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStatusPageV3Component'
        '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'
    put:
      summary: Update a component of a v3 status page
      operationId: updateStatusPageV3ComponentPublic
      description: 'Update a component. This is a full replacement: omitted optional fields are reset.'
      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: statusPageId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      - name: componentId
        in: path
        schema:
          type: string
          x-format:
            guid: true
        required: true
      tags:
      - Status Pages V3 Components
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicStatusPageV3ComponentMutation'
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStatusPageV3Component'
        '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
    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
    PublicStatusPageV3ComponentsPaginatedResponse:
      type: object
      properties:
        length:
          type: integer
        entries:
          $ref: '#/components/schemas/PublicStatusPageV3ComponentsEntries'
        nextId:
          type:
          - string
          - 'null'
      required:
      - length
      - entries
    PublicStatusPageV3Component:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Model90'
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        displayOrder:
          type: integer
        hidden:
          type: boolean
        parentId:
          type:
          - string
          - 'null'
          description: The GROUP component this component sits under. Must belong to the same status page.
          x-format:
            guid: true
        id:
          type: string
          x-format:
            guid: true
        statusPageId:
          type: string
          x-format:
            guid: true
        created_at:
          type: string
          format: date
        updated_at:
          type:
          - string
          - 'null'
          format: date
      required:
      - name
      - displayOrder
      - id
      - statusPageId
      - created_at
    Model4:
      type: string
      enum:
      - Not Found
    error:
      type: string
      enum:
      - Unauthorized
    Model90:
      type: string
      default: SERVICE
      enum:
      - SERVICE
      - GROUP
    Model1:
      type: string
      enum:
      - Forbidden
    Model2:
      type: string
      enum:
      - Too Many Requests
    PublicStatusPageV3ComponentMutation:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Model91'
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        displayOrder:
          type: integer
        hidden:
          type: boolean
        parentId:
          type:
          - string
          - 'null'
          description: The GROUP component this component sits under. Must belong to the same status page.
          x-format:
            guid: true
      required:
      - name
      - displayOrder
    Model91:
      type: string
      default: SERVICE
      enum:
      - SERVICE
      - GROUP
    PublicStatusPageV3ComponentsEntries:
      type: array
      items:
        $ref: '#/components/schemas/PublicStatusPageV3Component'
  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>'