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 122 API contracts indexed on the APIs.io network, including Assertions API, Search API, Snaps API, and 119 more. Tagged areas include Canonical, Cloud, Linux, Open Source, and Ubuntu.

The Canonical catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 1 Spectral governance ruleset.

Canonical’s developer surface includes authentication, documentation, engineering blog, CLI, changelog, pricing, signup flow, and 61 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

74.8/100 exemplar ▼ -7.0 Agent 43/100 agent ready Front door AI 6/6 dominant saas Full breakdown ↓
scored 2026-10-17 · rubric v0.24.0

AccessFreemium

13 published contracts

Canonical Cloud Linux Open SourceUbuntuContainers Bare MetalCharmsIdentity

What people ask Canonical 116

The questions people put to an LLM, and the jobs they hand an agent, that Canonical's APIs answer — each one linked to the operation that does it. Generated by API Evangelist

Canonical Instances API List Anbox instances as endpoint URLs “How do I get the URLs of every Anbox instance in AMS?” Launch a new Anbox instance from an app or image “How do I launch a new Android instance in AMS from an application?” Delete several Anbox instances at once “Can I delete a batch of AMS instances by their IDs in one call?” Change the running state of all instances “Can I stop every instance at once instead of one by one?”

Canonical Storage API List storage pool URLs “Which storage pools exist on my LXD server, just as a list of URLs?” Create a storage pool “How do I add a new storage pool to LXD with a specific driver like zfs or btrfs?” Delete a storage bucket “How do I remove an object storage bucket from a pool?” Change some bucket settings “Can I change only a bucket's size limit without touching other settings?”

Canonical Applications API List Android applications in AMS “Which Android applications are stored in my Anbox Management Service?” Create an application from a package “How do I upload a new Android app package with a manifest.yaml to AMS?” Delete several applications at once “Can I remove a batch of AMS applications in one request?” Get details of one AMS application “Where can I see the details stored for a single Anbox application?”

Canonical Images API List images in the Anbox cluster “Which Android images are available in my AMS cluster?” Import an image from an image server into AMS “How do I pull an Anbox image into AMS from an image server by name?” Upload a package to create a new AMS image “How do I create an Anbox image in AMS by uploading a gzip, bzip2 or xz package?” Get details of an AMS image by id or name “Can I look up an AMS image using either its id or its name?”

Canonical Identities API List URLs of all identities across auth methods “Where can I get the URLs of every identity LXD knows about, whatever the auth method?” List URLs of bearer identities “Which bearer-token identities exist on my LXD server, as a list of links?” Create a bearer identity “How do I add a new bearer-token identity to LXD?” Revoke a bearer identity's token “How can I revoke the token of a bearer identity without deleting the identity itself?”

Canonical Authentication Required API List snapd changes in progress or completed “What installs, refreshes and other changes is snapd running right now?” Check the status of one snapd change “Has a specific snapd background change finished yet?” Abort a snapd change in progress “Can I stop a snap operation that's still running?” Create cohort keys for snaps “How do I generate cohort keys so several devices get the same snap revision?”

Canonical Security API List security notices (compat format) “Is there a backward-compatible feed of Ubuntu security notices?” Get one security notice (compat format) “Can I fetch a single USN in the older compat format?” Search CVEs “Which CVEs affect a given Ubuntu package?” Get one CVE “What is Ubuntu's status and priority for a specific CVE?”

Canonical Test Executions API Finish a test execution and submit its results “How do I close out a test run and report its results to Test Observer?” Get the test results of a test execution “Which individual test cases passed or failed in a given test execution?” Add test results to a test execution “How do I upload test case results to a test execution that is still running?” Attach a labelled link to a test execution “How do I add a link, like a log or dashboard URL, to a test execution?”

Canonical Groups Service API List identity platform groups “What groups exist in the identity platform admin?” Create a group “How do I add a new group in the identity admin?” Delete a group “How do I delete a group I no longer need?” Get a group “What are the details of a particular group?”

Canonical Cluster API Get the LXD cluster configuration “Is clustering enabled on my LXD server and what is its configuration?” Replace the LXD cluster configuration “How do I enable clustering on an LXD server or join it to an existing cluster?” Replace the cluster certificate “How do I rotate the TLS certificate used by my whole LXD cluster?” Create a cluster group “Can I group some LXD cluster members together for placement?”

Canonical Network Zones API List network zones as URLs “Which DNS network zones are defined on my LXD server?” Create a network zone “How do I create a new DNS zone for my LXD networks?” Delete a network zone “Can I remove a DNS network zone I no longer use?” Get a network zone “What configuration does a particular network zone have?”

Canonical Operations API List running and queued AMS operations “Which background operations are in progress or queued on my Anbox Management Service?” Check the status of an AMS operation “What is the current status of an AMS operation I started?” Cancel an AMS operation “How do I cancel a long-running AMS operation?” Wait for an AMS operation to finish “Can I block until an AMS operation reaches a final status?”

Showing 12 of 116 APIs with phrasing — see every API.

Kin Score

Kin Score How this is scored →
scored 2026-10-17 · rubric v0.24.0

Composite quality — 74.8/100 · exemplar

Contract Quality 12.5 / 19

Developer Ergonomics 11.0 / 15

Access Clarity 13.8 / 15

Operational Transparency 5.9 / 10

Contract Governance 3.2 / 9

Discoverability 5.2 / 8

Regulatory Posture 6.8 / 15

Create-or-Update Ergonomics 2.2 / 10

Agent readiness — 43/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 9 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 6 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/canonical: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Cloud Native (Kubernetes, CNCF, FinOps)	standard	44.1	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

APIs 122

Individual APIs this provider publishes, each with its own machine-readable definition.

Snap Store API

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...

Charmhub API

Developer-facing REST API for Charmhub, Canonical's marketplace for charms (Kubernetes and machine operators). Supports charm discovery, publishing, release channels, and token ...

MAAS API

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 Client / Controller API

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 Web Services API

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...

Ubuntu Pro Client API

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), ...

Canonical Assertions API

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

Canonical Search API

The Search API from Canonical — 1 operation(s) for search.

Canonical Snaps API

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

MicroCeph REST API

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...

Canonical App Authorization Service API

The AppAuthorizationService API from Canonical — 3 operation(s) for appauthorizationservice.

Canonical Application API

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

Canonical Applications API

The applications API from Canonical — 20 operation(s) for applications.

Canonical Apps API

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

Canonical Artefact Builds API

The artefact-builds API from Canonical — 1 operation(s) for artefact-builds.

Canonical Artefact Matching Rules API

The artefact-matching-rules API from Canonical — 2 operation(s) for artefact-matching-rules.

Canonical Artefacts API

The artefacts API from Canonical — 8 operation(s) for artefacts.

Canonical Asynchronous API

Return the reference to a change that will occur in the background.

Canonical Auth Groups API

The auth_groups API from Canonical — 3 operation(s) for auth_groups.

Canonical Authentication API

The authentication API from Canonical — 4 operation(s) for authentication.

Canonical Authentication Required API

Access is restricted to the root user.

Canonical Authz Groups Service API

The AuthzGroupsService API from Canonical — 5 operation(s) for authzgroupsservice.

Canonical Certificates API

The certificates API from Canonical — 4 operation(s) for certificates.

Canonical Certification API

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

