Sign in

v1

latestOpenAPI 3.1.02026-07-2675394318.9 KB
operations

Get an operation status

Returns the status of an operation.

For an EXECUTING INSTANCE operation, pass ?inflight=1 to also synthesize the partial result.stdout / result.stderr from the live event log. Off by default — each fetch with inflight triggers an extra subscribe RPC to the guest and drains its current events.gz, which is wasted work for clients that only poll for status transitions.

get/operations/{operationId}

Path parameters

operationIdstring uuid required

A UUID string

Example:12345678-9abc-baba-deda-0123456789ab

The ID of the operation

Query parameters

inflight'' | '0' | '1'

HTTP-flag boolean. Present without a value (?inflight) and ?inflight=1 both enable; ?inflight=0 and absence disable. When enabled and the operation is EXECUTING INSTANCE, partial stdout/stderr is synthesized from the live event log and attached under result.

Response

OK

uuidstring uuid

A UUID string

kind'image_import' | 'instance'

Type of the operation

status'PENDING' | 'ASSIGNED' | 'EXECUTING' | 'SUCCESS' | 'FAILED' | 'CANCELLED'
errorstring nullable
created_atstring

ISO 8601 formatted timestamp when the operation was created

durationnumber nullable
image_sizeinteger nullable

Bytes written for the resulting image/layer(s). null when not measured (e.g. disposable instance, non-SUCCESS operations).

consumed_cpunumber nullable

CPU seconds (user_cpu_time + system_cpu_time) reported by the in-VM init. null when not measured.

consumed_memoryinteger nullable

Peak memory (max_rss) reported by the in-VM init; units preserved as reported by getrusage. null when not measured.

image_uuidstring uuid

A UUID string

result_image_uuidstring uuid

A UUID string

Example response

{
  "uuid": "12345678-9abc-baba-deda-0123456789ab",
  "created_at": "2024-01-01T12:00:00+00:00",
  "image_uuid": "12345678-9abc-baba-deda-0123456789ab",
  "result_image_uuid": "12345678-9abc-baba-deda-0123456789ab",
  "metadata": {
    "command": "/bin/app",
    "hostname": "container-name",
    "image": "12345678-9abc-baba-deda-0123456789ab",
    "args": [
      "arg1",
      "arg2"
    ],
    "env": {
      "KEY1": "value1",
      "KEY2": "value2"
    },
    "cwd": "/app",
    "resources_limits": {
      "max_layer_bytes": 1073741824
    },
    "stdin": {
      "value": "aGVsbG8K"
    },
    "timeout": 60,
    "truncate_output_at": 65535,
    "files": {
      "/root/hello.txt": {
        "uuid": "a9165a5d-5c86-4bd8-8ee4-ae46c19cf45d",
        "uid": 0,
        "gid": 0,
        "mode": "0644"
      },
      "/tmp/log.txt": {
        "uuid": "065def2a-e977-4852-8b26-a0ec05e85a90",
        "uid": 1000,
        "gid": 1000,
        "mode": "0600"
      }
    },
    "result": {
      "stdout": {
        "value": "Y29tbWFuZCBvdXRwdXQK",
        "encoding": "base64"
      },
      "stderr": {
        "value": "Y29tbWFuZCBvdXRwdXQK",
        "encoding": "base64"
      }
    }
  },
  "result": {
    "image": "12345678-9abc-baba-deda-0123456789ab",
    "tag": "busybox:latest"
  }
}