Create Application Snapshot

POST

users

{id}

snapshots

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

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

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

package main

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

func main() {

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

	req, _ := http.NewRequest("POST", 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))

}

{
  "response": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "resource_id": "550e8400-e29b-41d4-a716-446655440001",
    "type": 1,
    "size": 1260,
    "resource_name": "my-bot",
    "created_at": "2026-09-16T15:00:00.000Z",
    "expires_at": "2026-10-16T15:00:00.000Z"
  }
}

string

required

The ID of the application or database to snapshot.

string

required

The resource type. Possible values: applications, databases.

Three limits apply to manual snapshots, on top of the route’s 5 requests per minute. The same resource can be snapshotted once every 5 minutes and up to 5 times per day, and an account can create, across all its resources, a number of snapshots per day that depends on the plan (5 on Starter 1 and 2, up to 64 on Enterprise). The day follows Brasília time. Over any limit the API answers 429 SNAPSHOT_RATE_LIMITED with details.scope (resource, resource_daily or account) and details.retry_after in seconds; with resource_daily and account, details also has limit and resets_at, the moment the budget resets, in ISO 8601. Snapshots the platform takes on its own (before a reset or a stack or image delete) do not count. A snapshot can be at most 4 GB (the compressed file). See Rate Limiting.

Response

object

The snapshot that was created.

Show Toggle object

string

The snapshot ID. Use it with restore and download.

string

The ID of the resource this snapshot belongs to.

number

1 for an application, 2 for a database.

number

Size in kilobytes.

string | null

The name the resource had at the moment the snapshot was taken.

string

When the snapshot was taken.

string

When the snapshot will be deleted automatically.

{
  "response": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "resource_id": "550e8400-e29b-41d4-a716-446655440001",
    "type": 1,
    "size": 1260,
    "resource_name": "my-bot",
    "created_at": "2026-09-16T15:00:00.000Z",
    "expires_at": "2026-10-16T15:00:00.000Z"
  }
}

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.
APP_NOT_FOUND: The specified application does not exist.
DATABASE_NOT_FOUND: The specified database does not exist.
ACCESS_DENIED: The user does not own the resource.
PLAN_NOT_ALLOWED: The account’s plan does not include manual snapshots (403).
DATABASE_NOT_RUNNING: The database must be running to take a snapshot (409). Redis has no such requirement.
SNAPSHOT_RATE_LIMITED: The resource was snapshotted less than 5 minutes ago, the resource already had 5 manual snapshots today, or the account already used its daily budget of manual snapshots (429). Comes with details.scope and details.retry_after; with resource_daily or account, also details.limit and details.resets_at.
SNAPSHOT_TOO_LARGE: The snapshot file would exceed the 4 GB limit (413).
OPERATION_IN_PROGRESS: Another lifecycle operation on the same resource is already running (409). Nothing was snapshotted — wait a few seconds and retry.
INTERNAL_SERVER_ERROR: The snapshot could not be stored, or an unexpected failure occurred (500). Retry later.

{
  "code": "AUTH_TOKEN_MISSING"
}

{
  "code": "PLAN_NOT_ALLOWED"
}

{
  "code": "SNAPSHOT_RATE_LIMITED",
  "details": {
    "scope": "resource",
    "retry_after": 212
  }
}

{
  "code": "SNAPSHOT_RATE_LIMITED",
  "details": {
    "scope": "resource_daily",
    "limit": 5,
    "retry_after": 14520,
    "resets_at": "2026-12-02T03:00:00.000Z"
  }
}

{
  "code": "SNAPSHOT_RATE_LIMITED",
  "details": {
    "scope": "account",
    "limit": 8,
    "retry_after": 14520,
    "resets_at": "2026-12-02T03:00:00.000Z"
  }
}

{
  "code": "OPERATION_IN_PROGRESS"
}

{
  "code": "DATABASE_NOT_RUNNING"
}

Last modified on November 8, 2026

Create Application Snapshot

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

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

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

package main

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

func main() {

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

	req, _ := http.NewRequest("POST", 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))

}

{
  "response": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "resource_id": "550e8400-e29b-41d4-a716-446655440001",
    "type": 1,
    "size": 1260,
    "resource_name": "my-bot",
    "created_at": "2026-09-16T15:00:00.000Z",
    "expires_at": "2026-10-16T15:00:00.000Z"
  }
}

Overview

Endpoints

Create Application Snapshot

Response

Error Responses

​Response

​Error Responses

Response

Error Responses