Skip to main content
Use this endpoint to create an on-demand snapshot of a running database. The API captures a consistent backup of the current database state and returns a pre-signed download URL along with an access key so you can retrieve the snapshot file immediately. Snapshots are also stored and retrievable later via the List Snapshots endpoint.

​
Request

POST https://api.virtuscloud.app/v2/databases/{databaseId}/snapshots

​
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 snapshot.

​
Response

​
status
string
Returns "success" when the snapshot is created and the download URL is ready.
​
response
object
Contains the download URL and key for the newly created snapshot.
The pre-signed download URL expires after a limited period. Download the snapshot file immediately after creation, or use the List Snapshots endpoint later to obtain a fresh key.

​
Examples

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

​
Response Example

{
  "status": "success",
  "response": {
    "url": "https://snapshots.virtuscloud.app/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key": "AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D"
  }
}