Skip to main content
Use this endpoint to gracefully stop a running managed database. Stopping a database frees up compute resources while preserving all your data intact. You can restart it at any time using the Start endpoint.

​
Request

POST https://api.virtuscloud.app/v2/database/{databaseId}/stop

​
Headers

​
Authorization
string
required
Your Virtus Cloud API key. Pass it directly as the header value — no prefix required.Example: Authorization: vc_live_xxxxxxxxxxxx

​
Path Parameters

​
databaseId
string
required
The unique identifier of the database you want to stop. You can find this ID in the Create Database response or in the Virtus Cloud dashboard.

​
Response

​
status
string
Returns "success" when the stop command is accepted and the shutdown process has begun.
Any active connections to the database will be terminated when you stop it. Ensure your application handles connection errors gracefully before issuing this command in production.

​
Examples

curl -X POST https://api.virtuscloud.app/v2/database/a14b8d5e1cb7405a851eb4c075506121/stop \
  -H "Authorization: <api_key>"

​
Response Example

{
  "status": "success"
}