Canonical
Canonical is the company behind Ubuntu, the world's most popular open source operating system for cloud, servers, desktops, IoT, and Kubernetes. Canonical publishes a broad set of developer APIs spanning the Ubuntu and Canonical ecosystem — the Snap Store and Snapcraft, the Charmhub charm marketplace, LXD system containers, MAAS bare-metal provisioning, Juju orchestration, Launchpad project hosting, Ubuntu Pro subscription services, and Landscape systems management — most of which are RESTful, open, and well documented.
Canonical publishes 114 APIs on the APIs.io network, including Assertions API, Search API, Snaps API, and 111 more. Tagged areas include Canonical, Cloud, Linux, Open Source, and Ubuntu.
The Canonical catalog on APIs.io includes 1 event-driven AsyncAPI specification.
Canonical’s developer surface includes authentication, documentation, engineering blog, CLI, changelog, pricing, signup flow, and 55 more developer resources.
13 APIs
Individual APIs this provider publishes, each with its own machine-readable definition.
The public Snap Store Device API (api.snapcraft.io) serves information about snaps, revisions, channels, tracks, assertions, and refresh state to snap clients. The Snapcraft Das...
Developer-facing REST API for Charmhub, Canonical's marketplace for charms (Kubernetes and machine operators). Supports charm discovery, publishing, release channels, and token ...
The RESTful API for MAAS (Metal as a Service). Everything the MAAS UI can do — commissioning, allocation, deployment, DHCP/DNS, tags, zones, pools, users, machines — is availabl...
Juju is Canonical's open-source orchestration engine for deploying, integrating, scaling, and managing applications on clouds, MAAS, LXD, and Kubernetes via charms. Juju clients...
Launchpad exposes a RESTful Web Services API over its project hosting, bug tracking, code, builds, translations, and distribution data. The API is authenticated with OAuth; anon...
The Ubuntu Pro client exposes a local API/CLI for managing Ubuntu Pro subscription services on a host — enabling, disabling, and inspecting Extended Security Maintenance (ESM), ...
The Assertions API from Canonical — 1 operation(s) for assertions.
The Search API from Canonical — 1 operation(s) for search.
The Snaps API from Canonical — 10 operation(s) for snaps.
MicroCeph is Canonical's opinionated, snap-delivered Ceph distribution. It publishes a small OpenAPI 3.1.0 contract for its cluster REST surface. Recorded here because it is a r...
The AppAuthorizationService API from Canonical — 3 operation(s) for appauthorizationservice.
The application API from Canonical — 1 operation(s) for application.
The applications API from Canonical — 20 operation(s) for applications.
The Apps API from Canonical — 2 operation(s) for apps.
The artefact-builds API from Canonical — 1 operation(s) for artefact-builds.
The artefact-matching-rules API from Canonical — 2 operation(s) for artefact-matching-rules.
The artefacts API from Canonical — 8 operation(s) for artefacts.
Return the reference to a change that will occur in the background.
The auth_groups API from Canonical — 3 operation(s) for auth_groups.
The authentication API from Canonical — 4 operation(s) for authentication.
Access is restricted to the root user.
The AuthzGroupsService API from Canonical — 5 operation(s) for authzgroupsservice.
The certificates API from Canonical — 4 operation(s) for certificates.
The certification API from Canonical — 1 operation(s) for certification.
The changes and tasks API from Canonical — 4 operation(s) for changes and tasks.
The checks API from Canonical — 2 operation(s) for checks.
The ClientsService API from Canonical — 2 operation(s) for clientsservice.
The cluster API from Canonical — 7 operation(s) for cluster.
The cluster-groups API from Canonical — 3 operation(s) for cluster-groups.
The cluster-links API from Canonical — 4 operation(s) for cluster-links.
The config API from Canonical — 1 operation(s) for config.
The containers API from Canonical — 6 operation(s) for containers.
The devices API from Canonical — 3 operation(s) for devices.
The environment-reviews API from Canonical — 2 operation(s) for environment-reviews.
The environments API from Canonical — 3 operation(s) for environments.
The events API from Canonical — 1 operation(s) for events.
The exec API from Canonical — 1 operation(s) for exec.
The execution-metadata API from Canonical — 1 operation(s) for execution-metadata.
Interact with experimental features.
The files API from Canonical — 1 operation(s) for files.
The GroupsService API from Canonical — 8 operation(s) for groupsservice.
The Hardware API (hwapi) API from Canonical — 1 operation(s) for hardware api (hwapi).
The health API from Canonical — 4 operation(s) for health.
The identities API from Canonical — 15 operation(s) for identities.
The IdentitiesService API from Canonical — 2 operation(s) for identitiesservice.
The identity_provider_groups API from Canonical — 3 operation(s) for identity_provider_groups.
The IdpsService API from Canonical — 2 operation(s) for idpsservice.
The images API from Canonical — 19 operation(s) for images.
The instances API from Canonical — 29 operation(s) for instances.
Display and manage interactions between snaps.
The internal API from Canonical — 1 operation(s) for internal.
The issues API from Canonical — 6 operation(s) for issues.
The layers API from Canonical — 1 operation(s) for layers.
Manages local repositories.
The logs API from Canonical — 1 operation(s) for logs.
The Metadata API from Canonical — 1 operation(s) for metadata.
The metrics API from Canonical — 2 operation(s) for metrics.
The MetricsService API from Canonical — 1 operation(s) for metricsservice.
Methods for managing repository mirrors.
The network-acls API from Canonical — 4 operation(s) for network-acls.
The network-allocations API from Canonical — 1 operation(s) for network-allocations.
The network-forwards API from Canonical — 3 operation(s) for network-forwards.
The network-load-balancer-pools API from Canonical — 3 operation(s) for network-load-balancer-pools.
The network-load-balancers API from Canonical — 3 operation(s) for network-load-balancers.
The network-peers API from Canonical — 3 operation(s) for network-peers.
The network-zones API from Canonical — 6 operation(s) for network-zones.
The networks API from Canonical — 5 operation(s) for networks.
The nodes API from Canonical — 3 operation(s) for nodes.
The notices API from Canonical — 4 operation(s) for notices.
The notifications API from Canonical — 6 operation(s) for notifications.
The Oidc_Api API from Canonical — 2 operation(s) for oidc_api.
The oidc_sessions API from Canonical — 3 operation(s) for oidc_sessions.
The operations API from Canonical — 10 operation(s) for operations.
Manages long-running operations.
The permissions API from Canonical — 3 operation(s) for permissions.
The placement-groups API from Canonical — 3 operation(s) for placement-groups.
The plan API from Canonical — 1 operation(s) for plan.
The profiles API from Canonical — 3 operation(s) for profiles.
The projects API from Canonical — 4 operation(s) for projects.
Manages the publication of Debian artifacts.
Manages the storage destinations for publishing Debian archives.
The region API from Canonical — 1 operation(s) for region.
The replicators API from Canonical — 4 operation(s) for replicators.
The reports API from Canonical — 2 operation(s) for reports.
The RolesService API from Canonical — 5 operation(s) for rolesservice.
Requires the user to authenticate with root access.
The schema API from Canonical — 1 operation(s) for schema.
The SchemasService API from Canonical — 3 operation(s) for schemasservice.
The Security API from Canonical — 15 operation(s) for security.
The Sentry Debug API from Canonical — 1 operation(s) for sentry debug.
The server API from Canonical — 5 operation(s) for server.
The service API from Canonical — 2 operation(s) for service.
The services API from Canonical — 1 operation(s) for services.
The session API from Canonical — 8 operation(s) for session.
The signals API from Canonical — 1 operation(s) for signals.
The status API from Canonical — 1 operation(s) for status.
The StatusService API from Canonical — 2 operation(s) for statusservice.
The storage API from Canonical — 29 operation(s) for storage.
The system info API from Canonical — 1 operation(s) for system info.
The tasks API from Canonical — 1 operation(s) for tasks.
The teams API from Canonical — 3 operation(s) for teams.
The TenantService API from Canonical — 8 operation(s) for tenantservice.
The test-cases API from Canonical — 3 operation(s) for test-cases.
The test-executions API from Canonical — 10 operation(s) for test-executions.
The Test Observer API from Canonical — 1 operation(s) for test observer.
The test-plans API from Canonical — 1 operation(s) for test-plans.
The test-results API from Canonical — 1 operation(s) for test-results.
The users API from Canonical — 3 operation(s) for users.
The V1 API from Canonical — 29 operation(s) for v1.
The Version API from Canonical — 1 operation(s) for version.
The warnings API from Canonical — 3 operation(s) for warnings.
The Add Ons API from Canonical — 4 operation(s) for add ons.
The Authentication Service API from Canonical — 4 operation(s) for authentication service.
Do not require the user to authenticate.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
Recommended x-agentic-access execution contracts for AI agents.
aid: canonical
name: Canonical
url: https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/apis.yml
deliveryModel:
model: saas
license_evidence:
not_product:
- canonical/cos-registration-server
- canonical/hardware-api
- canonical/identity-platform-api
- canonical/lxd
- canonical/microceph
open_source: unknown
commercial: true
callable_host: true
label: Hosted service · you call their endpoint
confidence: low
source:
- openapi
- pricing
- repository-not-product
generated: '2026-09-25'
method: derived
accessModel:
pricing: freemium
onboarding: unknown
trial: false
try_now: false
public: false
label: Freemium
confidence: medium
source:
- plans
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/canonical.png
type: Index
x-docs-platform: readthedocs
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-09-21
tags:
- Canonical
- Cloud
- Linux
- Open Source
- Ubuntu
- Containers
- Bare Metal
- Charms
- Identity
tags_raw:
- Canonical
- Cloud
- Linux
- Open Source
- Ubuntu
- Containers
- Bare Metal
- Charms
- Identity
- Open-Source
access: Open
created: '2026-03-16'
modified: '2026-09-05'
position: Producing
specificationVersion: '0.23'
description: Canonical is the company behind Ubuntu, the world's most popular open source operating system for cloud, servers,
desktops, IoT, and Kubernetes. Canonical publishes a broad set of developer APIs spanning the Ubuntu and Canonical ecosystem
— the Snap Store and Snapcraft, the Charmhub charm marketplace, LXD system containers, MAAS bare-metal provisioning, Juju
orchestration, Launchpad project hosting, Ubuntu Pro subscription services, and Landscape systems management — most of which
are RESTful, open, and well documented.
apis:
- aid: canonical:snap-store-api
name: Snap Store API
description: The public Snap Store Device API (api.snapcraft.io) serves information about snaps, revisions, channels, tracks,
assertions, and refresh state to snap clients. The Snapcraft Dashboard API (dashboard.snapcraft.io) lets snap publishers
manage releases, brand stores, and snap metadata programmatically.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Snaps
- Store
- Packaging
properties:
- type: Documentation
url: https://api.snapcraft.io/docs/
- type: DashboardAPI
url: https://dashboard.snapcraft.io/docs/reference/v2/en/index.html
- type: HowTo
url: https://snapcraft.io/docs/using-the-api
- aid: canonical:charmhub-api
name: Charmhub API
description: Developer-facing REST API for Charmhub, Canonical's marketplace for charms (Kubernetes and machine operators).
Supports charm discovery, publishing, release channels, and token exchange — macaroons issued by dashboard.snapcraft.io
SSO are exchanged for Charmhub developer tokens used in the Authorization header.
humanURL: https://api.charmhub.io/docs/default.html
baseURL: https://api.charmhub.io
tags:
- Charms
- Operator
- Kubernetes
tags_raw:
- Charms
- Operators
- Kubernetes
properties:
- type: Documentation
url: https://api.charmhub.io/docs/default.html
- type: Portal
url: https://charmhub.io/
- aid: canonical:maas-api
name: MAAS API
description: The RESTful API for MAAS (Metal as a Service). Everything the MAAS UI can do — commissioning, allocation, deployment,
DHCP/DNS, tags, zones, pools, users, machines — is available through the API, making bare- metal infrastructure programmable
and suitable for Infrastructure as Code workflows. Python and CLI bindings are provided.
humanURL: https://canonical.com/maas/docs/api
baseURL: https://<maas-host>/MAAS/api/2.0
tags:
- Bare Metal
- Provisioning
- Infrastructure
properties:
- type: Documentation
url: https://canonical.com/maas/docs/api
- type: Overview
url: https://canonical.com/maas
- type: Portal
url: https://maas.io/docs
- aid: canonical:juju-api
name: Juju Client / Controller API
description: Juju is Canonical's open-source orchestration engine for deploying, integrating, scaling, and managing applications
on clouds, MAAS, LXD, and Kubernetes via charms. Juju clients communicate with a controller over a websocket-based API;
Python and Go libraries plus the juju CLI consume this API.
humanURL: https://documentation.ubuntu.com/juju/
tags:
- Orchestration
- DevOps
- Charms
properties:
- type: Documentation
url: https://documentation.ubuntu.com/juju/
- type: Overview
url: https://canonical.com/juju
- type: Architecture
url: https://canonical.com/juju/juju-architecture
- aid: canonical:launchpad-api
name: Launchpad Web Services API
description: Launchpad exposes a RESTful Web Services API over its project hosting, bug tracking, code, builds, translations,
and distribution data. The API is authenticated with OAuth; anonymous access gives read-only access to public data. The
launchpadlib Python library is the officially supported client.
humanURL: https://documentation.ubuntu.com/launchpad/user/how-to/launchpad-api/
baseURL: https://api.launchpad.net/
tags:
- Authentication
- Open Source
- Project Hosting
tags_raw:
- OAuth
- Open Source
- Project Hosting
- Open-Source
properties:
- type: Documentation
url: https://documentation.ubuntu.com/launchpad/user/how-to/launchpad-api/
- type: Reference
url: https://help.launchpad.net/API
- type: SDKs
url: https://launchpadlib.readthedocs.io/en/latest/introduction.html
- type: Webhooks
url: asyncapi/canonical-launchpad-webhooks.yml
- type: Portal
url: https://api.launchpad.net/
- aid: canonical:ubuntu-pro-api
name: Ubuntu Pro Client API
description: The Ubuntu Pro client exposes a local API/CLI for managing Ubuntu Pro subscription services on a host — enabling,
disabling, and inspecting Extended Security Maintenance (ESM), Livepatch, FIPS, compliance tooling (CIS, DISA-STIG), USG,
and Landscape integration.
humanURL: https://documentation.ubuntu.com/pro/
tags:
- ESM
- Livepatch
- FIPS
- Compliance
- Subscription
properties:
- type: Documentation
url: https://documentation.ubuntu.com/pro/
- type: ClientDocs
url: https://documentation.ubuntu.com/pro-client/en/latest/
- type: Portal
url: https://ubuntu.com/pro
- aid: canonical:canonical-assertions-api
name: Canonical Assertions API
description: The Assertions API from Canonical — 1 operation(s) for assertions.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Assertions
properties:
- type: OpenAPI
url: openapi/canonical-assertions-api-openapi.yml
- type: Documentation
url: https://api.snapcraft.io/docs/
- type: HowTo
url: https://snapcraft.io/docs/using-the-api
- aid: canonical:canonical-search-api
name: Canonical Search API
description: The Search API from Canonical — 1 operation(s) for search.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Search
properties:
- type: OpenAPI
url: openapi/canonical-search-api-openapi.yml
- type: Documentation
url: https://api.snapcraft.io/docs/
- type: HowTo
url: https://snapcraft.io/docs/using-the-api
- aid: canonical:canonical-snaps-api
name: Canonical Snaps API
description: The Snaps API from Canonical — 10 operation(s) for snaps.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Snaps
properties:
- type: OpenAPI
url: openapi/canonical-snaps-api-openapi.yml
- type: Documentation
url: https://api.snapcraft.io/docs/
- type: HowTo
url: https://snapcraft.io/docs/using-the-api
- aid: canonical:microceph-api
name: MicroCeph REST API
description: MicroCeph is Canonical's opinionated, snap-delivered Ceph distribution. It publishes a small OpenAPI 3.1.0
contract for its cluster REST surface. Recorded here because it is a real published first-party contract, but it is thin
— one path and two operations — and most MicroCeph operation is through the CLI.
humanURL: https://canonical-microceph.readthedocs-hosted.com/
tags:
- Storage
- Ceph
properties:
- type: OpenAPI
url: openapi/canonical-microceph-api-openapi.yml
- type: Overlay
url: overlays/canonical-microceph-api-overlay.yaml
- type: SourceCode
url: https://github.com/canonical/microceph
- aid: canonical:canonical-appauthorizationservice-api
name: Canonical App Authorization Service API
description: The AppAuthorizationService API from Canonical — 3 operation(s) for appauthorizationservice.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- AppAuthorizationService
properties:
- type: OpenAPI
url: openapi/canonical-appauthorizationservice-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-application-api
name: Canonical Application API
description: The application API from Canonical — 1 operation(s) for application.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Application
tags_raw:
- application
properties:
- type: OpenAPI
url: openapi/canonical-application-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-applications-api
name: Canonical Applications API
description: The applications API from Canonical — 20 operation(s) for applications.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Application
tags_raw:
- applications
properties:
- type: OpenAPI
url: openapi/canonical-applications-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-apps-api
name: Canonical Apps API
description: The Apps API from Canonical — 2 operation(s) for apps.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Application
tags_raw:
- Apps
properties:
- type: OpenAPI
url: openapi/canonical-apps-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-artefact-builds-api
name: Canonical Artefact Builds API
description: The artefact-builds API from Canonical — 1 operation(s) for artefact-builds.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- artefact-builds
properties:
- type: OpenAPI
url: openapi/canonical-artefact-builds-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-artefact-matching-rules-api
name: Canonical Artefact Matching Rules API
description: The artefact-matching-rules API from Canonical — 2 operation(s) for artefact-matching-rules.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- artefact-matching-rules
properties:
- type: OpenAPI
url: openapi/canonical-artefact-matching-rules-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-artefacts-api
name: Canonical Artefacts API
description: The artefacts API from Canonical — 8 operation(s) for artefacts.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- artefacts
properties:
- type: OpenAPI
url: openapi/canonical-artefacts-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-asynchronous-api
name: Canonical Asynchronous API
description: Return the reference to a change that will occur in the background.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Asynchronous
properties:
- type: OpenAPI
url: openapi/canonical-asynchronous-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-auth-groups-api
name: Canonical Auth Groups API
description: The auth_groups API from Canonical — 3 operation(s) for auth_groups.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Auth Groups
tags_raw:
- auth_groups
properties:
- type: OpenAPI
url: openapi/canonical-auth-groups-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-authentication-api
name: Canonical Authentication API
description: The authentication API from Canonical — 4 operation(s) for authentication.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Authentication
tags_raw:
- authentication
properties:
- type: OpenAPI
url: openapi/canonical-authentication-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
- aid: canonical:canonical-authenticationrequired-api
name: Canonical Authentication Required API
description: Access is restricted to the root user.
humanURL: https://api.snapcraft.io/docs/
baseURL: https://api.snapcraft.io
tags:
- Authentication Required
tags_raw:
- AuthenticationRequired
properties:
- type: OpenAPI
url: openapi/canonical-authenticationrequired-api-openapi.yml
- type: Documentation
url: https://snapcraft.io/docs/reference/development/snapd-rest-api/
- type: HowTo
url: https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- type: Documentation
url: https://ubuntu.com/landscape/docs
- type: APIReference
url: https://documentation.ubuntu.com/landscape/reference/api/
- type: ReleaseNotes
url: https://documentation.ubuntu.com/landscape/reference/release-notes/
- type: Portal
url: https://ubuntu.com/landscape
- type: Documentation
url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: APIReference
url: https://documentation.ubuntu.com/lxd/latest/api-extensions/
- type: SourceCode
url: https://github.com/canonical/lxd
- type: Portal
url: https://canonical.com/lxd
- type: Documentation
url: https://ubuntu.com/security/api/docs
- type: APIReference
url: https://ubuntu.com/security/api/spec.json
- type: Portal
url: https://ubuntu.com/security
- type: Documentation
url: https://documentation.ubuntu.com/pebble/
- type: SourceCode
url: https://github.com/canonical/pebble
- type: Documentation
url: https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- type: SourceCode
url: https://github.com/canonical/testflinger
- type: SourceCode
url: https://github.com/canonical/hardware-api
- type: Portal
url: https://ubuntu.com/certified
- type: SourceCode
url: https://github.com/canonical/identity-platform-api
- type: SourceCode
url: https://github.com/canonical/test_observer
- type: Documentation
url: https://documentation.ubuntu.com/anbox-cloud/
- type: Portal
url: https://canonical.com/anbox-cloud
- type: SourceCode
url: https://github.com/canonical/cos-registration-server
# --- truncated at 32 KB (233 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/apis.yml
Every provider here is available over the APIs.io API and to AI agents over MCP.
Kin Score
How this is scored →