Canonical Status Service API

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

Documentation 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 /api/v0/status Check service status · Status service get status #

Ask an LLM

“Is the service up and healthy right now?”

“Can I get a health status check from the API?”

Tell an agent

Check the service status.

Report whether the API is healthy.

GET /api/v0/version Get the running service version · Status service get version #

Ask an LLM

“Which version of the service is deployed?”

“Can I find out what build the API is running?”

Tell an agent

Show the service version.

Tell me which release of the API is running.

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-statusservice-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:
  contact:
    name: Identity Platform API
    url: https://github.com/canonical/identity-platform-api
  description: REST API for the Admin UI service
  license:
    name: AGPL-3.0
    url: https://github.com/canonical/identity-platform-api/blob/main/LICENSE
  title: Identity Platform Status Service API
  version: '0.1'
tags:
- name: StatusService
paths:
  /api/v0/status:
    get:
      operationId: StatusService_GetStatus
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apistatusStatus'
          description: ''
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - StatusService
      summary: Status service get status
      x-summary-source: derived
  /api/v0/version:
    get:
      operationId: StatusService_GetVersion
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusBuildInfo'
          description: ''
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - StatusService
      summary: Status service get version
      x-summary-source: derived
components:
  schemas:
    apistatusStatus:
      properties:
        buildInfo:
          $ref: '#/components/schemas/statusBuildInfo'
        status:
          type: string
      type: object
    statusBuildInfo:
      properties:
        commit_hash:
          type: string
        name:
          type: string
        version:
          type: string
      type: object
    typesErrorResponse:
      properties:
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://example.com/oauth/authorize
          scopes:
            email: ''
            openid: ''
            profile: ''
          tokenUrl: https://example.com/oauth/token
      type: oauth2
externalDocs:
  description: REST API for the Admin UI service
  url: https://github.com/canonical/identity-platform-admin-ui/blob/main/API.md