Skip to main content
Use this endpoint to retrieve all snapshots stored in your Virtus Cloud account. By default it returns application snapshots, but you can switch to database snapshots by passing the scope query parameter. Each snapshot entry includes its size, last modification date, and a pre-signed download key you can use to retrieve the backup file.

​
Request

GET https://api.virtuscloud.app/v2/users/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

​
Query Parameters

​
scope
string
default:"applications"
Specifies which type of snapshots to return. Accepted values:
  • applications (default) — returns snapshots for your hosted applications.
  • databases — returns snapshots for your managed databases.

​
Response

​
status
string
Returns "success" when the request completes successfully.
​
response
array
An array of snapshot objects, ordered from most recent to oldest.

​
Examples

curl -X GET "https://api.virtuscloud.app/v2/users/snapshots?scope=applications" \
  -H "Authorization: <api_key>"

​
Response Example

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=accesskey"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey"
    }
  ]
}