Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Snaps API

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

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

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

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

Requests are made against a single base URL, https://api.snapcraft.io.

10 operations 10 paths 5 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 10

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

Snaps 10
GET
/v2/snaps/info/{name}
Get snap information
5 params → 200404
GET
/v2/snaps/find
Find snaps
6 params → 200
POST
/v2/snaps/refresh
Refresh snaps
1 param body → 200
GET
/api/v1/snaps/search
Snaps search (legacy v1)
2 params → 200
GET
/api/v1/snaps/names
List snap names (autocomplete; legacy v1)
1 param → 200
GET
/api/v1/snaps/sections
List store sections (legacy v1)
→ 200
POST
/api/v1/snaps/auth/nonces
Request a device nonce
→ 200
POST
/api/v1/snaps/auth/sessions
Create a device session
→ 200
POST
/api/v1/snaps/auth/devices
Register a device
→ 200
POST
/api/v1/snaps/auth/request-id
Get an authentication request id
→ 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SnapInfo (4 properties), RefreshRequest (2 properties), RefreshResponse (1 property), FindResults (1 property). Each schema is shown below with its type and property counts.

FindResults
object
1 property
RefreshResponse
object
1 property
SnapInfo
object
4 properties
Generic
object
RefreshRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-snaps-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
snapd REST API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Landscape API
Canonical Assertions API
Canonical Search API