Anbox Cloud AMS API is one of 22 APIs that Canonical publishes on the 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.
This API exposes
72 operations
across 46 paths,
organized into 12 resource areas,
and defines 75 schemas.
It is described by OpenAPI 2.0, at version 1.0.
The identity and technical contract details declared by the specification.
Addon
object
Addon describes a package with additional functionality to be added to containers
3 properties
AddonPatch
object
AddonPatch allows updating an existing addon with a new version
AddonVersion
object
AddonVersion describes a single version of an addon
4 properties
AddonsPost
object
AddonsPost is used to create a new addon
1 property
Application
object
Application represents an AMS application
18 properties
ApplicationAddon
object
ApplicationAddon describes a specific version of an addon an application version uses
2 properties
ApplicationBootstrap
object
ApplicationBootstrap describes the fields used to configure the application bootstrap
1 property
ApplicationDelete
object
ApplicationDelete represents the fields used to delete an application
1 property
ApplicationExtraData
object
ApplicationExtraData represents an extra application data
3 properties
ApplicationHooks
object
ApplicationHooks describes the fields used to configure the hooks of an application
1 property
ApplicationPatch
object
ApplicationPatch represents the fields a user can modify
16 properties
ApplicationResources
object
ApplicationResources describes resources allocated for an application
5 properties
ApplicationResourcesPost
object
ApplicationResourcesPost represents the fields used to update an application resource
5 properties
ApplicationStatus
integer
ApplicationStatus represents the status an application can be in
ApplicationVersion
object
ApplicationVersion describes a single version of an application
19 properties
ApplicationVersionDelete
object
ApplicationVersionDelete represents the fields used to delete an application version
1 property
ApplicationVersionPatch
object
ApplicationVersionPatch represents the fields used to update an application version
1 property
ApplicationWatchdog
object
ApplicationWatchdog describes the fields used to update an application watchdog
2 properties
ApplicationsDelete
object
ApplicationsDelete represents a list of application to delete together
2 properties
Certificate
object
Certificate represents an available client certificate
2 properties
CertificatesPost
object
CertificatesPost represents the fields of a new auth provided certificate
2 properties
CollectionResponse
Collection Response
ConfigItem
object
ConfigItem represents a single configuration item
2 properties
ConfigPost
object
ConfigPost contains the field necessary to set or update a config item
2 properties
Container
object
Container represents a single container
21 properties
ContainerDelete
object
ContainerDelete describes a request used to delete a container
1 property
ContainerExecControl
object
ContainerExecControl represents a message on the container shell "control" socket
3 properties
ContainerExecPost
object
ContainerExecPost represents an container execution request
5 properties
ContainerPatch
object
ContainerPatch describes the fields which can be changed for an existing container
1 property
ContainerService
object
While NetworkServiceSpec defines what the user requests, ContainerService is what is actually opened on the container.
7 properties
ContainerStatus
integer
ContainerStatus represents the status a container can be in
ContainerType
string
Possible values are: regular, base, unknown
ContainersDelete
object
ContainersDelete represents a list of containers to delete together
2 properties
ContainersPost
object
ContainersPost represents the fields required to launch a new container for a specific application
17 properties
Event
object
Event defines the structure of an event sent on the events API endpoint
3 properties
Image
object
Image represents an image available in AMS
10 properties
ImageDelete
object
ImageDelete describes a request used to delete an image
1 property
ImagePatch
object
ImagePatch represents the fields to update an existing image
2 properties
ImageStatus
integer
ImageStatus represents the status of an image
ImageType
string
ImageType specifies the type of an image
ImageVersion
object
ImageVersion describes a single version of an image
7 properties
ImagesGet
object
ImagesGet represents a list of images
1 property
ImagesPost
object
ImagesPost represents the fields to upload a new image
4 properties
Instance
object
Instance represents a single instance
23 properties
InstanceDelete
object
InstanceDelete describes a request used to delete a instance
1 property
InstanceExecControl
object
InstanceExecControl represents a message on the instance shell "control" socket
3 properties
InstanceExecPost
object
InstanceExecPost represents an instance execution request
5 properties
InstancePatch
object
InstancePatch describes the fields which can be changed for an existing instance
1 property
InstanceResources
object
InstanceResources represents resources assigned to an instance
5 properties
InstanceService
object
While NetworkServiceSpec defines what the user requests, InstanceService is what is actually opened on the instance.
7 properties
InstanceStatus
integer
InstanceStatus represents the status a instance can be in
InstanceType
string
InstanceType describes the type of an instance (container, vm)
InstancesDelete
object
InstancesDelete represents a list of instances to delete together
2 properties
InstancesPost
object
InstancesPost represents the fields required to launch a new instance for a specific application
14 properties
NetworkProtocol
string
NetworkProtocol describes a specific network protocol like TCP or UDP a ContainerService can use
NetworkServiceSpec
object
NetworkServiceSpec is used to define the user defined network services that should be opened on a container
5 properties
NoMetaSyncResponse
object
Swagger Synchronous response without metadata field
4 properties
Node
object
Node describes a single node of the underlying LXD cluster AMS manages
22 properties
NodeDelete
object
NodeDelete describes a request used to delete a node
2 properties
NodeGPU
object
NodeGPU describes a single GPU available on a node
7 properties
NodeGPUAllocation
object
NodeGPUAllocation describes a single allocation on a GPU
3 properties
NodeGPUPatch
object
NodeGPUPatch allows changing configuration for individual GPUs
3 properties
NodePatch
object
NodePatch describes a request to update an existing node
12 properties
NodeStatus
integer
NodeStatus describes the current status of a node
NodeVPU
object
NodeVPU describes a single independent VPU available on a node
6 properties
NodeVPUAllocation
object
NodeVPUAllocation describes a single allocation for a VPU
2 properties
NodesPost
object
NodesPost describes a request to create a new node on AMS
18 properties
Operation
object
Operation represents a background operation
12 properties
OperationResponse
object
Operation
5 properties
ServiceStatus
object
ServiceStatus represents the status of the AMS service
7 properties
StatusCode
integer
StatusCode represents a valid REST operation
Task
object
Task is the scheduling unit AMS uses for container launches
4 properties
VersionGet
object
VersionGet is the JSON response from the API version request method
1 property
VersionResponse
object
VersionResponse shows the version for the running service
1 property
VideoEncoderType
string
VideoEncoderType describes the type of a video encoder is used by an application
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Canonical publishes across the network.