v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB

VPS: Docker Manager

Get project containers

Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine.

This endpoint returns detailed information about each container including their current status, port mappings, and runtime configuration.

Use this to monitor the health and state of all services within your Docker Compose project.

get/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers

Path parameters

virtualMachineIdinteger required

Example:1268054

Virtual Machine ID

projectNamestring required

Example:my-docker-project

Docker Compose project name using alphanumeric characters, dashes, and underscores only

Response

Success response

idstring

Unique container identifier (short form of Docker container ID)

namestring

Container name as defined in docker-compose or assigned by Docker

imagestring

Docker image name and tag used to create this container

commandstring

Command being executed inside the container (may be truncated with ...)

statusstring

Human-readable container status including uptime, exit codes, or error information

Programmatic container lifecycle state for automated processing

health'starting' | 'healthy' | 'unhealthy' | ''

Container health status

Example response

[
  {
    "id": "bbd4c89e850d",
    "name": "nginx",
    "image": "nginx:latest",
    "command": "/docker-entrypoint.sh nginx -g daemon off;",
    "status": "Up 4 hours",
    "state": "running",
    "health": "healthy",
    "ports": [
      {
        "type": "published",
        "protocol": "tcp",
        "host_ip": "0.0.0.0",
        "host_port": 8080,
        "container_port": 80
      }
    ],
    "stats": {
      "cpu_percentage": 15.4,
      "memory_percentage": 0.4,
      "memory_used": 66532147.2,
      "memory_total": 16771847290.88,
      "net_in": 2110000,
      "net_out": 30100
    }
  }
]