Canonical changes and tasks API

The changes and tasks API from Canonical — 4 operation(s) for changes and tasks.

Canonical Checks API

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

Canonical Clients Service API

The ClientsService API from Canonical — 2 operation(s) for clientsservice.

Canonical Cluster API

The cluster API from Canonical — 7 operation(s) for cluster.

Canonical Cluster Groups API

The cluster-groups API from Canonical — 3 operation(s) for cluster-groups.

Canonical Cluster Links API

The cluster-links API from Canonical — 4 operation(s) for cluster-links.

Canonical Config API

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

Canonical Containers API

The containers API from Canonical — 6 operation(s) for containers.

Canonical Devices API

The devices API from Canonical — 3 operation(s) for devices.

Canonical Environment Reviews API

The environment-reviews API from Canonical — 2 operation(s) for environment-reviews.

Canonical Environments API

The environments API from Canonical — 3 operation(s) for environments.

Canonical Events API

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

Canonical Exec API

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

Canonical Execution Metadata API

The execution-metadata API from Canonical — 1 operation(s) for execution-metadata.

Canonical Experimental API

Interact with experimental features.

Canonical Files API

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

Canonical Groups Service API

The GroupsService API from Canonical — 8 operation(s) for groupsservice.

Canonical Hardware API (hwapi) API

The Hardware API (hwapi) API from Canonical — 1 operation(s) for hardware api (hwapi).

Canonical Health API

The health API from Canonical — 4 operation(s) for health.

Canonical Identities API

The identities API from Canonical — 15 operation(s) for identities.

Canonical Identities Service API

The IdentitiesService API from Canonical — 2 operation(s) for identitiesservice.

Canonical Identity Provider Groups API

The identity_provider_groups API from Canonical — 3 operation(s) for identity_provider_groups.

Canonical Idps Service API

The IdpsService API from Canonical — 2 operation(s) for idpsservice.

Canonical Images API

The images API from Canonical — 19 operation(s) for images.

Canonical Instances API

The instances API from Canonical — 29 operation(s) for instances.

Canonical Interfaces API

Display and manage interactions between snaps.

Canonical Internal API

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

Canonical Issues API

The issues API from Canonical — 6 operation(s) for issues.

Canonical Layers API

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

Canonical Local Service API

Manages local repositories.

Canonical Logs API

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

Canonical Metadata API

The Metadata API from Canonical — 1 operation(s) for metadata.

Canonical Metrics API

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

Canonical Metrics Service API

The MetricsService API from Canonical — 1 operation(s) for metricsservice.

Canonical Mirror Service API

Methods for managing repository mirrors.

Canonical Network Acls API

The network-acls API from Canonical — 4 operation(s) for network-acls.

Canonical Network Allocations API

The network-allocations API from Canonical — 1 operation(s) for network-allocations.

Canonical Network Forwards API

The network-forwards API from Canonical — 3 operation(s) for network-forwards.

Canonical Network Load Balancer Pools API

The network-load-balancer-pools API from Canonical — 3 operation(s) for network-load-balancer-pools.

Canonical Network Load Balancers API

The network-load-balancers API from Canonical — 3 operation(s) for network-load-balancers.

Canonical Network Peers API

The network-peers API from Canonical — 3 operation(s) for network-peers.

Canonical Network Zones API

The network-zones API from Canonical — 6 operation(s) for network-zones.

Canonical Networks API

The networks API from Canonical — 5 operation(s) for networks.

Canonical Nodes API

The nodes API from Canonical — 3 operation(s) for nodes.

Canonical Notices API

The notices API from Canonical — 4 operation(s) for notices.

Canonical Notifications API

The notifications API from Canonical — 6 operation(s) for notifications.

Canonical Oidc API

The Oidc_Api API from Canonical — 2 operation(s) for oidc_api.

Canonical Oidc Sessions API

The oidc_sessions API from Canonical — 3 operation(s) for oidc_sessions.

Canonical Operations API

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

Canonical Operation Service API

Manages long-running operations.

Canonical Permissions API

The permissions API from Canonical — 3 operation(s) for permissions.

Canonical Placement Groups API

The placement-groups API from Canonical — 3 operation(s) for placement-groups.

Canonical Plan API

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

Canonical Profiles API

The profiles API from Canonical — 3 operation(s) for profiles.

Canonical Projects API

The projects API from Canonical — 4 operation(s) for projects.

Canonical Publication Service API

Manages the publication of Debian artifacts.

Canonical Publication Target Service API

Manages the storage destinations for publishing Debian archives.

Canonical Region API

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

Canonical Replicators API

The replicators API from Canonical — 4 operation(s) for replicators.

Canonical Reports API

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

Canonical Roles Service API

The RolesService API from Canonical — 5 operation(s) for rolesservice.

Canonical Root API

Requires the user to authenticate with root access.

Canonical Schema API

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

Canonical Schemas Service API

The SchemasService API from Canonical — 3 operation(s) for schemasservice.

Canonical Security API

The Security API from Canonical — 15 operation(s) for security.

Canonical Sentry Debug API

The Sentry Debug API from Canonical — 1 operation(s) for sentry debug.

Canonical Server API

The server API from Canonical — 5 operation(s) for server.

Canonical Service API

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

Canonical Services API

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

Canonical Session API

The session API from Canonical — 8 operation(s) for session.

Canonical Signals API

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

Canonical Status API

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

Canonical Status Service API

The StatusService API from Canonical — 2 operation(s) for statusservice.

Canonical Storage API

The storage API from Canonical — 29 operation(s) for storage.

Canonical system info API

The system info API from Canonical — 1 operation(s) for system info.

Canonical Tasks API

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

Canonical Teams API

The teams API from Canonical — 3 operation(s) for teams.

Canonical Tenant Service API

The TenantService API from Canonical — 8 operation(s) for tenantservice.

Canonical Test Cases API

The test-cases API from Canonical — 3 operation(s) for test-cases.

Canonical Test Executions API

The test-executions API from Canonical — 10 operation(s) for test-executions.

Canonical Test Observer API

The Test Observer API from Canonical — 1 operation(s) for test observer.

Canonical Test Plans API

The test-plans API from Canonical — 1 operation(s) for test-plans.

Canonical Test Results API

The test-results API from Canonical — 1 operation(s) for test-results.

Canonical Users API

The users API from Canonical — 3 operation(s) for users.

Canonical Version API

The Version API from Canonical — 1 operation(s) for version.

Canonical Warnings API

The warnings API from Canonical — 3 operation(s) for warnings.

Canonical Agents API

The Agents API from Canonical — 6 operation(s) for agents.

Canonical Client Permissions API

The Client Permissions API from Canonical — 2 operation(s) for client permissions.

Canonical Job API

The Job API from Canonical — 7 operation(s) for job.

Canonical Oauth2 API

The Oauth2 API from Canonical — 3 operation(s) for oauth2.

Canonical Queues API

The Queues API from Canonical — 3 operation(s) for queues.

Canonical Restricted Queues API

The Restricted Queues API from Canonical — 2 operation(s) for restricted queues.

Canonical Result API

The Result API from Canonical — 4 operation(s) for result.

Canonical Secrets API

The Secrets API from Canonical — 1 operation(s) for secrets.

Canonical Testflinger API

The Testflinger API API from Canonical — 1 operation(s) for testflinger api.

