Containers

Overview

The /v1/containers endpoint lists monitored containers along with their current image ID.

Include containers in http-api-endpoints to enable this read-only endpoint.

Parameters

Container Name

The name parameter filters results to a specific container by exact name.

curl -H "Authorization: Bearer mytoken" "localhost:8080/v1/containers?name=nginx"

Image Name

The image parameter filters results to containers running a specific image.

curl -H "Authorization: Bearer mytoken" "localhost:8080/v1/containers?image=nginx:latest"

Response Format

The /v1/containers endpoint returns a JSON array of watched containers:

{
    "containers": [
        {
            "name": "nginx",
            "image": "nginx:latest",
            "image_id": "sha256:1111...",
            "digest": "sha256:2222..."
        }
    ],
    "count": 1,
    "timestamp": "2025-01-20T11:30:45Z",
    "api_version": "v1"
}

• name: Container name
• image: Image reference with tag
• image_id: Local image config ID
• digest: Registry manifest digest the image was pulled from (from the image’s RepoDigests), directly comparable to a registry’s Docker-Content-Digest. Empty for locally-built images with no registry reference.