Canonical

Canonical Artefact Matching Rules API

The artefact-matching-rules API from Canonical — 2 operation(s) for artefact-matching-rules.

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

POST /v1/artefact-matching-rules Create an artefact matching rule · Create Artefact Matching Rule #
Ask an LLM
“How do I route artefacts of a given family to my team for review?”
“Can a matching rule target a specific track, series or release?”
Tell an agent
Create a matching rule for family {family} assigned to teams {team_ids}.
Add a rule matching {family} artefacts on track {track} for teams {team_ids}.
GET /v1/artefact-matching-rules List artefact matching rules · Get Artefact Matching Rules #
Ask an LLM
“Which rules decide which team reviews an artefact in Test Observer?”
“Can I list only the matching rules for the snap or deb family?”
Tell an agent
List all artefact matching rules.
List artefact matching rules for family {family}.
GET /v1/artefact-matching-rules/{rule_id} Get an artefact matching rule · Get Artefact Matching Rule #
Ask an LLM
“What criteria and teams does a particular matching rule have?”
“Can I look up one artefact matching rule by its ID?”
Tell an agent
Show artefact matching rule {rule_id}.
Get the teams attached to matching rule {rule_id}.
PATCH /v1/artefact-matching-rules/{rule_id} Update an artefact matching rule · Update Artefact Matching Rule #
Ask an LLM
“How do I change which teams an existing matching rule assigns?”
“Can I narrow an existing rule to a different stage or branch?”
Tell an agent
Reassign matching rule {rule_id} to teams {team_ids}.
Change rule {rule_id} to match stage {stage}.
DELETE /v1/artefact-matching-rules/{rule_id} Delete an artefact matching rule · Delete Artefact Matching Rule #
Ask an LLM
“How do I remove an artefact matching rule?”
“Can I stop a rule from assigning artefacts to a team by deleting it?”
Tell an agent destructive · confirm first
Delete artefact matching rule {rule_id}.
Remove matching rule {rule_id}.

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-artefact-matching-rules-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-artefact-matching-rule-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-artefact-matching-rule-patch-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-artefact-matching-rule-request-schema.json

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-artefact-matching-rules-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-artefact-matching-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Test Observer Artefact Matching Rules 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: artefact-matching-rules
paths:
  /v1/artefact-matching-rules:
    post:
      tags:
      - artefact-matching-rules
      summary: Create Artefact Matching Rule
      description: Create a new artefact matching rule with at least one team
      operationId: create_artefact_matching_rule_v1_artefact_matching_rules_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtefactMatchingRuleRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtefactMatchingRuleResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_team
    get:
      tags:
      - artefact-matching-rules
      summary: Get Artefact Matching Rules
      description: Get all artefact matching rules, optionally filtered by family
      operationId: get_artefact_matching_rules_v1_artefact_matching_rules_get
      parameters:
      - name: family
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/FamilyName'
          - type: 'null'
          title: Family
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArtefactMatchingRuleResponse'
                title: Response Get Artefact Matching Rules V1 Artefact Matching Rules Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - view_team
  /v1/artefact-matching-rules/{rule_id}:
    get:
      tags:
      - artefact-matching-rules
      summary: Get Artefact Matching Rule
      description: Get a specific artefact matching rule by ID
      operationId: get_artefact_matching_rule_v1_artefact_matching_rules__rule_id__get
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: integer
          title: Rule Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtefactMatchingRuleResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - view_team
    patch:
      tags:
      - artefact-matching-rules
      summary: Update Artefact Matching Rule
      description: Update an artefact matching rule
      operationId: update_artefact_matching_rule_v1_artefact_matching_rules__rule_id__patch
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: integer
          title: Rule Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtefactMatchingRulePatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtefactMatchingRuleResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_team
    delete:
      tags:
      - artefact-matching-rules
      summary: Delete Artefact Matching Rule
      description: Delete an artefact matching rule
      operationId: delete_artefact_matching_rule_v1_artefact_matching_rules__rule_id__delete
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: integer
          title: Rule Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_team