Canonical Add Ons API

The Add Ons API from Canonical — 4 operation(s) for add ons.

Canonical Authentication Service API

The Authentication Service API from Canonical — 4 operation(s) for authentication service.

Canonical Open Access API

Do not require the user to authenticate.

Scroll for all 122

Open Collections 5

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

API Collection

OPEN COLLECTION

Canonical Snap Store Device Assertions API

OPEN COLLECTION

Canonical Snap Store Device Assertions Search API

OPEN COLLECTION

Canonical Snap Store Device Assertions Snaps API

OPEN COLLECTION

Canonical Snap Store Device API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Canonical Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Canonical Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Canonical Finops

FINOPS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Canonical Launchpad Webhooks

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Canonical Context

120 classes · 234 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Canonical API Rules

9 rules · 4 errors 4 warnings 1 info

SPECTRAL

OpenAPI Overlays 130

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Canonical Add Ons Api Phrasing Overlay

8 actions · phrasing · canonical-add-ons-api-openapi.yml

GENERATED

Canonical Agents Api Phrasing Overlay

9 actions · phrasing · canonical-agents-api-openapi.yml

GENERATED

Canonical Anbox Cloud Ams Api Overlay

4 actions · update · canonical-anbox-cloud-ams-api-openapi.json

GENERATED

Canonical Anbox Stream Gateway Api Overlay

3 actions · update · canonical-anbox-stream-gateway-api-openapi.json

GENERATED

Canonical Appauthorizationservice Api Phrasing Overlay

7 actions · phrasing · canonical-appauthorizationservice-api-openapi.yml

GENERATED

Canonical Application Api Phrasing Overlay

2 actions · phrasing · canonical-application-api-openapi.yml

GENERATED

Canonical Applications Api Phrasing Overlay

46 actions · phrasing · canonical-applications-api-openapi.yml

GENERATED

Canonical Apps Api Phrasing Overlay

5 actions · phrasing · canonical-apps-api-openapi.yml

GENERATED

Canonical Artefact Builds Api Phrasing Overlay

2 actions · phrasing · canonical-artefact-builds-api-openapi.yml

GENERATED

Canonical Artefact Matching Rules Api Phrasing Overlay

6 actions · phrasing · canonical-artefact-matching-rules-api-openapi.yml

GENERATED

Canonical Artefacts Api Phrasing Overlay

11 actions · phrasing · canonical-artefacts-api-openapi.yml

GENERATED

Canonical Assertions Api Phrasing Overlay

9 actions · phrasing · canonical-assertions-api-openapi.yml

GENERATED

Canonical Asynchronous Api Phrasing Overlay

9 actions · phrasing · canonical-asynchronous-api-openapi.yml

GENERATED

Canonical Auth Groups Api Phrasing Overlay

9 actions · phrasing · canonical-auth-groups-api-openapi.yml

GENERATED

Canonical Authentication Api Phrasing Overlay

6 actions · phrasing · canonical-authentication-api-openapi.yml

GENERATED

Canonical Authentication Service Api Phrasing Overlay

5 actions · phrasing · canonical-authentication-service-api-openapi.yml

GENERATED

Canonical Authenticationrequired Api Phrasing Overlay

21 actions · phrasing · canonical-authenticationrequired-api-openapi.yml

GENERATED

Canonical Authzgroupsservice Api Phrasing Overlay

11 actions · phrasing · canonical-authzgroupsservice-api-openapi.yml

GENERATED

Canonical Certificates Api Phrasing Overlay

9 actions · phrasing · canonical-certificates-api-openapi.yml

GENERATED

Canonical Certification Api Phrasing Overlay

2 actions · phrasing · canonical-certification-api-openapi.yml

GENERATED

Canonical Changes And Tasks Api Phrasing Overlay

6 actions · phrasing · canonical-changes-and-tasks-api-openapi.yml

GENERATED

Canonical Checks Api Phrasing Overlay

4 actions · phrasing · canonical-checks-api-openapi.yml

GENERATED

Canonical Client Permissions Api Phrasing Overlay

5 actions · phrasing · canonical-client-permissions-api-openapi.yml

GENERATED

Canonical Clientsservice Api Phrasing Overlay

6 actions · phrasing · canonical-clientsservice-api-openapi.yml

GENERATED

Canonical Cluster Api Phrasing Overlay

15 actions · phrasing · canonical-cluster-api-openapi.yml

GENERATED

Canonical Cluster Groups Api Phrasing Overlay

8 actions · phrasing · canonical-cluster-groups-api-openapi.yml

GENERATED

Canonical Cluster Links Api Phrasing Overlay

10 actions · phrasing · canonical-cluster-links-api-openapi.yml

GENERATED

Canonical Config Api Phrasing Overlay

3 actions · phrasing · canonical-config-api-openapi.yml

GENERATED

Canonical Containers Api Phrasing Overlay

11 actions · phrasing · canonical-containers-api-openapi.yml

GENERATED

Canonical Cos Registration Server Api Overlay

3 actions · update · canonical-cos-registration-server-api-openapi.yml

GENERATED

Canonical Devices Api Phrasing Overlay

10 actions · phrasing · canonical-devices-api-openapi.yml

GENERATED

Canonical Environment Reviews Api Phrasing Overlay

4 actions · phrasing · canonical-environment-reviews-api-openapi.yml

GENERATED

Canonical Environments Api Phrasing Overlay

6 actions · phrasing · canonical-environments-api-openapi.yml

GENERATED

Canonical Events Api Phrasing Overlay

2 actions · phrasing · canonical-events-api-openapi.yml

GENERATED

Canonical Exec Api Phrasing Overlay

2 actions · phrasing · canonical-exec-api-openapi.yml

GENERATED

Canonical Execution Metadata Api Phrasing Overlay

2 actions · phrasing · canonical-execution-metadata-api-openapi.yml

GENERATED

Canonical Experimental Api Phrasing Overlay

9 actions · phrasing · canonical-experimental-api-openapi.yml

GENERATED

Canonical Files Api Phrasing Overlay

3 actions · phrasing · canonical-files-api-openapi.yml

GENERATED

Canonical Groupsservice Api Phrasing Overlay

15 actions · phrasing · canonical-groupsservice-api-openapi.yml

GENERATED

Canonical Hardware Api Hwapi Api Phrasing Overlay

2 actions · phrasing · canonical-hardware-api-hwapi-api-openapi.yml

GENERATED

Canonical Hardware Api Overlay

3 actions · update · canonical-hardware-api-openapi.json

GENERATED

Canonical Health Api Phrasing Overlay

5 actions · phrasing · canonical-health-api-openapi.yml

GENERATED

Canonical Identities Api Phrasing Overlay

29 actions · phrasing · canonical-identities-api-openapi.yml

GENERATED

Canonical Identitiesservice Api Phrasing Overlay

6 actions · phrasing · canonical-identitiesservice-api-openapi.yml

GENERATED

Canonical Identity Platform Api Overlay

2 actions · update · canonical-identity-platform-api-openapi.yml

GENERATED

Canonical Identity Provider Groups Api Phrasing Overlay

9 actions · phrasing · canonical-identity-provider-groups-api-openapi.yml

GENERATED

Canonical Idpsservice Api Phrasing Overlay

6 actions · phrasing · canonical-idpsservice-api-openapi.yml

