Get project contents

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

Get project contents

get

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.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

virtualMachineIdintegerRequired

Virtual Machine ID

Example: 1268054

projectNamestring · min: 3 · max: 64Required

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

Example: my-docker-project

Responses

200

Success response

application/json

contentstringOptional

Contents of docker-compose file

Example: services: my-app: image: nginx ports: - "80:80" my-db: image: mysql

environmentstring · nullableOptional

Project environment variables

Example: VARIABLE1=value1 VARIABLE2=value2

401

Unauthenticated response

application/json

422

Validation error response

application/json

500

Error response

application/json

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

GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName} HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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