v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
VPS: Docker Manager

Get project contents

Retrieves the complete project information including the docker-compose.yml file contents, project metadata, and current deployment status.

This endpoint provides the full configuration and state details of a specific Docker Compose project.

Use this to inspect project settings, review the compose file, or check the overall project health.

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

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

contentstring

Contents of docker-compose file

environmentstring nullable

Project environment variables

Example response

{
  "content": "services:\n    my-app:\n        image: nginx\n        ports:\n            - \"80:80\"\n    my-db:\n        image: mysql",
  "environment": "VARIABLE1=value1\nVARIABLE2=value2"
}