How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Artefact Matching Rules API

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

Canonical Artefact Matching Rules API is one of 122 APIs that Canonical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include artefact-matching-rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against the base URL https://api.snapcraft.io.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.snapcraft.io
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

artefact-matching-rules 5
POST
/v1/artefact-matching-rules
Create Artefact Matching Rule
create_artefact_matching_rule_v1_artefact_matching_rules_post body → 201422
GET
/v1/artefact-matching-rules
Get Artefact Matching Rules
get_artefact_matching_rules_v1_artefact_matching_rules_get 1 param → 200422
GET
/v1/artefact-matching-rules/{rule_id}
Get Artefact Matching Rule
get_artefact_matching_rule_v1_artefact_matching_rules__rule_id__get 1 param → 200422
PATCH
/v1/artefact-matching-rules/{rule_id}
Update Artefact Matching Rule
update_artefact_matching_rule_v1_artefact_matching_rules__rule_id__patch 1 param body → 200422
DELETE
/v1/artefact-matching-rules/{rule_id}
Delete Artefact Matching Rule
delete_artefact_matching_rule_v1_artefact_matching_rules__rule_id__delete 1 param → 204422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ArtefactMatchingRuleResponse (13 properties), ArtefactMatchingRuleRequest (12 properties), ArtefactMatchingRulePatch (12 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

Permission
string
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
ArtefactMatchingRuleResponse
object
Artefact matching rule with associated teams
13 properties 13 required
FamilyName
string
ArtefactMatchingRuleRequest
object
Request to create an artefact matching rule (extends base with teamids)
12 properties 2 required
TeamMinimal
object
2 properties 2 required
ArtefactMatchingRulePatch
object
Patch request for artefact matching rule
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-artefact-matching-rules-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Canonical Assertions API
Canonical Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Where this information came from

This is an independent, third-party profile of Canonical Artefact Matching Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.