GENERATED

Canonical Images Api Phrasing Overlay

32 actions · phrasing · canonical-images-api-openapi.yml

GENERATED

Canonical Instances Api Phrasing Overlay

59 actions · phrasing · canonical-instances-api-openapi.yml

GENERATED

Canonical Interfaces Api Phrasing Overlay

3 actions · phrasing · canonical-interfaces-api-openapi.yml

GENERATED

Canonical Internal Api Phrasing Overlay

2 actions · phrasing · canonical-internal-api-openapi.yml

GENERATED

Canonical Issues Api Phrasing Overlay

10 actions · phrasing · canonical-issues-api-openapi.yml

GENERATED

Canonical Job Api Phrasing Overlay

10 actions · phrasing · canonical-job-api-openapi.yml

GENERATED

Canonical Landscape Debarchive Api Overlay

3 actions · update · canonical-landscape-debarchive-api-openapi.yml

GENERATED

Canonical Landscape Debarchive Provider Overlay

41 actions · update

UNRECORDED

Canonical Layers Api Phrasing Overlay

2 actions · phrasing · canonical-layers-api-openapi.yml

GENERATED

Canonical Localservice Api Phrasing Overlay

9 actions · phrasing · canonical-localservice-api-openapi.yml

GENERATED

Canonical Logs Api Phrasing Overlay

2 actions · phrasing · canonical-logs-api-openapi.yml

GENERATED

Canonical Lxd Rest Api Overlay

3 actions · update · canonical-lxd-rest-api-openapi.yml

GENERATED

Canonical Metadata Api Phrasing Overlay

2 actions · phrasing · canonical-metadata-api-openapi.yml

GENERATED

Canonical Metrics Api Phrasing Overlay

3 actions · phrasing · canonical-metrics-api-openapi.yml

GENERATED

Canonical Metricsservice Api Phrasing Overlay

2 actions · phrasing · canonical-metricsservice-api-openapi.yml

GENERATED

Canonical Microceph Api Overlay

3 actions · update · canonical-microceph-api-openapi.yml

GENERATED

Canonical Microceph Api Phrasing Overlay

3 actions · phrasing · canonical-microceph-api-openapi.yml

GENERATED

Canonical Mirrorservice Api Phrasing Overlay

9 actions · phrasing · canonical-mirrorservice-api-openapi.yml

GENERATED

Canonical Network Acls Api Phrasing Overlay

10 actions · phrasing · canonical-network-acls-api-openapi.yml

GENERATED

Canonical Network Allocations Api Phrasing Overlay

2 actions · phrasing · canonical-network-allocations-api-openapi.yml

GENERATED

Canonical Network Forwards Api Phrasing Overlay

8 actions · phrasing · canonical-network-forwards-api-openapi.yml

GENERATED

Canonical Network Load Balancer Pools Api Phrasing Overlay

7 actions · phrasing · canonical-network-load-balancer-pools-api-openapi.yml

GENERATED

Canonical Network Load Balancers Api Phrasing Overlay

8 actions · phrasing · canonical-network-load-balancers-api-openapi.yml

GENERATED

Canonical Network Peers Api Phrasing Overlay

8 actions · phrasing · canonical-network-peers-api-openapi.yml

GENERATED

Canonical Network Zones Api Phrasing Overlay

15 actions · phrasing · canonical-network-zones-api-openapi.yml

GENERATED

Canonical Networks Api Phrasing Overlay

11 actions · phrasing · canonical-networks-api-openapi.yml

GENERATED

Canonical Nodes Api Phrasing Overlay

7 actions · phrasing · canonical-nodes-api-openapi.yml

GENERATED

Canonical Notices Api Phrasing Overlay

7 actions · phrasing · canonical-notices-api-openapi.yml

GENERATED

Canonical Notifications Api Phrasing Overlay

7 actions · phrasing · canonical-notifications-api-openapi.yml

GENERATED

Canonical Oauth2 Api Phrasing Overlay

4 actions · phrasing · canonical-oauth2-api-openapi.yml

GENERATED

Canonical Oidc Api Api Phrasing Overlay

3 actions · phrasing · canonical-oidc-api-api-openapi.yml

GENERATED

Canonical Oidc Sessions Api Phrasing Overlay

5 actions · phrasing · canonical-oidc-sessions-api-openapi.yml

GENERATED

Canonical Open Access Api Phrasing Overlay

11 actions · phrasing · canonical-open-access-api-openapi.yml

GENERATED

Canonical Operations Api Phrasing Overlay

13 actions · phrasing · canonical-operations-api-openapi.yml

GENERATED

Canonical Operationservice Api Phrasing Overlay

3 actions · phrasing · canonical-operationservice-api-openapi.yml

GENERATED

Canonical Pebble Api Overlay

3 actions · update · canonical-pebble-api-openapi.yml

GENERATED

Canonical Permissions Api Phrasing Overlay

4 actions · phrasing · canonical-permissions-api-openapi.yml

GENERATED

Canonical Placement Groups Api Phrasing Overlay

9 actions · phrasing · canonical-placement-groups-api-openapi.yml

GENERATED

Canonical Plan Api Phrasing Overlay

2 actions · phrasing · canonical-plan-api-openapi.yml

GENERATED

Canonical Profiles Api Phrasing Overlay

9 actions · phrasing · canonical-profiles-api-openapi.yml

GENERATED

Canonical Projects Api Phrasing Overlay

11 actions · phrasing · canonical-projects-api-openapi.yml

GENERATED

Canonical Publicationservice Api Phrasing Overlay

7 actions · phrasing · canonical-publicationservice-api-openapi.yml

GENERATED

Canonical Publicationtargetservice Api Phrasing Overlay

7 actions · phrasing · canonical-publicationtargetservice-api-openapi.yml

GENERATED

Canonical Queues Api Phrasing Overlay

4 actions · phrasing · canonical-queues-api-openapi.yml

GENERATED

Canonical Region Api Phrasing Overlay

2 actions · phrasing · canonical-region-api-openapi.yml

GENERATED

Canonical Replicators Api Phrasing Overlay

11 actions · phrasing · canonical-replicators-api-openapi.yml

GENERATED

Canonical Reports Api Phrasing Overlay

3 actions · phrasing · canonical-reports-api-openapi.yml

GENERATED

Canonical Restricted Queues Api Phrasing Overlay

5 actions · phrasing · canonical-restricted-queues-api-openapi.yml

GENERATED

Canonical Result Api Phrasing Overlay

8 actions · phrasing · canonical-result-api-openapi.yml

GENERATED

Canonical Rolesservice Api Phrasing Overlay

10 actions · phrasing · canonical-rolesservice-api-openapi.yml

GENERATED

Canonical Root Api Phrasing Overlay

3 actions · phrasing · canonical-root-api-openapi.yml

GENERATED

Canonical Schema Api Phrasing Overlay

2 actions · phrasing · canonical-schema-api-openapi.yml

GENERATED

Canonical Schemasservice Api Phrasing Overlay

8 actions · phrasing · canonical-schemasservice-api-openapi.yml

GENERATED

Canonical Search Api Phrasing Overlay

2 actions · phrasing · canonical-search-api-openapi.yml

GENERATED

Canonical Secrets Api Phrasing Overlay

