Sign in

v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
VPS: Docker Manager

Create new project

Deploy new project from docker-compose.yaml contents or download contents from URL.

URL can be Github repository url in format https://github.com/[user]/[repo] and it will be automatically resolved to docker-compose.yaml file in master branch. Any other URL provided must return docker-compose.yaml file contents.

If project with the same name already exists, existing project will be replaced.

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

Path parameters

virtualMachineIdinteger required
Example:1268054

Virtual Machine ID

Request body

project_namestring required

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

contentstring required

URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file

environmentstring nullable

Project environment variables

Example request

{
  "project_name": "my-project-1"
}

Response

Success response

idinteger

Action ID

namestring

Action name

state'success' | 'error' | 'delayed' | 'sent' | 'created'

Action state

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 8123712,
  "name": "action_name",
  "state": "success",
  "created_at": "2025-02-27T11:54:00Z",
  "updated_at": "2025-02-27T11:58:00Z"
}