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

The Apps API from Canonical — 2 operation(s) for apps.

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

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

This API exposes 4 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: unix:///run/snapd.socket, unix:///run/snapd-snap.socket.

4 operations 2 paths 16 schemas 2 GET2 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
License
Resource Areas
1

Authentication & Security 1

Canonical Apps 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 4

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

Apps 4
GET
/v2/aliases
Get the available app aliases
getAliases → 2004XX
POST
/v2/aliases
Modify aliases
modifyAliases body → 202400401409
GET
/v2/apps
List available apps
listApps 3 params → 2004XX
POST
/v2/apps
Modify attributes of applications
modifyApps body → 202400401404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are App (8 properties), AppActionBase (4 properties), Activator (4 properties), ConflictError (3 properties). Each schema is shown below with its type and property counts.

ConflictError
object
3 properties
NotFoundError
object
1 property
Activator
object
Details about a single service activator. Note that uppercase field names exist to maintain backward compatibility with the non-conformant previous implementat…
4 properties 4 required
UserNotFoundError
object
1 property
AppActionBase
object
4 properties 2 required
SnapNotInstalledError
object
The snap does not exist on the system.
3 properties
ConfdbError
object
An error occured while interacting with confdb.
2 properties
AppActionRestart
object
Restarts one or more services.
AppActionStop
object
Stops one or more services.
AppActionStart
object
Starts one or more services.
NoSSHKeysError
object
1 property
MalformedRequestError
object
1 property
App
object
Represents a single application provided by a snap.
8 properties 1 required
InternalServerError
object
1 property
NoModelAssertionError
object
The model assertion has not been created yet.
3 properties
NoSerialAssertionError
object
The serial assertion has not been created yet.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-apps-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 Apps 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.