SQsquarecloud
Database Snapshots

Create a new snapshot of a database

Changed on

Captures a snapshot of the database and returns a signed download URL valid for 1 hour (to a caller that can read snapshots: a key without snapshots:read gets an empty response).

The snapshot has a soft deadline: if it finishes within ~90s the response carries the signed URL. Otherwise the route answers 202 SNAPSHOT_PROCESSING while it keeps generating in the background — expected for large databases, not a failure. Poll the snapshot listing (GET /v2/databases/:databaseId/snapshots) ~2min later instead of re-posting.

Rate limits: 1 snapshot per 5s per user, 1 snapshot per 3min per database, and the plan's daily snapshot quota per user.

post/v2/databases/{databaseId}/snapshots

Request

Path parameters

databaseIdstring required

Database identifier.

Response

Snapshot created. url is a signed download URL valid for 1 hour, returned only to a caller that can read snapshots (a session, or a key with snapshots:read): a key without it gets an empty response.

status'success' required

Changes

  • e363e004303cRevision 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

  • 4cf53a0d5577Revision 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 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