3 actions · phrasing · canonical-secrets-api-openapi.yml

GENERATED

Canonical Security Api Phrasing Overlay

18 actions · phrasing · canonical-security-api-openapi.yml

GENERATED

Canonical Sentry Debug Api Phrasing Overlay

2 actions · phrasing · canonical-sentry-debug-api-openapi.yml

GENERATED

Canonical Server Api Phrasing Overlay

8 actions · phrasing · canonical-server-api-openapi.yml

GENERATED

Canonical Service Api Phrasing Overlay

3 actions · phrasing · canonical-service-api-openapi.yml

GENERATED

Canonical Services Api Phrasing Overlay

3 actions · phrasing · canonical-services-api-openapi.yml

GENERATED

Canonical Session Api Phrasing Overlay

12 actions · phrasing · canonical-session-api-openapi.yml

GENERATED

Canonical Signals Api Phrasing Overlay

2 actions · phrasing · canonical-signals-api-openapi.yml

GENERATED

Canonical Snapd Rest Api Overlay

2 actions · update · canonical-snapd-rest-api-openapi.yml

GENERATED

Canonical Snaps Api Phrasing Overlay

11 actions · phrasing · canonical-snaps-api-openapi.yml

GENERATED

Canonical Status Api Phrasing Overlay

2 actions · phrasing · canonical-status-api-openapi.yml

GENERATED

Canonical Statusservice Api Phrasing Overlay

3 actions · phrasing · canonical-statusservice-api-openapi.yml

GENERATED

Canonical Storage Api Phrasing Overlay

53 actions · phrasing · canonical-storage-api-openapi.yml

GENERATED

Canonical System Info Api Phrasing Overlay

2 actions · phrasing · canonical-system-info-api-openapi.yml

GENERATED

Canonical Tasks Api Phrasing Overlay

2 actions · phrasing · canonical-tasks-api-openapi.yml

GENERATED

Canonical Teams Api Phrasing Overlay

7 actions · phrasing · canonical-teams-api-openapi.yml

GENERATED

Canonical Tenantservice Api Phrasing Overlay

12 actions · phrasing · canonical-tenantservice-api-openapi.yml

GENERATED

Canonical Test Cases Api Phrasing Overlay

6 actions · phrasing · canonical-test-cases-api-openapi.yml

GENERATED

Canonical Test Executions Api Phrasing Overlay

17 actions · phrasing · canonical-test-executions-api-openapi.yml

GENERATED

Canonical Test Observer Api Overlay

3 actions · update · canonical-test-observer-api-openapi.json

GENERATED

Canonical Test Observer Api Phrasing Overlay

2 actions · phrasing · canonical-test-observer-api-openapi.yml

GENERATED

Canonical Test Plans Api Phrasing Overlay

2 actions · phrasing · canonical-test-plans-api-openapi.yml

GENERATED

Canonical Test Results Api Phrasing Overlay

2 actions · phrasing · canonical-test-results-api-openapi.yml

GENERATED

Canonical Testflinger Api Api Phrasing Overlay

2 actions · phrasing · canonical-testflinger-api-api-openapi.yml

GENERATED

Canonical Testflinger Api Overlay

2 actions · update · canonical-testflinger-api-openapi.json

GENERATED

Canonical Ubuntu Security Api Overlay

4 actions · update · canonical-ubuntu-security-api-openapi.json

GENERATED

Canonical Users Api Phrasing Overlay

6 actions · phrasing · canonical-users-api-openapi.yml

GENERATED

Canonical Version Api Phrasing Overlay

2 actions · phrasing · canonical-version-api-openapi.yml

GENERATED

Canonical Warnings Api Phrasing Overlay

7 actions · phrasing · canonical-warnings-api-openapi.yml

GENERATED

Scroll for all 130

JSON Schema 233

Standalone JSON Schema definitions for this provider's data models.

api.ApplicationsGetResponse

5 properties

JSON SCHEMA

apiauthz_groupsCreateGroupResp

3 properties

JSON SCHEMA

apiauthz_groupsGetGroupResp

3 properties

JSON SCHEMA

apiauthz_groupsListGroupsResp

4 properties

JSON SCHEMA

apiauthz_groupsUpdateGroupResp

3 properties

JSON SCHEMA

apigroupsCreateGroupResp

4 properties

JSON SCHEMA

apigroupsGetGroupResp

4 properties

JSON SCHEMA

apigroupsListGroupsResp

4 properties

JSON SCHEMA

AppActionRestart

0 properties

JSON SCHEMA

AppActionStart

0 properties

JSON SCHEMA

AppActionStop

0 properties

JSON SCHEMA

App

8 properties

JSON SCHEMA

ApplicationPatch

16 properties

JSON SCHEMA

ApplicationResponse

4 properties

JSON SCHEMA

Application

18 properties

JSON SCHEMA

ApplicationsDelete

2 properties

JSON SCHEMA

ArtefactBuildEnvironmentReviewResponse

6 properties

JSON SCHEMA

ArtefactBuildResponse

4 properties

JSON SCHEMA

ArtefactMatchingRulePatch

12 properties

JSON SCHEMA

ArtefactMatchingRuleRequest

12 properties

JSON SCHEMA

ArtefactMatchingRuleResponse

13 properties

JSON SCHEMA

ArtefactPatch

10 properties

JSON SCHEMA

ArtefactResponse

28 properties

JSON SCHEMA

ArtefactSearchResponse

4 properties

JSON SCHEMA

AssertionResult

4 properties

JSON SCHEMA

AuthGroupPost is used for renaming a group.

1 properties

JSON SCHEMA

AuthGroupPut contains the editable fields of a group.

2 properties

JSON SCHEMA

AuthGroup is the type for a LXD group.

6 properties

JSON SCHEMA

AuthGroupsPost is used for creating a new group.

3 properties

JSON SCHEMA

authorizationAddAllowedAppToGroupResp

2 properties

JSON SCHEMA

authorizationGetAllowedAppsInGroupResp

3 properties

JSON SCHEMA

authorizationGetAllowedGroupsForAppResp

3 properties

JSON SCHEMA

authorizationRemoveAllowedAppFromGroupResp

2 properties

JSON SCHEMA

authorizationRemoveAllowedAppsFromGroupResp

2 properties

JSON SCHEMA

authorizationRemoveAllowedGroupsForAppResp

2 properties

JSON SCHEMA

authz_groupsListUserGroupsResp

4 properties

JSON SCHEMA

authz_groupsListUsersInGroupResp

4 properties

JSON SCHEMA

BaseResponse

3 properties

JSON SCHEMA

BatchGetLocalsRequest

2 properties

JSON SCHEMA

BatchGetLocalsResponse

2 properties

JSON SCHEMA

BatchGetMirrorsRequest

2 properties

JSON SCHEMA

BatchGetMirrorsResponse

2 properties

JSON SCHEMA

BatchGetOperationsRequest

2 properties

JSON SCHEMA

BatchGetOperationsResponse

2 properties

JSON SCHEMA

CertificatePut

5 properties

JSON SCHEMA

Certificate

2 properties

JSON SCHEMA

CertificatesPost_2

8 properties

JSON SCHEMA

CertificatesPost

2 properties

JSON SCHEMA

CertificationStatusRequest

10 properties

JSON SCHEMA

CertifiedImageExistsResponse

7 properties

