Canonical

Canonical Certification API

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

GitHub OpenAPI

Operations 1

POST /v1/certification/status Check Certification #

Documentation

📖
Documentation
https://snapcraft.io/docs/reference/development/snapd-rest-api/
📖
Documentation
https://ubuntu.com/landscape/docs
📖
APIReference
https://documentation.ubuntu.com/landscape/reference/api/
📖
Documentation
https://documentation.ubuntu.com/lxd/latest/rest-api/
📖
APIReference
https://documentation.ubuntu.com/lxd/latest/api-extensions/
📖
Documentation
https://ubuntu.com/security/api/docs
📖
APIReference
https://ubuntu.com/security/api/spec.json
📖
Documentation
https://documentation.ubuntu.com/pebble/
📖
Documentation
https://canonical-testflinger.readthedocs-hosted.com/en/latest/
📖
Documentation
https://documentation.ubuntu.com/anbox-cloud/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-certification-api-openapi.yml

Other Resources

🔗
HowTo
https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
🔗
ReleaseNotes
https://documentation.ubuntu.com/landscape/reference/release-notes/
🔗
Portal
https://ubuntu.com/landscape
🔗
SourceCode
https://github.com/canonical/lxd
🔗
Portal
https://canonical.com/lxd
🔗
Portal
https://ubuntu.com/security
🔗
SourceCode
https://github.com/canonical/pebble
🔗
SourceCode
https://github.com/canonical/testflinger
🔗
SourceCode
https://github.com/canonical/hardware-api
🔗
Portal
https://ubuntu.com/certified
🔗
SourceCode
https://github.com/canonical/identity-platform-api
🔗
SourceCode
https://github.com/canonical/test_observer
🔗
Portal
https://canonical.com/anbox-cloud
🔗
SourceCode
https://github.com/canonical/cos-registration-server

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

canonical-certification-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Hardware API (hwapi) Certification API
  description: API server for working with hardware information from C3
  version: 1.0.0
