Skip to main content
Use this endpoint to list all snapshots that have been taken for your application. Each entry in the response includes the snapshot’s size, when it was last modified, and an AWS pre-signed query string you can use to construct a direct download URL. Snapshots are stored in Virtus Cloud’s secure object storage and are useful for disaster recovery and rollback scenarios.

​
Endpoint

GET https://api.virtuscloud.app/v2/apps/{app_id}/snapshots

​
Authorization

Include your API key in the request header: 
Authorization: <api_key>

​
Path Parameters

​
app_id
string
required
The unique identifier of your application. You can find this in the URL of your application’s dashboard.

​
Response

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

​
Constructing a Download URL

Use the following URL template to download a snapshot: 
https://snapshots.virtuscloud.app/applications/{accountID}/{name}.zip?{key}
Replace {accountID} with your Virtus Cloud account ID, {name} with the snapshot’s name field, and {key} with the snapshot’s key field.

​
Examples

curl --request GET \
  --url "https://api.virtuscloud.app/v2/apps/{app_id}/snapshots" \
  --header "Authorization: <api_key>"

​
Response Example

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    }
  ]
}
Pre-signed download keys expire after a set period. If a key has expired, request a fresh list of snapshots to obtain a new valid key.