Download Application Snapshot

GET

users

{id}

snapshots

{snapshot_id}

download

Download Application Snapshot

curl --request GET \
  --url https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": "AUTH_TOKEN_MISSING"
}

{
  "code": "ACCESS_DENIED"
}

{
  "code": "SNAPSHOT_NOT_FOUND"
}

string

required

The ID of the application or database.

string

required

The ID of the snapshot to download.

string

required

The resource type. Possible values: applications, databases.

Response

The response is the ZIP file: 200 with the ZIP as the body, for snapshots of any size.

curl -o snapshot.zip \
  -H "Authorization: Bearer $VERTRA_API_KEY" \
  "https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download?scope=applications"

Requires the snapshots:read scope.

Error Responses

string

The error code indicating the reason for failure. Possible values:

AUTH_TOKEN_MISSING, API_KEY_INVALID, SESSION_REVOKED: The Authorization header is missing, the API key is invalid, or the dashboard session was revoked (401).
API_KEY_IP_DENIED, API_KEY_SCOPE_DENIED: The API key is used from an IP outside its allowlist, or it lacks the scope the route requires (403).
USER_NOT_FOUND: The authenticated user was not found.
ACCESS_DENIED: The snapshot does not belong to the authenticated user.
TEMPLATE_CLOSED: The snapshot belongs to an application from a closed template and cannot be downloaded (403).
SNAPSHOT_TYPE_MISMATCH: The snapshot’s resource type does not match the requested scope (400).
SNAPSHOT_NOT_FOUND: The specified snapshot does not exist.
INTERNAL_SERVER_ERROR: An unexpected server error occurred.

{
  "code": "AUTH_TOKEN_MISSING"
}

{
  "code": "ACCESS_DENIED"
}

{
  "code": "SNAPSHOT_NOT_FOUND"
}

Last modified on November 7, 2026

Download Application Snapshot

curl --request GET \
  --url https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/download"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": "AUTH_TOKEN_MISSING"
}

{
  "code": "ACCESS_DENIED"
}

{
  "code": "SNAPSHOT_NOT_FOUND"
}

Overview

Endpoints

Download Application Snapshot

Response

Error Responses

​Response

​Error Responses

Response

Error Responses