Canonical

Canonical Containers API

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

Documentation GitHub OpenAPI

Operations 10

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

GET /1.0/containers List container endpoints · Get a list of containers #

Ask an LLM

“Which Anbox containers are running, as a list of endpoint URLs?”

“Can I filter the container list by application or status?”

Tell an agent

List the endpoint URLs of containers for app {app_name}.

List container URLs with status {status} on node {node}.

POST /1.0/containers Launch a new Android container · Create a new container instance #

Ask an LLM

“How do I launch an Android container from an application in Anbox Cloud?”

“Can I create a container from a raw image with custom CPU and memory?”

Tell an agent

Launch a container for application {app_id}.

Create a container from image {image_id} with {cpus} CPUs and {memory} memory.

DELETE /1.0/containers Delete several containers at once · Delete multiple containers #

Ask an LLM

“How do I delete a batch of containers in one request?”

“What happens if one container in a bulk delete fails?”

Tell an agent destructive · confirm first

Delete containers {ids}.

Force-delete all of these containers: {ids}.

GET /1.0/containers/{id} Get one container's details · Get information about a specific container instance #

Ask an LLM

“What status and node is a specific Anbox container on?”

“Can I look up a single container by its ID?”

Tell an agent

Show me container {id}.

Get the status and app details of container {id}.

DELETE /1.0/containers/{id} Delete a container · Delete a specific container #

Ask an LLM

“How do I delete a single Anbox container?”

“Can I force-delete a container that isn't stopping cleanly?”

Tell an agent destructive · confirm first

Delete container {id}.

Force-delete container {id}: {force}.

PATCH /1.0/containers/{id} Start or stop a container · Update the state of a specific container instance #

Ask an LLM

“How do I stop a running container or start a stopped one?”

“Can I change a container's desired status after it was created?”

Tell an agent

Set container {id} to desired status {desired_status}.

Stop container {id}.

POST /1.0/containers/{id}/exec Run a command inside a container · Execute a command in a container #

Ask an LLM

“How do I run a shell command inside an Android container?”

“Can I open an interactive terminal session into a container?”

Tell an agent

Run command {command} in container {id}.

Open an interactive shell in container {id} sized {width} by {height}.

GET /1.0/containers/{id}/logs List a container's collected logs · Get a list of collected log files for the container #

Ask an LLM

“Which log files did AMS collect for a container that went into error?”

“Are logs captured automatically when a container fails?”

Tell an agent

List the collected log files for container {id}.

Show which logs were gathered from errored container {id}.

GET /1.0/containers/{id}/logs/{name} Download a specific container log file · Retrieve a specific log file stored for the container #

Ask an LLM

“How do I read the raw contents of one log file from a container?”

“Can I download a single collected log by its name?”

Tell an agent

Download log file {name} from container {id}.

Show me the raw contents of log {name} for container {id}.

GET /1.0/containers?recursion=1 List containers with full details · Get a list of containers #

Ask an LLM

“How do I see every Anbox container with its app, image and node in one response?”

“Can I get full container records filtered by tag or image version?”

Tell an agent

Fetch full container records for application {app_id}.

Show detailed containers running image {image_id} version {image_version}.

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-containers-api-openapi.yml

Schemas & Data

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

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

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-container-exec-post-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-no-meta-sync-response-schema.json

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

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-containers-delete-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-containers-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:
  description: 'The Anbox Management Service (AMS) external REST API is the REST API used by

    all AMS clients. Note that internal endpoints are not included in this

    documentation.


    The AMS API is available over both a local unix+http and a remote https API.

    Authentication for local users relies on group membership and access to the

    unix socket. For remote users, the default authentication method is TLS client

    certificates.'
  title: AMS external REST Containers API
  version: '1.0'
tags:


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