JSON SCHEMA

CertifiedResponse

7 properties

JSON SCHEMA

Change

11 properties

JSON SCHEMA

CheckActionResponse

0 properties

JSON SCHEMA

clientsClient

47 properties

JSON SCHEMA

clientsCreateClientResp

3 properties

JSON SCHEMA

clientsGetClientResp

3 properties

JSON SCHEMA

clientsListClientsResp

4 properties

JSON SCHEMA

clientsRemoveClientResp

2 properties

JSON SCHEMA

clientsUpdateClientResp

3 properties

JSON SCHEMA

ClusterGroupPost represents the fields required to rename a cluster group.

1 properties

JSON SCHEMA

ClusterGroupPut represents the modifiable fields of a cluster group.

2 properties

JSON SCHEMA

ClusterGroup represents a cluster group.

4 properties

JSON SCHEMA

ClusterGroupsPost represents the fields available for a new cluster group.

3 properties

JSON SCHEMA

ClusterLinkPost represents the fields available for renaming a cluster link.

1 properties

JSON SCHEMA

ClusterLinkPut represents the modifiable fields of a cluster link.

2 properties

JSON SCHEMA

ClusterLink represents high-level information about a cluster link.

6 properties

JSON SCHEMA

ClusterLinkState represents the state of a linked cluster.

1 properties

JSON SCHEMA

ClusterLinksPost represents the fields available for a new cluster link.

9 properties

JSON SCHEMA

ClusterMemberPut

5 properties

JSON SCHEMA

ClusterMember represents the a LXD node in the cluster.

11 properties

JSON SCHEMA

ClusterMemberStatePost represents the fields required to evacuate a cluster member.

3 properties

JSON SCHEMA

ClusterPut

7 properties

JSON SCHEMA

Cluster represents high-level information about a LXD cluster.

3 properties

JSON SCHEMA

CollectionResponse

0 properties

JSON SCHEMA

ConfdbControlAction

4 properties

JSON SCHEMA

ConfigPost

2 properties

JSON SCHEMA

ConnectionStatus

4 properties

JSON SCHEMA

ContainerExecPost

5 properties

JSON SCHEMA

Container

21 properties

JSON SCHEMA

ContainersDelete

2 properties

JSON SCHEMA

ContainersPost

17 properties

JSON SCHEMA

DeviceCertificate

7 properties

JSON SCHEMA

Device

9 properties

JSON SCHEMA

EnvironmentReportedIssueRequest

4 properties

JSON SCHEMA

EnvironmentReportedIssueResponse

7 properties

JSON SCHEMA

EnvironmentReviewPatch

3 properties

JSON SCHEMA

EnvironmentsResponse

4 properties

JSON SCHEMA

Event

3 properties

JSON SCHEMA

ExecutionMetadataGetResponse

1 properties

JSON SCHEMA

FindResults

1 properties

JSON SCHEMA

GetChangeByIDResponse

0 properties

JSON SCHEMA

GetChangesResponse

0 properties

JSON SCHEMA

GetChecksResponse

0 properties

JSON SCHEMA

GetHealthOKResponse

0 properties

JSON SCHEMA

GetNoticeByIDResponse

0 properties

JSON SCHEMA

GetNoticesResponse

0 properties

JSON SCHEMA

GetPlanResponse

0 properties

JSON SCHEMA

groupsGetGroupIdentitiesResp

4 properties

JSON SCHEMA

IdentitiesBearerPost contains required information for the creation of a token identity.

3 properties

JSON SCHEMA

identitiesCreateIdentityBody

9 properties

JSON SCHEMA

identitiesCreateIdentityResp

4 properties

JSON SCHEMA

identitiesGetIdentityResp

4 properties

JSON SCHEMA

identitiesListIdentitiesResp

4 properties

JSON SCHEMA

IdentitiesTLSPost contains required information for the creation of a TLS identity.

5 properties

JSON SCHEMA

identitiesUpdateIdentityBody

7 properties

JSON SCHEMA

identitiesUpdateIdentityResp

4 properties

JSON SCHEMA

IdentityInfo expands an Identity to include effective group membership and effective permissions.

11 properties

JSON SCHEMA

IdentityProviderGroupPost is used for renaming an IdentityProviderGroup.

1 properties

JSON SCHEMA

IdentityProviderGroupPut contains the editable fields of an IdentityProviderGroup.

1 properties

JSON SCHEMA

IdentityProviderGroup represents a mapping between LXD groups and groups defined by an identity provider.

3 properties

JSON SCHEMA

IdentityProviderGroupsPost is used for creating an IdentityProviderGroup.

2 properties

JSON SCHEMA

IdentityPut contains the editable fields of an IdentityInfo.

2 properties

JSON SCHEMA

Identity is the type for an authenticated party that can make requests to the HTTPS API.

8 properties

JSON SCHEMA

idpsCreateIdpBody

16 properties

JSON SCHEMA

idpsCreateIdpResp

3 properties

JSON SCHEMA

idpsGetIdpResp

3 properties

JSON SCHEMA

idpsListIdpsResp

3 properties

JSON SCHEMA

idpsUpdateIdpBody

16 properties

JSON SCHEMA

idpsUpdateIdpResp

3 properties

JSON SCHEMA

Image_2

20 properties

JSON SCHEMA

ImageAliasesPost

5 properties

JSON SCHEMA

ImageExportPost

6 properties

JSON SCHEMA

ImagePut

5 properties

JSON SCHEMA

Image

10 properties

JSON SCHEMA

ImagesPost_2

9 properties

JSON SCHEMA

ImportLocalPackagesRequest

3 properties

JSON SCHEMA

Instance represents a LXD instance.

18 properties

JSON SCHEMA

InstanceFull is a combination of Instance, InstanceBackup, InstanceState and InstanceSnapshot.

21 properties

JSON SCHEMA

InstancePost represents the fields required to rename/move a LXD instance.

13 properties

JSON SCHEMA

Instance

23 properties

JSON SCHEMA

InstanceSnapshot represents a LXD instance snapshot.

13 properties

JSON SCHEMA

InstancesPost

14 properties

JSON SCHEMA

IssueAttachmentRequest

3 properties

JSON SCHEMA

IssuePutRequest

4 properties

JSON SCHEMA

IssueResponse

10 properties

JSON SCHEMA

IssueTestResultAttachmentRulePostRequest

12 properties

JSON SCHEMA

IssuesGetResponse

4 properties

JSON SCHEMA

LegacyInterfaceObject

2 properties

JSON SCHEMA

Level

0 properties

JSON SCHEMA

ListFilesResponse

0 properties

JSON SCHEMA

ListLocalPackagesResponse

2 properties

JSON SCHEMA

ListMirrorPackagesResponse

2 properties

JSON SCHEMA

Local

8 properties

JSON SCHEMA

logs

3 properties

JSON SCHEMA

MetadataConfiguration contains metadata about the LXD server configuration options.

2 properties

JSON SCHEMA

MinimalIssueTestResultAttachmentRuleResponse

13 properties

JSON SCHEMA

Mirror

20 properties

JSON SCHEMA

ModernInterfaceObject

0 properties

JSON SCHEMA

NetworkACL used for displaying an ACL.

8 properties

JSON SCHEMA

NetworkAllocations

6 properties

JSON SCHEMA

