Skip to content
Get started

List images

get/images

List images

ReturnsExpand Collapse
created_at: string

Creation timestamp (RFC3339)

formatdate-time
digest: string

Resolved manifest digest

name: string

Normalized OCI image reference (tag or digest)

status: "pending" or "pulling" or "converting" or 2 more

Build status

Accepts one of the following:
"pending"
"pulling"
"converting"
"ready"
"failed"
cmd: optional array of string

CMD from container metadata

entrypoint: optional array of string

Entrypoint from container metadata

env: optional map[string]

Environment variables from container metadata

error: optional string

Error message if status is failed

queue_position: optional number

Position in build queue (null if not queued)

size_bytes: optional number

Disk size in bytes (null until ready)

formatint64
working_dir: optional string

Working directory from container metadata

List images
curl http://localhost:8080/images \
    -H "Authorization: Bearer $HYPEMAN_API_KEY"
[
  {
    "created_at": "2025-01-15T10:00:00Z",
    "digest": "sha256:abc123def456...",
    "name": "docker.io/library/nginx:latest",
    "status": "ready",
    "cmd": [
      "nginx",
      "-g",
      "daemon off;"
    ],
    "entrypoint": [
      "/docker-entrypoint.sh"
    ],
    "env": {
      "PATH": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
    },
    "error": "pull failed: connection timeout",
    "queue_position": 2,
    "size_bytes": 536870912,
    "working_dir": "/app"
  }
]
Returns Examples
[
  {
    "created_at": "2025-01-15T10:00:00Z",
    "digest": "sha256:abc123def456...",
    "name": "docker.io/library/nginx:latest",
    "status": "ready",
    "cmd": [
      "nginx",
      "-g",
      "daemon off;"
    ],
    "entrypoint": [
      "/docker-entrypoint.sh"
    ],
    "env": {
      "PATH": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
    },
    "error": "pull failed: connection timeout",
    "queue_position": 2,
    "size_bytes": 536870912,
    "working_dir": "/app"
  }
]