Sign in

v51

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

Stop project

Stops all running services in a Docker Compose project while preserving container configurations and data volumes.

This operation gracefully shuts down containers in reverse dependency order.

Use this to temporarily halt a project without removing data or configurations.

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

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

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"
}