Skip to main content
POST
Create and start a Docker stack

Authorizations

Authorization
string
header
required

Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.

Path Parameters

id
string<uuid>
required

Service id of the cloud server.

Body

application/json
name
string
required

Stack name; lowercased before validation.

Pattern: ^[a-z0-9][a-z0-9-]{0,62}$
compose
string

Raw compose YAML. Takes precedence over the simple form and must have a services section.

Maximum string length: 60000
image
string

Simple form — container image reference.

ports
string[]
volumes
string[]
env
object

Environment variables; keys must match ^[A-Za-z_][A-Za-z0-9_]*$.

overwrite
boolean
default:false

Replace an existing stack of the same name.

Response

Stack created and started.

success
boolean
required