ListAppsOK
False when the Docker Engine is not reachable.
Set alongside available=false with the reason and a remediation.
apps object[]required
The container's HEALTHCHECK result, in the Engine's own vocabulary; none when the container defines no health check.
Possible values: [none, starting, healthy, unhealthy]
The image repository, without its tag.
The Docker Engine's own container state vocabulary.
Possible values: [created, running, paused, restarting, removing, exited, dead]
Human-readable Engine status, e.g. "Up 3 hours".
The name of the installed stack that started this container, decided by the daemon from the container's Compose project and the directory Compose ran it from. Absent for a container no stack manages (one started by hand or by another tool). Set by listApps and getApp; the responses of the start, stop and restart operations do not carry it.
When the Engine created the container. Set by getApp only; the listing and the responses of the start, stop and restart operations do not carry it.
When the Engine last started the container. Absent for a container that has never run. Set by getApp only.
How many times the Engine's restart policy has restarted the container. Set by getApp only.
Possible values: >= 0
ports object[]required
Absent when this container port is not published to the host.
Possible values: [tcp, udp, sctp]
mounts object[]required
Each mount with a host path carries its location, set by listApps and getApp.
location object
Which storage a mount's host path lies on, decided from the path alone against the daemon's known mount points (the pool at /mnt/user, each data disk's and the cache disk's mount point). Nothing is read from a data disk to decide it, so a listing never wakes one.
pool is a path under /mnt/user, whose files may be on any data disk. disk is a path under one data disk's own mount point. cache is a path under the cache disk. outside is anywhere else, including the boot device.
Possible values: [pool, disk, cache, outside]
For pool, the first directory under /mnt/user, which is the share's name. Absent for the pool's root itself.
For disk, the data disk's number.
Possible values: >= 1
{
"available": true,
"message": "string",
"apps": [
{
"id": "string",
"name": "string",
"health": "none",
"image": "string",
"tag": "string",
"state": "created",
"status": "string",
"stack": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"startedAt": "2024-07-29T15:51:28.071Z",
"restartCount": 0,
"ports": [
{
"hostIP": "string",
"hostPort": 0,
"containerPort": 0,
"protocol": "tcp"
}
],
"mounts": [
{
"source": "string",
"destination": "string",
"mode": "string",
"readWrite": true,
"location": {
"kind": "pool",
"share": "string",
"disk": 0
}
}
]
}
]
}