How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Containers API

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

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

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

This API exposes 10 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against the base URL https://api.snapcraft.io.

10 operations 6 paths 15 schemas 2 DELETE5 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 10

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

Containers 10
GET
/1.0/containers
Get a list of containers
containers_get 14 params → 200400404500
POST
/1.0/containers
Create a new container instance
containers_post body → 202400404500
DELETE
/1.0/containers
Delete multiple containers
containers_delete body → 202400404500
GET
/1.0/containers/{id}
Get information about a specific container instance
container_get 1 param → 200400404500
DELETE
/1.0/containers/{id}
Delete a specific container
container_delete 1 param body → 202400404500
PATCH
/1.0/containers/{id}
Update the state of a specific container instance
container_patch 1 param body → 202400404500
POST
/1.0/containers/{id}/exec
Execute a command in a container
container_exec_post 1 param body → 202400404500
GET
/1.0/containers/{id}/logs
Get a list of collected log files for the container
container_logs_get 1 param → 200400404500
GET
/1.0/containers/{id}/logs/{name}
Retrieve a specific log file stored for the container
container_logs_specific_get 2 params → 200400404500
GET
/1.0/containers?recursion=1
Get a list of containers
containers_get_recursion1 14 params → 200400404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Container (21 properties), ContainersPost (17 properties), Operation (12 properties), ContainerService (7 properties). Each schema is shown below with its type and property counts.

NetworkServiceSpec
object
NetworkServiceSpec is used to define the user defined network services that should be opened on a container
5 properties
ContainerType
string
Possible values are: regular, base, unknown
StatusCode
integer
StatusCode represents a valid REST operation
Operation
object
Operation represents a background operation
12 properties
ContainersDelete
object
ContainersDelete represents a list of containers to delete together
2 properties
ContainerStatus
integer
ContainerStatus represents the status a container can be in
NoMetaSyncResponse
object
Swagger Synchronous response without metadata field
4 properties
ContainerDelete
object
ContainerDelete describes a request used to delete a container
1 property
ContainerExecPost
object
ContainerExecPost represents an container execution request
5 properties
OperationResponse
object
Operation
5 properties
ContainerPatch
object
ContainerPatch describes the fields which can be changed for an existing container
1 property
NetworkProtocol
string
NetworkProtocol describes a specific network protocol like TCP or UDP a ContainerService can use
Container
object
Container represents a single container
21 properties
ContainersPost
object
ContainersPost represents the fields required to launch a new container for a specific application
17 properties
ContainerService
object
While NetworkServiceSpec defines what the user requests, ContainerService is what is actually opened on the container.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-containers-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Canonical Assertions API
Canonical Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Where this information came from

This is an independent, third-party profile of Canonical Containers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.