A container is a representation of a Docker container on a host.
Field | Type | Create | Update | Default | Notes |
---|---|---|---|---|---|
build | dockerBuild | Optional | - | - | |
capAdd | array[enum] | Optional | - | - | |
capDrop | array[enum] | Optional | - | - | |
command | array[string] | Optional | - | - | |
count | int | Optional | - | - | |
cpuSet | string | Optional | - | - | |
cpuShares | int | Optional | - | - | |
dataVolumeMounts | map[volume] | Optional | - | - | |
dataVolumes | array[string] | Optional | - | - | |
dataVolumesFrom | array[container] | Optional | - | - | |
description | string | Optional | Yes | - | |
devices | array[string] | Optional | - | - | |
dns | array[string] | Optional | - | - | |
dnsSearch | array[string] | Optional | - | - | |
domainName | string | Optional | - | - | |
entryPoint | array[string] | Optional | - | - | |
environment | map[string] | Optional | - | - | |
expose | array[string] | Optional | - | - | |
extraHosts | array[string] | Optional | - | - | |
healthCheck | instanceHealthCheck | Optional | - | - | |
hostname | string | Optional | - | - | |
imageUuid | string | Optional | - | - | |
instanceLinks | map[instance] | Optional | - | - | |
labels | map[string] | Optional | - | - | A map of key value pairs to be used as labels for the container |
logConfig | logConfig | Optional | - | - | |
lxcConf | map[string] | Optional | - | - | |
memory | int | Optional | - | - | |
memorySwap | int | Optional | - | - | |
name | string | Optional | Yes | - | |
networkContainerId | container | Optional | - | - | |
networkIds | array[network] | Optional | - | - | |
networkMode | enum | Optional | - | managed | The options are none , bridge , host , managed , container . |
pidMode | enum | Optional | - | - | The options are host . |
ports | array[string] | Optional | - | - | |
privileged | boolean | Optional | - | - | |
publishAllPorts | boolean | Optional | - | - | |
readOnly | boolean | Optional | - | - | |
registryCredentialId | registryCredential | Optional | - | - | |
requestedHostId | host | Optional | - | - | |
restartPolicy | restartPolicy | Optional | - | - | |
securityOpt | array[string] | Optional | - | - | |
startOnCreate | boolean | Optional | - | true | |
stdinOpen | boolean | Optional | - | - | |
tty | boolean | Optional | - | - | |
user | string | Optional | - | - | |
volumeDriver | string | Optional | - | - | |
workingDir | string | Optional | - | - |
Field | Type | Notes |
---|---|---|
createIndex | int | |
deploymentUnitUuid | string | |
externalId | string | |
firstRunning | date | |
healthState | enum | The options are healthy , unhealthy , updating-healthy , updating-unhealthy , initializing . |
hostId | host | The unique identifier for the associated host |
id | int | The unique identifier for the container |
nativeContainer | boolean | |
primaryIpAddress | string | |
startCount | int | |
systemContainer | enum | The options are NetworkAgent , LoadBalancerAgent . |
version | string |
Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.
CreatePOST: /v1/containers
DeleteDELETE: /v1/containers/${ID}
UpdatePUT: /v1/containers/${ID}
console
POST: /v1/containers/${ID}?action=console
execute
POST: /v1/containers/${ID}?action=execute
Input: ContainerExec
Field | Type | Required | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
attachStdin | No | true | attachStdout | No | true | command | array[string] | Yes | tty | No | true |
Output: An updated copy of the hostAccess resource
logs
POST: /v1/containers/${ID}?action=logs
Input: ContainerLogs
Field | Type | Required | Default | Notes | ||||
---|---|---|---|---|---|---|---|---|
follow | No | true | lines | No | 100 |
Output: An updated copy of the hostAccess resource
proxy
POST: /v1/containers/${ID}?action=proxy
Input: ContainerProxy
Field | Type | Required | Default | Notes | ||||
---|---|---|---|---|---|---|---|---|
port | No | 80 | scheme | No | http | The options are http , https . |
Output: An updated copy of the hostAccess resource
restart
POST: /v1/containers/${ID}?action=restart
start
POST: /v1/containers/${ID}?action=start
stop
POST: /v1/containers/${ID}?action=stop
Input: InstanceStop
Field | Type | Required | Default | Notes | ||||
---|---|---|---|---|---|---|---|---|
remove | No | timeout | No |
Output: An updated copy of the instance resource