SQsquarecloud
Snapshots

Create a new snapshot of an application

Changed on

Captures a snapshot of the application 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 apps, not a failure. Poll the snapshot listing (GET /v2/apps/:appId/snapshots) ~2min later instead of re-posting.

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

Requires the workspace Administrator role (or ownership) when called against a workspace-shared application.

post/v2/apps/{appId}/snapshots

Request

Path parameters

appIdstring required

Application identifier. Optionally suffixed with -<workspaceId> to act on a workspace-shared application.

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