Stop project

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

Stop project

post

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.

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

idintegerOptional

Action ID

Example: 8123712

namestringOptional

Action name

Example: action_name

statestring · enumOptional

Action state

Example: successPossible values:

created_atstring · date-timeOptionalExample: 2025-02-27T11:54:00Z

updated_atstring · date-timeOptionalExample: 2025-02-27T11:58:00Z

401

Unauthenticated response

application/json

422

Validation error response

application/json

500

Error response

application/json

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

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

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