Skip to main content
POST
Restore a saved version of a canvas: the canvas i…

Authorizations

authorization
string
header
required

Path Parameters

projectId
string<uuid>
required

The project in the URL. The caller's project user is read from it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
workspaceId
string<uuid>
required

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/versions/:version/restore Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
canvasId
string<uuid>
required

The canvas to restore a saved version of.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
version
any
required

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/versions/:version/restore Parameter

Body

application/json

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/versions/:version/restore Request body

apiKey
string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1
organizationId
string

The ID of the organization. Required when using Supabase JWT authentication.

connectionId
string

The ID of the connection a guest has access to

created_by
string | null

The name to record as the new version's author.

Response

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/versions/:version/restore Positive response

status
string
required
Allowed value: "success"
data
object
required