NetworkForwardPut

3 properties

JSON SCHEMA

NetworkForward used for displaying an network address forward.

5 properties

JSON SCHEMA

NetworkForwardsPost

4 properties

JSON SCHEMA

NetworkLease

6 properties

JSON SCHEMA

NetworkLoadBalancerPoolPut represents the modifiable fields of a LXD network load balancer pool.

3 properties

JSON SCHEMA

NetworkLoadBalancerPool used for displaying a network load balancer pool.

5 properties

JSON SCHEMA

NetworkLoadBalancerPoolState represents the state of a network load balancer pool.

1 properties

JSON SCHEMA

NetworkLoadBalancerPoolsPost represents the fields of a new LXD network load balancer pool.

4 properties

JSON SCHEMA

NetworkLoadBalancerPut

4 properties

JSON SCHEMA

NetworkLoadBalancer

6 properties

JSON SCHEMA

NetworkLoadBalancersPost

5 properties

JSON SCHEMA

NetworkPeerPut

2 properties

JSON SCHEMA

NetworkPeer used for displaying a LXD network peering.

7 properties

JSON SCHEMA

NetworkPeersPost

5 properties

JSON SCHEMA

NetworkPost

1 properties

JSON SCHEMA

NetworkPut

2 properties

JSON SCHEMA

Network

10 properties

JSON SCHEMA

NetworkState

10 properties

JSON SCHEMA

NetworkZonePut

2 properties

JSON SCHEMA

NetworkZoneRecordPut

3 properties

JSON SCHEMA

NetworkZoneRecord represents a network zone (DNS) record.

4 properties

JSON SCHEMA

NetworkZoneRecordsPost

4 properties

JSON SCHEMA

NetworkZone represents a network zone (DNS).

6 properties

JSON SCHEMA

NetworkZonesPost

3 properties

JSON SCHEMA

NetworksPost

4 properties

JSON SCHEMA

NoMetaSyncResponse

4 properties

JSON SCHEMA

NodeDelete

2 properties

JSON SCHEMA

NodePatch

12 properties

JSON SCHEMA

Node

22 properties

JSON SCHEMA

NodesPost

18 properties

JSON SCHEMA

NotCertifiedResponse

1 properties

JSON SCHEMA

Notice

11 properties

JSON SCHEMA

NotificationResponse

6 properties

JSON SCHEMA

NotificationsResponse

4 properties

JSON SCHEMA

OIDCSession contains session details for a current login.

7 properties

JSON SCHEMA

Operation_2

15 properties

JSON SCHEMA

OperationResponse

5 properties

JSON SCHEMA

Operation

5 properties

JSON SCHEMA

PatchedDeviceCertificate

7 properties

JSON SCHEMA

PatchedDevice

9 properties

JSON SCHEMA

PermissionInfo expands a Permission to include any groups that may have the specified Permission.

4 properties

JSON SCHEMA

Permission represents a permission that may be granted to a group.

3 properties

JSON SCHEMA

PlacementGroupPut

0 properties

JSON SCHEMA

PlacementGroup

0 properties

JSON SCHEMA

PlacementGroupsPost

0 properties

JSON SCHEMA

Plug

7 properties

JSON SCHEMA

PostExecRequest

14 properties

JSON SCHEMA

PostExecResponse

0 properties

JSON SCHEMA

PostFilesMakeDirsRequest

2 properties

JSON SCHEMA

PostFilesRemovePathsRequest

2 properties

JSON SCHEMA

PostFilesResponse

0 properties

JSON SCHEMA

PostLayersResponse

0 properties

JSON SCHEMA

PostNoticesResponse

0 properties

JSON SCHEMA

ProfilePost

1 properties

JSON SCHEMA

ProfilePut

3 properties

JSON SCHEMA

Profile

7 properties

JSON SCHEMA

ProfilesPost

4 properties

JSON SCHEMA

ProjectPost

1 properties

JSON SCHEMA

ProjectPut

2 properties

JSON SCHEMA

Project

6 properties

JSON SCHEMA

ProjectStatePut

1 properties

JSON SCHEMA

ProjectState

1 properties

JSON SCHEMA

ProjectsPost

5 properties

JSON SCHEMA

PromptingPrompt

5 properties

JSON SCHEMA

PromptingReply

4 properties

JSON SCHEMA

PromptingRuleActionAdd

2 properties

JSON SCHEMA

PromptingRuleActionRemove

2 properties

JSON SCHEMA

PromptingRule

6 properties

JSON SCHEMA

QuotaGroup

7 properties

JSON SCHEMA

ReadFilesResponse

2 properties

JSON SCHEMA

RefreshCheckResponse

0 properties

JSON SCHEMA

RefreshRequest

2 properties

JSON SCHEMA

RefreshResponse

1 properties

JSON SCHEMA

RelatedCertifiedSystemExistsResponse

14 properties

JSON SCHEMA

Slot

7 properties

JSON SCHEMA

SnapInfo

4 properties

JSON SCHEMA

Snap

26 properties

JSON SCHEMA

SyncMirrorRequest

6 properties

JSON SCHEMA

SystemActionCreate

6 properties

JSON SCHEMA

SystemActionInstall

2 properties

JSON SCHEMA

SystemDetails

8 properties

JSON SCHEMA

tenantLookupTenantsResponse

1 properties

JSON SCHEMA

ValidationSet

6 properties

JSON SCHEMA

Scroll for all 233

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Canonical Authentication

apiKey/oauth2 · 2 schemes

SECURITY

Canonical Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Canonical Vulnerability Disclosure

Hackerone

SECURITY

Canonical Trust Center

trust center published

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Canonical Scopes

3 scopes · authorizationCode

3 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Canonical Agentic Access

812 operations · 413 acting · 3 human-in-the-loop

812 operations · 413 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

SignUp

SignUp

Login

GettingStarted

GettingStarted

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 7

MCP servers, agent skills, and machine-readable catalogs

AgentSkill

AgentSkill

AgentSkill

AgenticAccess

WellKnown

LLMsTxt

AgentSkill

Scroll for all 7

Design & Contract 11

Pagination, idempotency, versioning, errors, and events

Spectral

JSONLD

Vocabulary

Components

Conventions

Idempotency

ErrorCatalog

DataModel

Lifecycle

Conformance

Webhooks

Scroll for all 11

Build 5

SDKs, sample code, and the tooling you integrate with

GitHubOrg

Packages

SDKs

CLI

GitHubOrganization

GitHubOrganization

Access & Security 8

Authentication, authorization, and security posture

OAuthScopes

Authentication

DomainSecurity

Compliance

TrustCenter

Security

VulnerabilityDisclosure

VulnerabilityDisclosure

SecurityTxt

SecurityTxt

Scroll for all 8

Learn 1

Tutorials, courses, talks, and written guidance

DiscourseForum

DiscourseForum

Operate 5

Status, limits, changes, and where to get help

Deprecation

StatusPage

ChangeLog

RateLimits

Support

Commercial 6

Pricing, plans, and the legal terms of use

FinOps

DataPrivacy

TermsOfService

Plans

Pricing

PrivacyPolicy

Company 4

The organization behind the API

LinkedIn

Website

Website

UbuntuWebsite

UbuntuWebsite

Blog

Blog

Other 16

Properties that don't map to a standard resource type

Hosts

Vendors

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

