Sign Up

Docker

Docker Engine status

GET
/docker/status

Reports Docker Engine status and, when available, the process whose logs contain its output (GET /processes/{id}/logs). Read-only: this request never starts or restarts Docker. waitMs, capped at 1000, waits for starting to settle. A Docker failure is reported as failed and does not make the sandbox unusable.

Query Parameters

waitMs?integer

Wait up to this many milliseconds for a starting state to settle before answering. Clamped to 1000; omitted or 0 answers immediately.

Formatint64
Range0 <= value

Response Body

application/json
  1. response

GET /docker/status — the Docker Engine startup status for this boot. Read-only: asking never starts or restarts anything.

owner*DockerOwner

Who starts Docker.

Value in"none""daemon""entrypoint"
processId?|

ID of the process whose logs contain Docker output; read with GET /processes/{id}/logs. Null when no Docker process is available.

reason?|

Why the state is what it is (a failure cause, a storage limitation, or a note on a ready engine the sandbox user cannot reach). null when there is nothing to add.

state*DockerState

Startup state.

Value in"not_present""disabled""unmanaged""deferred""starting""ready""failed""unsupported"
curl -X GET 'http://sandbox:2280/docker/status'
{  "owner": "none",  "processId": "string",  "reason": "string",  "state": "not_present"}