components:
  schemas:
    Permission:
      type: string
      enum:
      - view_user
      - change_user
      - view_team
      - change_team
      - add_application
      - change_application
      - view_application
      - view_permission
      - view_issue
      - change_issue
      - change_issue_attachment
      - change_issue_attachment_bulk
      - change_attachment_rule
      - change_auto_rerun
      - view_test
      - change_test
      - view_rerun
      - change_rerun
      - change_rerun_bulk
      - view_artefact
      - change_artefact
      - view_environment_review
      - change_environment_review
      - view_report
      - view_test_case_reported_issue
      - change_test_case_reported_issue
      - view_environment_reported_issue
      - change_environment_reported_issue
      - view_notification
      - change_notification
      - view_sentry_debug
      title: Permission
    FamilyName:
      type: string
      enum:
      - snap
      - deb
      - charm
      - image
      - solution
      title: FamilyName
    ArtefactMatchingRuleResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        family:
          $ref: '#/components/schemas/FamilyName'
        stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage
        track:
          anyOf:
          - type: string
          - type: 'null'
          title: Track
        branch:
          anyOf:
          - type: string
          - type: 'null'
          title: Branch
        store:
          anyOf:
          - type: string
          - type: 'null'
          title: Store
        series:
          anyOf:
          - type: string
          - type: 'null'
          title: Series
        os:
          anyOf:
          - type: string
          - type: 'null'
          title: Os
        release:
          anyOf:
          - type: string
          - type: 'null'
          title: Release
        owner:
          anyOf:
          - type: string
          - type: 'null'
          title: Owner
        teams:
          items:
            $ref: '#/components/schemas/TeamMinimal'
          type: array
          title: Teams
        grant_permissions:
          items:
            $ref: '#/components/schemas/Permission'
          type: array
          title: Grant Permissions
      type: object
      required:
      - id
      - name
      - family
      - stage
      - track
      - branch
      - store
      - series
      - os
      - release
      - owner
      - teams
      - grant_permissions
      title: ArtefactMatchingRuleResponse
      description: Artefact matching rule with associated teams
    ArtefactMatchingRuleRequest:
      properties:
        name:
          type: string
          title: Name
          default: ''
        family:
          $ref: '#/components/schemas/FamilyName'
        stage:
          type: string
          title: Stage
          default: ''
        track:
          type: string
          title: Track
          default: ''
        branch:
          type: string
          title: Branch
          default: ''
        store:
          type: string
          title: Store
          default: ''
        series:
          type: string
          title: Series
          default: ''
        os:
          type: string
          title: Os
          default: ''
        release:
          type: string
          title: Release
          default: ''
        owner:
          type: string
          title: Owner
          default: ''
        grant_permissions:
          items:
            $ref: '#/components/schemas/Permission'
          type: array
          title: Grant Permissions
        team_ids:
          items:
            type: integer
          type: array
          title: Team Ids
      type: object
      required:
      - family
      - team_ids
      title: ArtefactMatchingRuleRequest
      description: Request to create an artefact matching rule (extends base with team_ids)
    TeamMinimal:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - name
      title: TeamMinimal
    ArtefactMatchingRulePatch:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        family:
          anyOf:
          - $ref: '#/components/schemas/FamilyName'
          - type: 'null'
        stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage
        track:
          anyOf:
          - type: string
          - type: 'null'
          title: Track
        branch:
          anyOf:
          - type: string
          - type: 'null'
          title: Branch
        store:
          anyOf:
          - type: string
          - type: 'null'
          title: Store
        series:
          anyOf:
          - type: string
          - type: 'null'
          title: Series
        os:
          anyOf:
          - type: string
          - type: 'null'
          title: Os
        release:
          anyOf:
          - type: string
          - type: 'null'
          title: Release
        owner:
          anyOf:
          - type: string
          - type: 'null'
          title: Owner
        team_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Team Ids
        grant_permissions:
          anyOf:
          - items:
              $ref: '#/components/schemas/Permission'
            type: array
          - type: 'null'
          title: Grant Permissions
      type: object
      title: ArtefactMatchingRulePatch
      description: Patch request for artefact matching rule
    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