Canonical

Canonical Experimental API

Interact with experimental features.

Documentation GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/confdb Delegate or withdraw remote confdb management · Delegate remote confdb management to operators #

Ask an LLM

“How do I let an operator remotely manage confdb values on my device?”

“Can I withdraw an operator's remote confdb access later?”

Tell an agent

Delegate confdb views {views} to operator {operator-id} with action {action}.

Run {action} for operator {operator-id} using authentications {authentications}.

GET /v2/interfaces/requests/prompts List outstanding access prompts · Retrieve all outstanding prompts #

Ask an LLM

“Which snap permission prompts are waiting for a reply?”

“Can I see pending access requests for a particular user?”

Tell an agent

List all outstanding access prompts.

Show pending prompts for user {user-id}.

GET /v2/interfaces/requests/prompts/{id} Get one access prompt · Retrieve a prompt by ID #

Ask an LLM

“What exactly is a particular pending prompt asking permission for?”

“Can I fetch a single access prompt by its ID?”

Tell an agent

Show prompt {id}.

Get the details of access prompt {id} for user {user-id}.

POST /v2/interfaces/requests/prompts/{id} Allow or deny an access prompt · Reply to a prompt #

Ask an LLM

“How do I allow or deny a snap's pending access request?”

“Can my answer to a prompt become a lasting rule with a set lifespan?”

Tell an agent

Reply {action} to prompt {id} for lifespan {lifespan} with constraints {constraints}.

Allow prompt {id} for {duration} under constraints {constraints}, lifespan {lifespan}.

GET /v2/interfaces/requests/rules List access prompting rules · Retrieve all rules #

Ask an LLM

“What prompting rules have been saved for my snaps?”

“Can I filter access rules by snap or interface?”

Tell an agent

List prompting rules for snap {snap}.

Show rules on interface {interface}.

POST /v2/interfaces/requests/rules Create an access rule or remove rules by selector · Create or remove rules #

Ask an LLM

“How do I add a new access rule without waiting for a prompt?”

“Can I delete a whole set of rules that match a selector?”

Tell an agent

Create a new prompting rule for user {user-id}.

Remove all access rules matching a selector.

GET /v2/interfaces/requests/rules/{id} Get one access rule · Retrieve a rule by ID #

Ask an LLM

“What does a specific prompting rule allow or deny?”

“Can I look up an access rule by its ID?”

Tell an agent

Show rule {id}.

Get access rule {id} for user {user-id}.

POST /v2/interfaces/requests/rules/{id} Patch or remove one access rule · Patch or remove a rule by ID #

Ask an LLM

“Can I edit an existing prompting rule by ID?”

“How do I delete a single access rule?”

Tell an agent

Patch prompting rule {id}.

Remove the single access rule {id}.

Documentation

https://snapcraft.io/docs/reference/development/snapd-rest-api/

https://ubuntu.com/landscape/docs

https://documentation.ubuntu.com/landscape/reference/api/

https://documentation.ubuntu.com/lxd/latest/rest-api/

https://documentation.ubuntu.com/lxd/latest/api-extensions/

https://ubuntu.com/security/api/docs

https://ubuntu.com/security/api/spec.json

https://documentation.ubuntu.com/pebble/

https://canonical-testflinger.readthedocs-hosted.com/en/latest/

https://documentation.ubuntu.com/anbox-cloud/

Specifications

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-experimental-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-prompting-reply-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-confdb-control-action-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-prompting-rule-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-prompting-prompt-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-prompting-rule-action-add-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-prompting-rule-action-remove-schema.json

Other Resources

https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/

https://documentation.ubuntu.com/landscape/reference/release-notes/

https://ubuntu.com/landscape

https://github.com/canonical/lxd

https://canonical.com/lxd

https://ubuntu.com/security

https://github.com/canonical/pebble

https://github.com/canonical/testflinger

https://github.com/canonical/hardware-api

https://ubuntu.com/certified

https://github.com/canonical/identity-platform-api

https://github.com/canonical/test_observer

https://canonical.com/anbox-cloud

https://github.com/canonical/cos-registration-server

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/canonical:canonical-experimental-api"

All apis

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

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.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Snapd REST Experimental API
  license:
    name: GPL-3.0
    url: https://www.gnu.org/licenses/gpl-3.0.txt
  version: '1.0'
  description: 'The REST API provides access to snapd''s state and many of its key functions,

    as listed below.


    For general information on how to use the API, including how to access it,

    its requests and responses, results fields and error types, see Using the

    REST API.'
servers:
- url: unix:///run/snapd.socket
  description: 'Local snapd socket access. Unless otherwise specified, routes appear on

    this socket.'
- url: unix:///run/snapd-snap.socket
  description: Snapd socket access for snaps
tags:


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