Skip to main content
POST
Restore Application Snapshot
string
required
The ID of the application or database to restore the snapshot to.
string
required
The ID of the snapshot to restore.
string
required
The resource type. Possible values: applications, databases.
string
Optional. Override the target resource for cross-resource restore. If omitted, restores to the resource specified by id.
boolean
Only for an application that runs a custom Docker image. When true, the restore also goes back to the image version the application ran when the snapshot was taken, if it still exists. Default false: only the data is restored and the application keeps its current image version.

Response

object
Confirmation that the restoration process was triggered.

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 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_ENGINE_MISMATCH: The snapshot belongs to a different database engine than the target (400).
  • SNAPSHOT_VERSION_NEWER: The snapshot was taken on a newer major version than the target database; nothing is changed (400).
  • SNAPSHOT_NOT_FOUND: The specified snapshot does not exist.
  • INVALID_ZIP_STRUCTURE: The snapshot file is damaged, or an application snapshot has no files (400). The restore is refused before anything changes: the application’s files and the database stay as they were.
  • OPERATION_IN_PROGRESS: Another lifecycle operation on the same resource is already running (409). Nothing was restored — wait a few seconds and retry. See Common Error Codes.
  • SNAPSHOT_IMPORT_FAILED: The restore failed while loading the data (500). The database is left running and empty; the snapshot stays available to retry.
  • INTERNAL_SERVER_ERROR: An unexpected server error occurred.
Last modified on October 26, 2026