POST
/services/{uuid}/applications/{app_uuid}/startStart or redeploy a service application container
Starts or redeploys a single compose service application container by running docker compose up without dependencies. Use force and latest to control the operation's behavior; the request may pull an image or rebuild. A 200 response confirms that the deploy request was queued, not that it has completed.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
uuidstringrequired
The unique identifier of the service containing the application.
app_uuidstringrequired
The unique identifier of the compose service application to start or redeploy.
forcebooleanoptional
Controls whether to force the start or redeploy operation. Defaults to false when omitted.
latestbooleanoptional
Controls whether to use the latest image when starting or redeploying. Defaults to false when omitted.
200Returns a message confirming that the deploy request was queued.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service or service application cannot be found.
messagestringoptional
501Returned when Swarm is not supported.
Error handling
A 400 is returned for an invalid token; a 401 when the request is unauthenticated; a 404 when the service or application is not found; and a 501 when Swarm is unsupported. The uuid path parameter and app_uuid path parameter must identify the service and compose application; force and latest default to false when omitted.