POST/services/{uuid}/restart

Restart a service

Restarts a service identified by its UUID. Set latest to pull the latest images as part of the restart. A 200 response returns a message confirming the restart request.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters
uuidstringrequired
The UUID of the service to restart.
latestbooleanoptional
Whether to pull the latest images before restarting. Defaults to false when omitted.
Default:false

4 status codes
200Returns a message confirming that the service restart request was processed.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service cannot be found.
messagestringoptional

Error handling

A 400 is returned for an invalid token, and a 401 when the request is unauthenticated. A 404 is returned when uuid does not identify an existing service.