SnapStore

Charmhub

Launchpad

Overlay

Scroll for all 16

Source (apis.yml)

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
website:
  url: https://canonical.com
  method: probed
  source: homepage
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.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
common:
- type: FinOps
  url: finops/canonical-finops.yml
- type: Spectral
  url: rules/canonical-rules.yml
- type: JSONLD
  url: json-ld/canonical-context.jsonld
- type: Vocabulary
  url: vocabulary/canonical-vocabulary.yml
- type: Hosts
  url: hosts/canonical-hosts.yml
- type: Vendors
  url: vendors/canonical-vendors.yml
- type: AgentSkill
  url: skills/canonical-snapd-manage-snap.md
- type: Overlay
  url: overlays/canonical-lxd-rest-api-overlay.yaml
- type: AgentSkill
  url: skills/canonical-lxd-provision-instance.md
- type: Overlay
  url: overlays/canonical-ubuntu-security-api-overlay.yaml
- type: AgentSkill
  url: skills/canonical-ubuntu-security-cve-lookup.md
- type: Overlay
  url: overlays/canonical-pebble-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-testflinger-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-hardware-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-identity-platform-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-test-observer-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-anbox-cloud-ams-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-anbox-stream-gateway-api-overlay.yaml
- type: Overlay
  url: overlays/canonical-cos-registration-server-api-overlay.yaml
- type: OAuthScopes
  url: scopes/canonical-scopes.yml
- type: Authentication
  url: authentication/canonical-authentication.yml
- type: AgenticAccess
  url: agentic-access/canonical-agentic-access.yml
- type: DomainSecurity
  url: security/canonical-domain-security.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/canonical
- type: Website
  url: https://canonical.com/
- type: UbuntuWebsite
  url: https://ubuntu.com/
- type: Documentation
  url: https://documentation.ubuntu.com/
- type: GitHubOrg
  url: https://github.com/canonical
- type: SnapStore
  url: https://snapcraft.io/
- type: Charmhub
  url: https://charmhub.io/
- type: Launchpad
  url: https://launchpad.net/
- type: DiscourseForum
  url: https://discourse.ubuntu.com/
- type: DataPrivacy
  url: https://ubuntu.com/legal/data-privacy
- type: TermsOfService
  url: https://ubuntu.com/legal/terms
- type: Integrations
  url: https://canonical.com/partners
- url: https://canonical.com/blog/feed/
  type: Blog
- type: Packages
  url: packages/canonical-packages.yml
- type: SDKs
  url: packages/canonical-packages.yml
- type: CLI
  url: cli/canonical-cli.yml
- type: Components
  url: components/canonical-components.yml
- type: Conventions
  url: conventions/canonical-conventions.yml
- type: Idempotency
  url: conventions/canonical-conventions.yml
- type: ErrorCatalog
  url: errors/canonical-problem-types.yml
- type: DataModel
  url: data-model/canonical-data-model.yml
- type: Lifecycle
  url: lifecycle/canonical-lifecycle.yml
- type: Deprecation
  url: lifecycle/canonical-lifecycle.yml
- type: StatusPage
  url: https://status.canonical.com/
- type: ChangeLog
  url: changelog/canonical-changelog.yml
- type: Conformance
  url: conformance/canonical-conformance.yml
- type: Compliance
  url: security/canonical-trust-center.yml
- type: TrustCenter
  url: security/canonical-trust-center.yml
- type: Security
  url: security/canonical-vulnerability-disclosure.yml
- type: VulnerabilityDisclosure
  url: security/canonical-vulnerability-disclosure.yml
- type: WellKnown
  url: well-known/canonical-well-known.yml
- type: SecurityTxt
  url: well-known/canonical-security.txt
- type: LLMsTxt
  url: llms/canonical-llms.txt
- type: Webhooks
  url: asyncapi/canonical-launchpad-webhooks.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Overlay
  url: overlays/canonical-landscape-debarchive-provider-overlay.yaml
- type: Plans
  url: plans/canonical-plans-pricing.yml
- type: RateLimits
  url: rate-limits/canonical-rate-limits.yml
- type: Pricing
  url: https://ubuntu.com/pricing/pro
- type: SignUp
  url: https://ubuntu.com/pro/subscribe
- type: Login
  url: https://login.ubuntu.com/
- type: Support
  url: https://ubuntu.com/support
- type: PrivacyPolicy
  url: https://ubuntu.com/legal/data-privacy
- type: APIReference
  url: https://documentation.ubuntu.com/lxd/latest/rest-api/
- type: GettingStarted
  url: https://ubuntu.com/tutorials
- type: GitHubOrganization
  url: https://github.com/canonical
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
  - type: JSONSchema
    url: json-schema/canonical-assertion-result-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-refresh-request-schema.json
  - type: JSONSchema
    url: json-schema/canonical-snap-info-schema.json
  - type: JSONSchema
    url: json-schema/canonical-find-results-schema.json
  - type: JSONSchema
    url: json-schema/canonical-refresh-response-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-level-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-authorization-get-allowed-groups-for-app-resp-schema.json
  - type: JSONSchema
    url: json-schema/canonical-authorization-get-allowed-apps-in-group-resp-schema.json
  - type: JSONSchema
    url: json-schema/canonical-authorization-add-allowed-app-to-group-resp-schema.json
  - type: JSONSchema
    url: json-schema/canonical-authorization-remove-allowed-app-from-group-resp-schema.json
  - type: JSONSchema
    url: json-schema/canonical-authorization-remove-allowed-apps-from-group-resp-schema.json
  - type: JSONSchema
    url: json-schema/canonical-authorization-remove-allowed-groups-for-app-resp-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-api-applications-get-response-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-application-schema.json
  - type: JSONSchema
    url: json-schema/canonical-application-patch-schema.json
  - type: JSONSchema
    url: json-schema/canonical-no-meta-sync-response-schema.json
  - type: JSONSchema
    url: json-schema/canonical-applications-delete-schema.json
  - type: JSONSchema
    url: json-schema/canonical-operation-response-schema.json
  - type: JSONSchema
    url: json-schema/canonical-application-response-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-app-schema.json
  - type: JSONSchema
    url: json-schema/canonical-app-action-restart-schema.json
  - type: JSONSchema
    url: json-schema/canonical-app-action-stop-schema.json
  - type: JSONSchema
    url: json-schema/canonical-app-action-start-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-artefact-build-response-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-artefact-matching-rule-response-schema.json
  - type: JSONSchema
    url: json-schema/canonical-artefact-matching-rule-patch-schema.json
  - type: JSONSchema
    url: json-schema/canonical-artefact-matching-rule-request-schema.json
- 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
  - type: JSONSchema
    url: json-schema/canonical-artefact-response-schema.json
  - type: JSONSchema
    url: json-schema/canonical-artefact-patch-schema.json
  - type: JSONSchema
    url: json-schema/canonical-artefact-build-environment-review-response-schema.json
  - type: JSONSchema
    url: json-schema/canonical-artefact-build-response-schema.json
  - type: JSONSchema
    url: json-schema/canonical-environment-review-patch-schema.json
  - type: JSONSchema
    url: json-schema/canonical-artefact-search-response-schema.json
- 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


# --- truncated at 32 KB (271 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/apis.yml

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/canonical"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/canonical/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/canonical/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.