Canonical Checks API

The checks API from Canonical — 2 operation(s) for checks.

Documentation GitHub OpenAPI

Operations 3

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/checks List health checks · Get checks #

Ask an LLM

“Which Pebble health checks are failing right now?”

“Can I see only the alive-level or ready-level checks?”

Tell an agent

List checks at level {level}.

Show the details of checks {names}.

POST /v1/checks Start or stop health checks · Manage checks #

Ask an LLM

“How do I stop a health check from running?”

“Can I start several checks in one request?”

Tell an agent

Run action {action} on checks {checks}.

Stop checks {checks}.

POST /v1/checks/refresh Run a health check immediately · Refresh a check #

Ask an LLM

“Can I force a check to run now instead of waiting for its period?”

“What does refreshing a single check return?”

Tell an agent

Refresh check {name} now.

Run the {name} check immediately and show the result.

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/canonical:canonical-checks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Pebble Checks API
  version: v1
tags:
- name: Checks
paths:
  /v1/checks:
    get:
      summary: Get checks
      tags:
      - Checks
      description: Fetch information about specific health checks (or all of them), ordered by check name.
      parameters:
      - name: level
        in: query
        description: Filter checks by level. If omitted, aggregate healthy status of checks with any (or no) level.
        schema:
          type: string
          enum:
          - alive
          - ready
      - name: names
        in: query
        description: The names of the checks to get. To get multiple checks, specify this parameter multiple times. If not set, get all checks.
        schema:
          type: string
      responses:
        '200':
          description: Information about health checks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChecksResponse'
              example:
                type: sync
                status-code: 200
                status: OK
                result:
                - name: check1
                  status: up
                  threshold: 3
                  change-id: '37'
                  prev-change-id: '23'
      operationId: getV1Checks
      x-operation-id-source: derived
    post:
      summary: Manage checks
      description: Perform a check operation such as start or stop.
      tags:
      - Checks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  description: The action to perform.
                  enum:
                  - start
                  - stop
                checks:
                  type: array
                  description: 'A list of service names.  Required.

                    '
                  items:
                    type: string
            example:
              action: start
              checks:
              - svc1
      responses:
        '200':
          description: Check operations completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckActionResponse'
              example:
                type: sync
                status-code: 200
                result:
                  changed:
                  - chk1
                  - chk2
      operationId: postV1Checks
      x-operation-id-source: derived
  /v1/checks/refresh:
    post:
      summary: Refresh a check
      description: Runs a specified check immediately.
      tags:
      - Checks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the check to refresh.
              required:
              - name
            example:
              name: chk1
      responses:
        '200':
          description: Check refreshed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshCheckResponse'
              example:
                type: sync
                status-code: 200
                status: OK
                result:
                  info:
                    name: check1
                    startup: enabled
                    status: up
                    successes: 2
                    failures: 1
                    threshold: 3
                    change-id: '1'
                  error: check timed out after 1s
      operationId: postV1ChecksRefresh
      x-operation-id-source: derived
components:
  schemas:
    CheckActionResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          result:
            type: object
            properties:
              changed:
                type: array
                items:
                  type: string
                description: List of checks that were changed.
    checkInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the check.
        level:
          type: string
          description: Level of the check.
          enum:
          - alive
          - ready
        status:
          type: string
          description: Status of the check.
          enum:
          - inactive
          - down
          - up
        successes:
          type: integer
          description: Number of successes since check started or status transitioned from "down" to "up".
        failures:
          type: integer
          description: Number of consecutive failures.
        threshold:
          type: integer
          description: Failure threshold.
        change-id:
          type: string
          description: ID of the change associated with the check.
        prev-change-id:
          type: string
          description: ID of the previous change associated with the check.
    BaseResponse:
      type: object
      properties:
        type:
          type: string
          description: Response type, "sync".
        status-code:
          type: integer
          description: HTTP response status code.
        status:
          type: string
          description: 'The description of the HTTP status code.


            See the [IANA list](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).

            '
    RefreshCheckResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          result:
            type: object
            properties:
              info:
                $ref: '#/components/schemas/checkInfo'
                type: object
              error:
                type: string
                description: The error message if the check failed; empty string on success.
    GetChecksResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/checkInfo'

Canonical Checks API

Operations 3

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification