Canonical

Canonical Services API

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

Documentation GitHub OpenAPI

Operations 2

GET /v1/services List services #

POST /v1/services Manage services #

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-services-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

openapi: 3.2.0
info:
  title: Pebble Services API
  version: v1
tags:
- name: Services
paths:
  /v1/services:
    get:
      summary: List services
      description: Fetch information about specific services (or all of them), ordered by service name.
      tags:
      - Services
      parameters:
      - in: query
        name: names
        description: The names of the services to get. To get multiple services, specify this parameter multiple times. If not set, get all services.
        schema:
          type: string
      responses:
        '200':
          description: List services.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServicesResponse'
              example:
                type: sync
                status-code: 200
                status: OK
                result:
                - name: svc1
                  startup: enabled
                  current: active
                  current-since: '2024-12-27T12:19:27.569602108+08:00'
                - name: svc2
                  startup: enabled
                  current: active
                  current-since: '2024-12-27T12:19:27.5690974+08:00'
      operationId: getV1Services
      x-operation-id-source: derived
    post:
      summary: Manage services
      description: Perform a service operation such as start, stop, or replan.
      tags:
      - Services
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  description: The action to perform.
                  enum:
                  - autostart
                  - replan
                  - restart
                  - start
                  - stop
                services:
                  type: array
                  description: 'A list of service names.  Required for "start", "stop", and "restart".


                    Ignored for "replan" and "autostart" (resolved automatically for "autostart" to default services).

                    '
                  items:
                    type: string
            example:
              action: start
              services:
              - svc1
      responses:
        '202':
          description: Accepted - asynchronous operation started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostServicesResponse'
              example:
                type: async
                status-code: 202
                status: Accepted
                change: '29'
                result: null
      operationId: postV1Services
      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).

            '
    GetServicesResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/serviceInfo'
    BaseAsyncResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          change:
            type: string
            description: The Change ID of the asynchronous change.
    serviceInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the service.
        startup:
          type: string
          description: Configured startup value.
          enum:
          - disabled
          - enabled
        current:
          type: string
          description: Current status of the service.
          enum:
          - active
          - backup
          - error
          - inactive
        current-since:
          type: string
          format: date-time
          description: '[Time](#time) the service transitioned to the current status.'
    PostServicesResponse:
      allOf:
      - $ref: '#/components/schemas/BaseAsyncResponse'
      - type: object
        properties:
          result:
            type: 'null'