POST/services/{uuid}/databases/{database_uuid}/stop

Stop a service database

Stops a compose database container. Use this operation to queue a stop for the database identified by the service and database UUIDs.

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

2 parameters
uuidstringrequired
The UUID of the service that contains the database.
database_uuidstringrequired
The UUID of the compose service database to stop.

5 status codes
200Returns an object with a message confirming that the stop was queued.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service or service database does not exist.
messagestringoptional
501Returned when Swarm is not supported.

Error handling

A 400 is returned for an invalid token, and a 401 when authentication is missing. A 404 is returned when the uuid path parameter or database_uuid path parameter does not identify a resource. A 501 is returned when Swarm is not supported.