Skip to main content

Start or recreate a Compose stack

POST 
/stacks/:name/start

Required role: admin. Only an account or token with the admin role can call this operation.

Example request
curl --request POST \
  --header "Authorization: Bearer $HOSERVA_TOKEN" \
  "https://$HOSERVA_HOST:8008/api/v1/stacks/{name}/start"

Queues a stack_start job (service class, scoped to the stack) that runs docker compose up --detach for the stack: its services are created if they do not exist and recreated only where their definition changed, so an edit saved by updateStack takes effect. Missing generated files are written from the stack's row first. Refused with 409 array_stopped while the array is stopped (maintenance mode) or its storage is not ready, and with 503 array_state_unknown if the array's state cannot be read; no job is queued. The job checks again when it runs. An unknown stack is refused with 404 stack_not_found and an invalid name with 400 invalid_stack_name.

Request​

Responses​

The queued job.