# Anbox Cloud AMS API

**Canonical:** https://apis.io/apis/canonical/anbox-cloud-ams-api/  
**Provider:** Canonical — https://apis.io/providers/canonical/  
**Documentation:** https://documentation.ubuntu.com/anbox-cloud/

Anbox Cloud AMS API is one of 22 APIs that [Canonical](https://apis.io/providers/canonical/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Android, Cloud, and Streaming. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The external REST API of the Anbox Management Service (AMS), the control plane of Canonical's Anbox Cloud product for running Android at scale. Covers applications, images, instances, nodes, addons, containers and configuration across 46 paths and 72 operations. AMS is built on the LXD codebase and inherits its response envelope and asynchronous operation model.

## Operations (60 of 72)

| Method | Path | Summary |
|---|---|---|
| GET | `/1.0/` | Get the status and features supported by the service |
| GET | `/1.0/addons` | Get a list of addons |
| POST | `/1.0/addons` | Create a new addon |
| GET | `/1.0/addons/{name}` | Get an addon |
| DELETE | `/1.0/addons/{name}` | Delete an addon |
| PATCH | `/1.0/addons/{name}` | Update an addon with a new package |
| DELETE | `/1.0/addons/{name}/{version}` | Delete an addon version |
| GET | `/1.0/addons?recursion=1` | Get a list of addons expanded |
| GET | `/1.0/applications` | Get a list of applications |
| POST | `/1.0/applications` | Create a new application |
| DELETE | `/1.0/applications` | Delete multiple applications |
| GET | `/1.0/applications/{id}` | Get information about an application |
| DELETE | `/1.0/applications/{id}` | Delete an application |
| PATCH | `/1.0/applications/{id}` | Update an application with a new package |
| PATCH | `/1.0/applications/{id}/` | Update an applications's metadata |
| GET | `/1.0/applications/{id}/manifest` | Get an application's manifest |
| GET | `/1.0/applications/{id}/{version}` | Get information about an application's specific version |
| DELETE | `/1.0/applications/{id}/{version}` | Delete a version of an application |
| PATCH | `/1.0/applications/{id}/{version}` | Update a specific version of an application |
| GET | `/1.0/applications/{id}/{version}/manifest` | Get the manifest for a specific version of an application |
| GET | `/1.0/applications?recursion=1` | Get a list of applications with expanded object definitions |
| GET | `/1.0/certificates` | Get a list of certificates |
| POST | `/1.0/certificates` | Add a new client certificate |
| GET | `/1.0/certificates/{fingerprint}` | Get the information about a certificate |
| DELETE | `/1.0/certificates/{fingerprint}` | Delete a client's trusted certificate |
| GET | `/1.0/certificates?recursion=1` | Get a list of expanded certificates |
| GET | `/1.0/config` | Get the current configuration of the service |
| PATCH | `/1.0/config` | Update service configuration |
| GET | `/1.0/containers` | Get a list of containers |
| POST | `/1.0/containers` | Create a new container instance |
| DELETE | `/1.0/containers` | Delete multiple containers. |
| GET | `/1.0/containers/{id}` | Get information about a specific container instance. |
| DELETE | `/1.0/containers/{id}` | Delete a specific container |
| PATCH | `/1.0/containers/{id}` | Update the state of a specific container instance |
| POST | `/1.0/containers/{id}/exec` | Execute a command in a container |
| GET | `/1.0/containers/{id}/logs` | Get a list of collected log files for the container |
| GET | `/1.0/containers/{id}/logs/{name}` | Retrieve a specific log file stored for the container |
| GET | `/1.0/containers?recursion=1` | Get a list of containers |
| GET | `/1.0/events` | Listen to events for changes in AMS |
| GET | `/1.0/images` | Get a list of images |
| POST | `/1.0/images` | Import an image |
| POST | `/1.0/images/` | Upload a package to create an image |
| GET | `/1.0/images/{id_or_name}` | Get information about an image |
| DELETE | `/1.0/images/{id}` | Delete an image |
| PATCH | `/1.0/images/{id}` | Update an image with a new package to upload |
| PATCH | `/1.0/images/{id}/` | Update an image's metadata |
| DELETE | `/1.0/images/{id}/{version}` | Delete an image version |
| GET | `/1.0/images?recursion=1` | Get the list of images expanded |
| GET | `/1.0/instances` | Get a list of instances |
| POST | `/1.0/instances` | Create a new instance |
| DELETE | `/1.0/instances` | Delete multiple instances. |
| GET | `/1.0/instances/{id_or_name}` | Get information about a specific instance instance. |
| DELETE | `/1.0/instances/{id_or_name}` | Delete a specific instance |
| PATCH | `/1.0/instances/{id_or_name}` | Update the state of a specific instance instance |
| POST | `/1.0/instances/{id_or_name}/exec` | Execute a command in a instance |
| GET | `/1.0/instances/{id_or_name}/logs` | Get a list of collected log files for the instance |
| GET | `/1.0/instances/{id_or_name}/logs/{name}` | Retrieve a specific log file stored for the instance |
| GET | `/1.0/instances?recursion=1` | Get a list of instances |
| GET | `/1.0/nodes` | Get a list of nodes |
| POST | `/1.0/nodes` | Create a node |

…and 12 more operations. They are listed in full on the page.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-anbox-cloud-ams-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/overlays/canonical-anbox-cloud-ams-api-overlay.yaml
- **Documentation** — https://documentation.ubuntu.com/anbox-cloud/
- **Portal** — https://canonical.com/anbox-cloud

## Other Canonical APIs (12)

- [Snap Store API](https://apis.io/apis/canonical/snap-store-api/)
- [Charmhub API](https://apis.io/apis/canonical/charmhub-api/)
- [snapd REST API](https://apis.io/apis/canonical/snapd-rest-api/)
- [MAAS API](https://apis.io/apis/canonical/maas-api/)
- [Juju Client / Controller API](https://apis.io/apis/canonical/juju-api/)
- [Launchpad Web Services API](https://apis.io/apis/canonical/launchpad-api/)
- [Ubuntu Pro Client API](https://apis.io/apis/canonical/ubuntu-pro-api/)
- [Landscape API](https://apis.io/apis/canonical/landscape-api/)
- [Canonical Assertions API](https://apis.io/apis/canonical/canonical-assertions-api/)
- [Canonical Search API](https://apis.io/apis/canonical/canonical-search-api/)
- [Canonical Snaps API](https://apis.io/apis/canonical/canonical-snaps-api/)
- [LXD REST API](https://apis.io/apis/canonical/lxd-rest-api/)

## Tags

Android, Cloud, Streaming

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/canonical/anbox-cloud-ams-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/canonical/.