List images

client.images.list(?): ImageListResponse { created_at, digest, name, 8 more }

get/images

List images

ReturnsExpand Collapse

ImageListResponse = Array<Image { created_at, digest, name, 8 more } >

created_at: string

Creation timestamp (RFC3339)

formatdate-time

digest: string

Resolved manifest digest

name: string

Normalized OCI image reference (tag or digest)

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

Build status

Accepts one of the following:

"pending"

"pulling"

"converting"

"ready"

"failed"

cmd?: Array<string> | null

CMD from container metadata

entrypoint?: Array<string> | null

Entrypoint from container metadata

env?: Record<string, string>

Environment variables from container metadata

error?: string | null

Error message if status is failed

queue_position?: number | null

Position in build queue (null if not queued)

size_bytes?: number | null

Disk size in bytes (null until ready)

formatint64

working_dir?: string | null

Working directory from container metadata

List images

import Hypeman from '@onkernel/hypeman';

const client = new Hypeman({
  apiKey: 'My API Key',
});

const images = await client.images.list();

console.log(images);

[
  {
    "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"
  }
]