Database Snapshots

Restore a database from a snapshot

Changed on Nov 13, 2026

Restores the database from a previous snapshot identified by snapshotId and versionId. The snapshot's database type must match the target database type.

Rate limits: 1 restore per 60s per user and 1 restore per 120s per database.

post/v2/databases/{databaseId}/snapshots/restore

Request

Base URL
https://api.squarecloud.app
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/squarecloud/apis/square-cloud-api/docs/v2/databases/:databaseId/snapshots/restore/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

databaseIdstring required

Database identifier.

Request body

snapshotIdstring required

Snapshot name from the listing (database id suffixed with _<type>, optionally _<origin>).

versionIdstring required

Response

Restore finished.

status'success' required

Changes

Nov 13, 2026e363e004303c Revision changes
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
Nov 2, 20264cf53a0d5577 Revision changes
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status

Operation history (8 revisions)