tags:
- name: Certification
paths:
  /v1/certification/status:
    post:
      tags:
      - Certification
      summary: Check Certification
      description: 'Endpoint for checking certification status (whether a system is certified, not seen

        or some of its components have been seen on other systems)'
      operationId: check_certification_v1_certification_status_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificationStatusRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/CertifiedResponse'
                - $ref: '#/components/schemas/NotCertifiedResponse'
                - $ref: '#/components/schemas/RelatedCertifiedSystemExistsResponse'
                - $ref: '#/components/schemas/CertifiedImageExistsResponse'
                title: Response Check Certification V1 Certification Status Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NetworkAdapterValidator:
      properties:
        bus:
          type: string
          title: Bus
        identifier:
          type: string
          title: Identifier
        model:
          type: string
          title: Model
        vendor:
          type: string
          title: Vendor
        capacity:
          type: integer
          title: Capacity
      type: object
      required:
      - bus
      - identifier
      - model
      - vendor
      - capacity
      title: NetworkAdapterValidator
      description: Validator for ethernet network adapters
    WirelessAdapterValidator:
      properties:
        status:
          anyOf:
          - $ref: '#/components/schemas/DeviceStatus'
          - type: 'null'
        model:
          type: string
          title: Model
        vendor:
          type: string
          title: Vendor
        identifier:
          type: string
          title: Identifier
      type: object
      required:
      - model
      - vendor
      - identifier
      title: WirelessAdapterValidator
      description: Validator model for wireless network adapters
    VideoCaptureValidator:
      properties:
        status:
          anyOf:
          - $ref: '#/components/schemas/DeviceStatus'
          - type: 'null'
        model:
          type: string
          title: Model
        vendor:
          type: string
          title: Vendor
        identifier:
          type: string
          title: Identifier
      type: object
      required:
      - model
      - vendor
      - identifier
      title: VideoCaptureValidator
      description: Validator model for video capture devices
    BoardValidator:
      properties:
        manufacturer:
          type: string
          title: Manufacturer
        product_name:
          type: string
          title: Product Name
        version:
          type: string
          title: Version
      type: object
      required:
      - manufacturer
      - product_name
      - version
      title: BoardValidator
    ChassisValidator:
      properties:
        chassis_type:
          type: string
          title: Chassis Type
        manufacturer:
          type: string
          title: Manufacturer
        sku:
          type: string
          title: Sku
        version:
          type: string
          title: Version
      type: object
      required:
      - chassis_type
      - manufacturer
      - sku
      - version
      title: ChassisValidator
    BiosValidator:
      properties:
        vendor:
          type: string
          title: Vendor
        version:
          type: string
          title: Version
        revision:
          anyOf:
          - type: string
          - type: 'null'
          title: Revision
        firmware_revision:
          anyOf:
          - type: string
          - type: 'null'
          title: Firmware Revision
        release_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Release Date
      type: object
      required:
      - vendor
      - version
      - revision
      - firmware_revision
      - release_date
      title: BiosValidator
    USBPeripheralValidator:
      properties:
        status:
          anyOf:
          - $ref: '#/components/schemas/DeviceStatus'
          - type: 'null'
        usb_id:
          type: string
          title: Usb Id
        name:
          type: string
          title: Name
        vendor:
          type: string
          title: Vendor
      type: object
      required:
      - usb_id
      - name
      - vendor
      title: USBPeripheralValidator
    KernelPackageValidator:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        version:
          type: string
          title: Version
        signature:
          anyOf:
          - type: string
          - type: 'null'
          title: Signature
        loaded_modules:
          items:
            type: string
          type: array
          title: Loaded Modules
          default: []
      type: object
      required:
      - name
      - version
      - signature
      title: KernelPackageValidator
    OSValidator:
      properties:
        distributor:
          type: string
          title: Distributor
        version:
          type: string
          title: Version
        codename:
          type: string
          title: Codename
        kernel:
          $ref: '#/components/schemas/KernelPackageValidator'
      type: object
      required:
      - distributor
      - version
      - codename
      - kernel
      title: OSValidator
    RelatedCertifiedSystemExistsResponse:
      properties:
        status:
          type: string
          const: Related Certified System Exists
          title: Status
          default: Related Certified System Exists
        certified_url:
          type: string
          title: Certified URL
        architecture:
          type: string
          title: Architecture
        board:
          anyOf:
          - $ref: '#/components/schemas/BoardValidator'
          - type: 'null'
        bios:
          anyOf:
          - $ref: '#/components/schemas/BiosValidator'
          - type: 'null'
        chassis:
          anyOf:
          - $ref: '#/components/schemas/ChassisValidator'
          - type: 'null'
        gpu:
          anyOf:
          - items:
              $ref: '#/components/schemas/GPUValidator'
            type: array
          - type: 'null'
          title: Gpu
        audio:
          anyOf:
          - items:
              $ref: '#/components/schemas/AudioValidator'
            type: array
          - type: 'null'
          title: Audio
        video:
          anyOf:
          - items:
              $ref: '#/components/schemas/VideoCaptureValidator'
            type: array
          - type: 'null'
          title: Video
        network:
          anyOf:
          - items:
              $ref: '#/components/schemas/NetworkAdapterValidator'
            type: array
          - type: 'null'
          title: Network
        wireless:
          anyOf:
          - items:
              $ref: '#/components/schemas/WirelessAdapterValidator'
            type: array
          - type: 'null'
          title: Wireless
        pci_peripherals:
          items:
            $ref: '#/components/schemas/PCIPeripheralValidator'
          type: array
          title: Pci Peripherals
          default: []
        usb_peripherals:
          items:
            $ref: '#/components/schemas/USBPeripheralValidator'
          type: array
          title: Usb Peripherals
          default: []
        available_releases:
          items:
            $ref: '#/components/schemas/OSValidator'
          type: array
          title: Available Releases
      type: object
      required:
      - certified_url
      - architecture
      - board
      - bios
      - available_releases
      title: RelatedCertifiedSystemExistsResponse
    ProcessorValidator:
      properties:
        identifier:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Identifier
        frequency:
          type: integer
          title: Frequency
        manufacturer:
          type: string
          title: Manufacturer
        version:
          type: string
          title: Version
      type: object
      required:
      - identifier
      - frequency
      - manufacturer
      - version
      title: ProcessorValidator
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CertifiedResponse:
      properties:
        status:
          type: string
          const: Certified
          title: Status
          default: Certified
        certified_url:
          type: string
          title: Certified URL
        architecture:
          type: string
          title: Architecture
        bios:
          anyOf:
          - $ref: '#/components/schemas/BiosValidator'
          - type: 'null'
        board:
          anyOf:
          - $ref: '#/components/schemas/BoardValidator'
          - type: 'null'
        chassis:
          anyOf:
          - $ref: '#/components/schemas/ChassisValidator'
          - type: 'null'
        available_releases:
          items:
            $ref: '#/components/schemas/OSValidator'
          type: array
          title: Available Releases
      type: object
      required:
      - certified_url
      - architecture
      - bios
      - board
      - available_releases
      title: CertifiedResponse
    CertificationStatusRequest:
      properties:
        vendor:
          type: string
          title: Vendor
        model:
          type: string
          title: Model
        architecture:
          type: string
          title: Architecture
        board:
          $ref: '#/components/schemas/BoardValidator'
        os:
          $ref: '#/components/schemas/OSValidator'
        bios:
          anyOf:
          - $ref: '#/components/schemas/BiosValidator'
          - type: 'null'
        chassis:
          anyOf:
          - $ref: '#/components/schemas/ChassisValidator'
          - type: 'null'
        processor:
          $ref: '#/components/schemas/ProcessorValidator'
        pci_peripherals:
          items:
            $ref: '#/components/schemas/PCIPeripheralValidator'
          type: array
          title: Pci Peripherals
          default: []
        usb_peripherals:
          items:
            $ref: '#/components/schemas/USBPeripheralValidator'
          type: array
          title: Usb Peripherals
          default: []
      type: object
      required:
      - vendor
      - model
      - architecture
      - board
      - os
      - processor
      title: CertificationStatusRequest
      description: Request body validator for status check endpoint
    GPUValidator:
      properties:
        status:
          anyOf:
          - $ref: '#/components/schemas/DeviceStatus'
          - type: 'null'
        codename:
          anyOf:
          - type: string
          - type: 'null'
          title: Codename
        manufacturer:
          type: string
          title: Manufacturer
        version:
          type: string
          title: Version
        identifier:
          type: string
          title: Identifier
      type: object
      required:
      - manufacturer
      - version
      - identifier
      title: GPUValidator
    DeviceStatus:
      type: string
      enum:
      - known-working
      - known-breaking
      - unknown
      title: DeviceStatus
    NotCertifiedResponse:
      properties:
        status:
          type: string
          const: Not Seen
          title: Status
          default: Not Seen
      type: object
      title: NotCertifiedResponse
    CertifiedImageExistsResponse:
      properties:
        status:
          type: string
          const: Certified Image Exists
          title: Status
          default: Certified Image Exists
        certified_url:
          type: string
          title: Certified URL
        architecture:
          type: string
          title: Architecture
        bios:
          anyOf:
          - $ref: '#/components/schemas/BiosValidator'
          - type: 'null'
        board:
          anyOf:
          - $ref: '#/components/schemas/BoardValidator'
          - type: 'null'
        chassis:
          anyOf:
          - $ref: '#/components/schemas/ChassisValidator'
          - type: 'null'
        available_releases:
          items:
            $ref: '#/components/schemas/OSValidator'
          type: array
          title: Available Releases
      type: object
      required:
      - certified_url
      - architecture
      - bios
      - board
      - available_releases
      title: CertifiedImageExistsResponse
    PCIPeripheralValidator:
      properties:
        status:
          anyOf:
          - $ref: '#/components/schemas/DeviceStatus'
          - type: 'null'
        pci_id:
          type: string
          title: Pci Id
        name:
          type: string
          title: Name
        vendor:
          type: string
          title: Vendor
      type: object
      required:
      - pci_id
      - name
      - vendor
      title: PCIPeripheralValidator
    AudioValidator:
      properties:
        model:
          type: string
          title: Model
        vendor:
          type: string
          title: Vendor
        identifier:
          type: string
          title: Identifier
      type: object
      required:
      - model
      - vendor
      - identifier
      title: AudioValidator
      description: Validator model for audio devices