SYsymbol
snapshot

Restore the personal workspace to a snapshot, or preview it with dryRun

Changed on
post/api/preview/snapshots/{id}/restore

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/snapshots/{id}/restore
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Path parameters

idstring required

UUID v4 string

Request body

confirmation_tokenstring

The token a dry run of this snapshot returned, within 15 minutes of it. A real restore without a valid one is refused with dry_run_required: from the start for Symbol's assistant tools and CLI (requests sending x-symbol-ai-client) and for a token that is sent but does not verify, and for any other API key or organization key from the effective date in the API changelog (issue #2522). A browser session does not send one.

dryRunboolean

Preview the restore without writing anything.

Response

Successful response

confirmation_expires_atstring

Present on a dry run: when confirmation_token stops being accepted (ISO 8601).

confirmation_tokenstring

Present on a dry run. Send it as confirmation_token with dryRun: false to restore this snapshot. A restore without it is refused with dry_run_required: from the start for Symbol's assistant tools and CLI, and for any other API key or organization key from the effective date in the API changelog.

Changes

  • 5778844d1f9eRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

  • c7729725d527Revision changes
    • info

      endpoint added