Canonical Plan API

The plan API from Canonical — 1 operation(s) for plan.

Documentation GitHub OpenAPI

Operations 1

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/plan Get the current plan · Get the current plan #

Ask an LLM

“What does the combined Pebble plan currently look like?”

“Can I export the active plan as YAML?”

Tell an agent

Show the current plan in format {format}.

Get the plan as {format}.

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-plan-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 Plan API
  version: v1
tags:
- name: Plan
paths:
  /v1/plan:
    get:
      summary: Get the current plan
      tags:
      - Plan
      description: Get the plan in YAML format.
      parameters:
      - name: format
        in: query
        description: The format of the plan.
        schema:
          type: string
          enum:
          - yaml
        required: true
      responses:
        '200':
          description: The current plan in YAML format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlanResponse'
              example:
                type: sync
                status-code: 200
                status: OK
                result: "services:\n    svc1:\n        startup: enabled\n        override: replace\n        command: foo\n"
      operationId: getV1Plan
      x-operation-id-source: derived
components:
  schemas:
    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).

            '
    GetPlanResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          result:
            type: string

Canonical Plan API

Operations 1

Documentation

Specifications

Schemas & Data

Other Resources