Skip to main content
Use this endpoint to take an on-demand snapshot of your application. The API captures the current state of your application’s filesystem, compresses it into a ZIP archive, and returns a time-limited pre-signed URL you can use to download it. Snapshots are ideal for creating restore points before deploying major changes or for backing up your application data programmatically.

​
Endpoint

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

​
Authorization

Include your API key in the request header: 
Authorization: <api_key>
Each account can create up to (RAM / 256) * 2 snapshots every 24 hours. Additionally, this endpoint enforces a rate limit of one request every 5 seconds.

​
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 snapshot has been created successfully.
​
response
object
An object containing the snapshot download information.

​
Examples

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

​
Response Example

{
  "status": "success",
  "response": {
    "url": "https://snapshots.virtuscloud.app/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
    "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D"
  }
}
The pre-signed url expires after a short window. Download the snapshot archive as soon as possible after receiving the response. To list previously created snapshots, use the List Snapshots endpoint.