PITR API

Point-in-time recovery API to restore a ScalixNova tenant database to an earlier moment through a single REST endpoint in Scalix Cloud.

REST API endpoints for PITR. 2 operations.

Restore to a point in time

plaintext

POST /api/v1/tenants/{tenant_id}/pitr/restore

Initiates a point-in-time restore of a tenant's database.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Responses

Status	Description
`200`	Restore initiated
`401`	Missing or invalid API key
`409`	Recovery target is beyond the archived WAL — retry with an earlier target, or omit the target to restore the latest recoverable point
`500`	Internal error

operationId: restorePitr

Branch a timeline

plaintext

POST /api/v1/tenants/{tenant_id}/timelines/{timeline_id}/branch

Restores the parent timeline's durable base backup + archived WAL into a NEW compute worker replayed to branch_lsn (0 = latest), then routes the branch endpoint. The branch archives onto its own timeline from that point.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)
`timeline_id`	path	`string`	Yes	Parent timeline id (UUID), or `main` for the primary timeline

Request body

application/json (required) — schema BranchTimelineRequest.

Responses

Status	Description
`201`	Branch created and routed
`400`	Invalid tenant, timeline, or new_timeline_id
`401`	Missing or invalid API key
`409`	Branch LSN is beyond the archived WAL
`500`	Internal error
`501`	Durability is not configured for this deployment
`503`	No compute capacity for the branch worker

operationId: branchTimeline