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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Canonical

Canonical Artefacts API

The artefacts API from Canonical — 8 operation(s) for artefacts.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 8 paths, and defines 22 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.

10 operations 8 paths 22 schemas 7 GET3 PATCH

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
License
GNU Affero General Public License v3
Resource Areas
1

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 7 GET, 3 PATCH. Each is listed below with its method, path, parameters, and response codes.

artefacts 10
GET
/v1/artefacts
Get Artefacts
get_artefacts_v1_artefacts_get 1 param → 200422
GET
/v1/artefacts/search
Search Artefacts
search_artefacts_v1_artefacts_search_get 4 params → 200422
GET
/v1/artefacts/history
Get Artefact History
get_artefact_history_v1_artefacts_history_get 6 params → 200422
GET
/v1/artefacts/{artefact_id}
Get Artefact
get_artefact_v1_artefacts__artefact_id__get 1 param → 200422
PATCH
/v1/artefacts/{artefact_id}
Patch Artefact
patch_artefact_v1_artefacts__artefact_id__patch 1 param body → 200422
GET
/v1/artefacts/{artefact_id}/versions
Get Artefact Versions
get_artefact_versions_v1_artefacts__artefact_id__versions_get 1 param → 200422
GET
/v1/artefacts/{artefact_id}/environment-reviews
Get Environment Reviews
get_environment_reviews_v1_artefacts__artefact_id__environment_reviews_get 1 param → 200422
PATCH
/v1/artefacts/{artefact_id}/environment-reviews
Bulk Update Environment Reviews
bulk_update_environment_reviews_v1_artefacts__artefact_id__environment_reviews_patch 1 param body → 200422
PATCH
/v1/artefacts/{artefact_id}/environment-reviews/{review_id}
Update Environment Review
update_environment_review_v1_artefacts__artefact_id__environment_reviews__review_id__patch 2 params body → 200422
GET
/v1/artefacts/{artefact_id}/builds
Get Artefact Builds
get_artefact_builds_v1_artefacts__artefact_id__builds_get 1 param → 200422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ArtefactResponse (28 properties), TestExecutionResponse (12 properties), ArtefactPatch (10 properties), ArtefactBuildEnvironmentReviewResponse (6 properties). Each schema is shown below with its type and property counts.

ArtefactBuildMinimalResponse
object
3 properties 3 required
ArtefactBuildEnvironmentReviewDecision
string
ArtefactSearchResponse
object
4 properties 4 required
ArtefactStatus
string
EnvironmentResponse
object
3 properties 3 required
ArtefactHistoryResponse
object
2 properties 2 required
ArtefactHistoryItemResponse
object
5 properties 5 required
ArtefactResponse
object
28 properties 28 required
ArtefactVersionResponse
object
2 properties 2 required
FamilyName
string
TestExecutionStatus
string
ExecutionMetadata
object
A mapping of string categories to lists of string values.
ValidationError
object
5 properties 3 required
TestExecutionRelevantLinkResponse
object
3 properties 3 required
ArtefactBuildEnvironmentReviewResponse
object
6 properties 5 required
ArtefactBuildResponse
object
4 properties 4 required
TestExecutionResponse
object
12 properties 11 required
HTTPValidationError
object
1 property
ArtefactPatch
object
10 properties
StageName
string
EnvironmentReviewPatch
object
3 properties
ReviewerResponse
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-artefacts-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
AE Profile APIs.io
Charmhub API
AE Profile APIs.io
MAAS API
AE Profile APIs.io
Juju Client / Controller API
AE Profile APIs.io
Launchpad Web Services API
AE Profile APIs.io
Ubuntu Pro Client API
AE Profile APIs.io
Canonical Assertions API
AE Profile APIs.io
Canonical Search API
AE Profile APIs.io
Canonical Snaps API
AE Profile APIs.io
MicroCeph REST API
AE Profile APIs.io
Canonical App Authorization Service API
AE Profile APIs.io
Canonical Application API
AE Profile APIs.io
#artefacts
← Back to C APIs
API Details
ID
canonical:canonical-artefacts-api
Base URL
https://api.snapcraft.io
Docs
https://api.snapcraft.io/docs/
Provider
Canonical
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=canonical-artefacts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canonical-artefacts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Canonical Artefacts 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.