Canonical

Canonical Test Cases API

The test-cases API from Canonical — 3 operation(s) for test-cases.

GitHub OpenAPI

Operations 5

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/test-cases/reported-issues List issues reported against test cases · Get Reported Issues #
Ask an LLM
“Which known issues are linked to a test case?”
“Can I filter reported issues by test template?”
Tell an agent
List reported issues for test case {case_name}.
Show issues reported for template {template_id}.
POST /v1/test-cases/reported-issues Report an issue for a test case · Create Reported Issue #
Ask an LLM
“How do I link a bug report to a failing test case?”
“Can I attach a known issue to a whole test template?”
Tell an agent
Report issue {url} described as {description} for test case {case_name}.
Link bug {url} ({description}) to template {template_id}.
PUT /v1/test-cases/reported-issues/{issue_id} Update a reported test case issue · Update Reported Issue #
Ask an LLM
“Can I change the bug link on an issue I already reported?”
“How do I edit the description of a reported test issue?”
Tell an agent
Update reported issue {issue_id} to link {url} with description {description}.
Move reported issue {issue_id} to test case {case_name}, keeping url {url} and description {description}.
DELETE /v1/test-cases/reported-issues/{issue_id} Delete a reported test case issue · Delete Reported Issue #
Ask an LLM
“How do I remove an issue report once the bug is fixed?”
“Can I unlink a reported issue from a test case?”
Tell an agent destructive · confirm first
Delete reported issue {issue_id}.
Unlink the fixed issue {issue_id}.
GET /v1/test-cases Search test cases and their templates · Get Test Cases #
Ask an LLM
“Which test cases exist for disk tests?”
“How do I search test cases by name and family?”
Tell an agent
Search test cases matching {q}.
List {limit} test cases in families {families}.

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://artifacts.apis.io/canonical/openapi/canonical-test-cases-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:canonical-test-cases-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

canonical-test-cases-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Test Observer Test Cases API
  description: Test Observer API (see https://github.com/canonical/test_observer)
  license:
    name: GNU Affero General Public License v3
    url: https://raw.githubusercontent.com/canonical/test_observer/refs/heads/main/backend/LICENSE
  version: 0.1.0
tags:
- name: Test Cases
paths:
  /v1/test-cases/reported-issues:
    get:
      tags:
      - Test Cases
      summary: Get Reported Issues
      operationId: get_reported_issues_v1_test_cases_reported_issues_get
      parameters:
      - name: template_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Template Id
      - name: case_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Case Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TestReportedIssueResponse'
                title: Response Get Reported Issues V1 Test Cases Reported Issues Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - view_test_case_reported_issue
    post:
      tags:
      - Test Cases
      summary: Create Reported Issue
      operationId: create_reported_issue_v1_test_cases_reported_issues_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestReportedIssueRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestReportedIssueResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_test_case_reported_issue
  /v1/test-cases/reported-issues/{issue_id}:
    put:
      tags:
      - Test Cases
      summary: Update Reported Issue
      operationId: update_reported_issue_v1_test_cases_reported_issues__issue_id__put
      parameters:
      - name: issue_id
        in: path
        required: true
        schema:
          type: integer
          title: Issue Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestReportedIssueRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestReportedIssueResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_test_case_reported_issue
    delete:
      tags:
      - Test Cases
      summary: Delete Reported Issue
      operationId: delete_reported_issue_v1_test_cases_reported_issues__issue_id__delete
      parameters:
      - name: issue_id
        in: path
        required: true
        schema:
          type: integer
          title: Issue Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_test_case_reported_issue
  /v1/test-cases:
    get:
      tags:
      - Test Cases
      summary: Get Test Cases
      description: 'Returns test cases as a flat list with their template IDs.


        Template ID represents the generic test (e.g., "disk/stats_name")

        Test case name is the specific instance (e.g., "disk/stats_nvme0n1")

        Multiple test cases can share the same template ID but have different names.'
      operationId: get_test_cases_v1_test_cases_get
      parameters:
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Search term for test case names
          title: Q
        description: Search term for test case names
      - name: families
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/FamilyName'
          - type: 'null'
          description: Filter by artefact families
          title: Families
        description: Filter by artefact families
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Maximum number of results (defaults to 50 if not specified)
          default: 50
          title: Limit
        description: Maximum number of results (defaults to 50 if not specified)
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Number of results to skip for pagination
          default: 0
          title: Offset
        description: Number of results to skip for pagination
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCasesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - view_test
components:
  schemas:
    TestCasesResponse:
      properties:
        test_cases:
          items:
            $ref: '#/components/schemas/TestCaseInfo'
          type: array
          title: Test Cases
      type: object
      required:
      - test_cases
      title: TestCasesResponse
    TestReportedIssueRequest:
      properties:
        template_id:
          type: string
          title: Template Id
          default: ''
        case_name:
          type: string
          title: Case Name
          default: ''
        description:
          type: string
          title: Description
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
      type: object
      required:
      - description
      - url
      title: TestReportedIssueRequest
    TestReportedIssueResponse:
      properties:
        id:
          type: integer
          title: Id
        template_id:
          type: string
          title: Template Id
          default: ''
        case_name:
          type: string
          title: Case Name
          default: ''
        description:
          type: string
          title: Description
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - description
      - url
      - created_at
      - updated_at
      title: TestReportedIssueResponse
    FamilyName:
      type: string
      enum:
      - snap
      - deb
      - charm
      - image
      - solution
      title: FamilyName
    TestCaseInfo:
      properties:
        test_case:
          type: string
          title: Test Case
        template_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Template Id
      type: object
      required:
      - test_case
      - template_id
      title: TestCaseInfo
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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