VPS_getProjectContainersV1
Retrieve detailed container information for a Docker Compose project, including status, port mappings, and configuration. Monitor service health and runtime state on virtual machines.
Instructions
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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectName | Yes | Docker Compose project name using alphanumeric characters, dashes, and underscores only | |
| virtualMachineId | Yes | Virtual Machine ID |
Implementation Reference
- types.d.ts:1161-1173 (schema)Schema definition for the VPS_getProjectContainersV1 tool in the APITools interface, specifying input parameters (virtualMachineId: number, projectName: string) and generic response.
"VPS_getProjectContainersV1": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API };