Skip to content
Praxrr

Execute a PCD point-in-time restore

POST
/pcd/{databaseId}/snapshots/{snapshotId}/rollback
curl --request POST \
  --url https://example.com/api/v1/pcd/1/snapshots/1/rollback \
  --header 'Content-Type: application/json' \
  --data '{ "expectedCurrentStateHash": "example" }'

Restores PCD state to this snapshot by rewinding the append-only op log (issue #16). No op rows are deleted; a durable pre-rollback snapshot is captured first. The body’s expectedCurrentStateHash (from the preview) guards against an apply-after-change race — a mismatch returns 422 and the caller must regenerate the preview.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
databaseId
required
integer

PCD database ID

snapshotId
required
integer

PCD snapshot ID

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Request body to execute a rollback. expectedCurrentStateHash is a from-state value-guard echoed from the preview’s currentStateHash; if the live state changed since the preview the request is rejected with 422.

object
expectedCurrentStateHash
required

The preview’s currentStateHash (may be empty string when no published ops exist)

string
Examplegenerated
{
  "expectedCurrentStateHash": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Rollback executed

Media typeapplication/json
object
rollbackId
required
integer
snapshotId
required
integer
databaseId
required
integer
status
required
string
Allowed values: success failed
opsUndone
required

Ops written after the snapshot that were superseded

integer
opsReactivated
required

Pre-snapshot ops deactivated since that were re-published

integer
preRollbackSnapshotId
required

The durable pre-rollback capture that makes this rollback reversible

integer
nullable
targetStateHash
required
string
nullable
postVerified
required
boolean
error
required
string
nullable
createdAt
required
string format: date-time
Example
{
  "status": "success"
}

400

Section titled “400”

Invalid parameters or missing expectedCurrentStateHash

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Snapshot not found or doesn’t belong to database

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

409

Section titled “409”

Snapshot cannot be reconstructed/verified (unrestorable)

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

422

Section titled “422”

Database state changed since preview; regenerate the preview and retry

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Rollback execution failed

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}