v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB

VPS: Docker Manager

Get project list

Retrieves a list of all Docker Compose projects currently deployed on the virtual machine.

This endpoint returns basic information about each project including name, status, file path and list of containers with details about their names, image, status, health and ports. Container stats are omitted in this endpoint. If you need to get detailed information about container with stats included, use the Get project containers endpoint.

Use this to get an overview of all Docker projects on your VPS instance.

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

Path parameters

virtualMachineIdinteger required

Example:1268054

Virtual Machine ID

Response

Success response

namestring

Docker Compose project name (derived from directory name or compose file)

statusstring

Raw output from docker compose ps command showing service count and states

state'running' | 'stopped' | 'created' | 'mixed' | 'unknown'

Derived project state parsed from the raw docker compose status

pathstring

Full filesystem path to the docker-compose.yml file

Example response

[
  {
    "name": "my-project",
    "status": "running(2)",
    "state": "running",
    "path": "/docker/my-project/docker-compose.yaml",
    "containers": [
      {
        "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
        }
      }
    ]
  }
]