Skip to main content
POST
/
v1
/
users
/
{id}
/
snapshots
/
{snapshot_id}
/
restore
Restore Application Snapshot
curl --request POST \
  --url https://api.vertracloud.app/v1/users/{id}/snapshots/{snapshot_id}/restore \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_id": "<string>"
}
'
{
  "response": {
    "message": "Restoration started and rebuild triggered"
  }
}
​
id
string
required
The ID of the application or database to restore the snapshot to.
​
snapshot_id
string
required
The ID of the snapshot to restore.
​
scope
string
required
The resource type. Possible values: applications, databases.
​
resource_id
string
Optional. Override the target resource for cross-resource restore. If omitted, restores to the resource specified by id.

​
Response

​
response
object
Confirmation that the restoration process was triggered.
{
  "response": {
    "message": "Restoration started and rebuild triggered"
  }
}

​
Error Responses

​
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated.
  • 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 or snapshot.
  • RESTORE_COOLDOWN: A restore operation was recently performed on this resource. Wait before retrying.
  • TYPE_MISMATCH: The snapshot resource type does not match the target resource type.
  • SNAPSHOT_NOT_FOUND: The specified snapshot does not exist.
  • UNKNOWN_ERROR: An unexpected error occurred in the wing.
  • INTERNAL_SERVER_ERROR: An unexpected server error occurred.
{
  "code": "UNAUTHORIZED"
}