Skip to main content
POST
Stop Database
string
required
The ID of the database to stop. If the database belongs to a workspace, pass its ID in the workspace_id query parameter.
string
If the database belongs to a workspace, the workspace’s ID. Required for workspace members acting on a database they don’t own.
Stopping is idempotent. Stopping a database that is already stopped is a success, not an error: the API answers 200 and makes sure the recorded state is down. You do not have to read the status first to decide whether the call is safe.

Response

object
The response containing the operation status.

Error Responses

string
The error code indicating the reason for the failure. Possible values:
  • DATABASE_NOT_FOUND: The specified database does not exist.
  • ACCESS_DENIED: The user does not have permission to act on the database.
  • OPERATION_IN_PROGRESS: Another lifecycle operation on the same database is already running (409). The container was not touched — wait a few seconds and retry. See Common Error Codes.