Skip to content
calternal docs

Restore a previous version

POST
/api/v1/files/versions/restore
curl --request POST \
  --url https://example.com/api/v1/files/versions/restore \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_current_hash": "example", "path": "example", "version": "example" }'

Requires a signed-in User with the data scope and owner access to the Item. It returns 403 when access is denied or 507 when the restore cannot be stored. Route: /api/v1/files/versions/restore. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Select a stored Version, with an optional current-content guard for Undo (#770).

object
expected_current_hash
string
path
required
string
version
required
string
Examplegenerated
{
  "expected_current_hash": "example",
  "path": "example",
  "version": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Hash of the restored bytes and identity of the bytes replaced by that restore.

object
hash
required
string
replaced_version
string | null
Examplegenerated
{
  "hash": "example",
  "replaced_version": "example"
}

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

412

Section titled “412”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

507

Section titled “507”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}