PITR

Branch a timeline.

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.

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

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/api/v1/tenants/{tenant_id}/timelines/{timeline_id}/branch
  • Auth: HTTP bearer

Path parameters

tenant_idstring required

Tenant id (UUID)

timeline_idstring required

Parent timeline id (UUID), or main for the primary timeline

Request body

new_timeline_idstring nullable

Explicit id (UUID) for the new branch timeline; server-generated when omitted.

branch_lsninteger

LSN to branch at; 0 (the default) branches at the latest recoverable point.

Response

Branch created and routed

timeline_idstring required

The new branch timeline id.

parent_timeline_idstring required

The timeline the branch was taken from.

branch_lsninteger required

LSN the branch was taken at (0 = latest).

statusstring required

Always ready on success.

Example response

{
  "status": "ready"
}

Changes

No recorded changes to this operation across all 1 revision of this API.