Container List

Overview
The "Get Container List" API endpoint allows you to retrieve a list of deployed models for a specific user. This endpoint provides detailed information about each container, including the container's status, opened ports, container address, and GPU stats.

---

Example

• Method: GET

Endpoint

 https://api.gpulab.ai/containers

Headers

Header	Description	Type
api_key (string)	Your API Key for request authorization, must have read access.	string

Request Body

There is no request body required for this endpoint.

---

Response

Body (JSON)

{
    "status": "success",
    "message": [
        {
            "server_name": null,
            "opened_ports": "6006:8888,6009:3754,6010:no_port",
            "nas_server_id": 830,
            "container_address": "1e67de0c165c4ef",
            "container_status": "running",
            "isVisible": true,
            "container_error": "",
            "notes": null,
            "image_address": "",
            "created_at": "2024-11-19T09:22:17.164562",
            "model_id": 78,
            "parent_system_id": 26,
            "id": 2186,
            "public_urls": "https://1e67de0c165c4ef-8888.gpulab.co,https://1e67de0c165c4ef-3754.gpulab.co,https://1e67de0c165c4ef-6010.gpulab.co",
            "exposed_container_vm_fk": 8,
            "gpus": [
                {
                    "gpu_type": "NVIDIA GeForce RTX 4090",
                    "mem_used_percent": 2.230907018400912,
                    "gpu_status": true,
                    "physical_system_id": 26,
                    "tunnel_id": 2186,
                    "id": 80,
                    "gpu_uuid": "GPU-bab9ef7e-2fd1-c089-0bc6-656b3dbf638a",
                    "total_memory": 24564,
                    "memory_used": 548,
                    "gpu_index": "2",
                    "gpuprice": "$10.00 / hour"
                }
            ],
            "nas_server": {
                "id": 830,
                "volume_server_identifier": "dddac2f9e90b40a",
                "unit": null,
                "notes": null,
                "template_name": "Audio PUblic NEW update server ",
                "user_id": 4,
                "volume_space": 250,
                "region_type": null
            },
            "system_uptime": "8d 10h 46m 45s",
            "model_name": "Audio Server",
            "model_image_name": "adhikjoshi/audio-server:latest",
            "src": "https://images.pexels.com/photos/268533/pexels-photo-268533.jpeg"
        }
    ]
}