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

The operations API from Canonical — 10 operation(s) for operations.

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

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

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

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

12 operations 10 paths 7 schemas 2 DELETE10 GET

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
Resource Areas
1

Paths & Operations 12

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

Operations 12
GET
/1.0/operations
Get a list of operations
operations_get 1 param → 200default
GET
/1.0/operations/{uuid}
Get the current status of an operation
operation_get 1 param → 200400404default
DELETE
/1.0/operations/{uuid}
Cancel an operation
operation_delete 1 param → 202400404default
GET
/1.0/operations/{uuid}/wait
Wait for an operation to complete
operation_wait_get 2 params → 200400404default
GET
/1.0/operations/{uuid}/websocket
Get the websocket connection to monitor operation
operation_websocket_get 2 params → 400401403404default
GET
/1.0/operations?recursion=1
Get a list of expanded operations
operations_get_recursion1 1 param → 200default
DELETE
/1.0/operations/{id}
Cancel the operation
delete10OperationsById → 200400403500
GET
/1.0/operations/{id}
Get the operation state
get10OperationsById → 200403500
GET
/1.0/operations/{id}/wait
Wait for the operation
get10OperationsByIdWait 1 param → 200403500
GET
/1.0/operations/{id}/wait?public
Wait for the operation
operation_wait_get_untrusted 2 params → 200403500
GET
/1.0/operations/{id}/websocket
Get the websocket stream
get10OperationsByIdWebsocket 1 param → 200403500
GET
/1.0/operations/{id}/websocket?public
Get the websocket stream
operation_websocket_get_untrusted 1 param → 200403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Operation_2 (15 properties), Operation (12 properties), NoMetaSyncResponse (4 properties), OperationRequestor (3 properties). Each schema is shown below with its type and property counts.

StatusCode
integer
StatusCode represents a valid REST operation
Operation
object
Operation represents a background operation
12 properties
NoMetaSyncResponse
object
Swagger Synchronous response without metadata field
4 properties
CollectionResponse
Collection Response
StatusCode_2
integer
Operation_2
object
Operation represents a LXD background operation
15 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-operations-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 Operations 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.