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.

Response

object
Confirmation that the restoration process was triggered.

Error Responses

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_ENGINE_MISMATCH: The snapshot belongs to a different database engine than the target (400).
  • SNAPSHOT_NOT_FOUND: The specified snapshot does not exist.
  • 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.
  • UNKNOWN_ERROR: An unexpected platform error occurred.
  • INTERNAL_SERVER_ERROR: An unexpected server error occurred.