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 Assertions API

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

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

Tagged areas include Assertions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against 3 base URLs: https://api.snapcraft.io, unix:///run/snapd.socket, unix:///run/snapd-snap.socket.

8 operations 5 paths 10 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Canonical Assertions API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-PEER-CREDENTIALS (PeerAuth).

  • PeerAuth — Unix Socket Peer Authentication Authentication is not handled via traditional HTTP headers or tokens. Instead, it is managed at the operating system level usin…

Paths & Operations 8

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

Assertions 8
GET
/v2/assertions/{type}/{primaryKey}
Fetch an assertion
getV2AssertionsByTypeByPrimaryKey 2 params → 200
GET
/v2/assertions
Get the list of assertion types
listAssertionTypes → 2004XX
POST
/v2/assertions
Attempt to add or replace an assertion
addAssertion body → 200400
GET
/v2/assertions/{assertion-type}
Get assertions of a given type
getAssertionsByType 3 params → 200400
GET
/v2/model
Get the active model assertion
getModelAssertion → 200404
POST
/v2/model
Replace the model assertion
setModelAssertion body → 202400
GET
/v2/model/serial
Get the current serial assertion
getSerialAssertion → 200404
POST
/v2/model/serial
Perform an action on the serial assertion
setSerialAssertion body → 202400

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AssertionResult (4 properties), NoSerialAssertionError (3 properties), NoModelAssertionError (3 properties), SnapNotInstalledError (3 properties). Each schema is shown below with its type and property counts.

SnapNotInstalledError
object
The snap does not exist on the system.
3 properties
MalformedRequestError
object
1 property
NoSSHKeysError
object
1 property
InternalServerError
object
1 property
NoModelAssertionError
object
The model assertion has not been created yet.
3 properties
NotFoundError
object
1 property
NoSerialAssertionError
object
The serial assertion has not been created yet.
3 properties
UserNotFoundError
object
1 property
ConfdbError
object
An error occured while interacting with confdb.
2 properties
AssertionResult
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-assertions-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 Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Canonical Applications API
Where this information came from

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