Runs

Fork Run

Changed on

Creates a new run from a checkpoint of the source run and starts it. The new run holds the source's records up to the checkpoint's position and continues from there in a fresh workspace restored to the checkpoint's commit. The source run is left untouched. A checkpoint inside a parallel branch cannot be forked at; fork at the parallel stage instead. Requires a GitHub target with run-branch creation and pushes enabled; the checkpoint commit must be available on the source run's published branch. The final terminal checkpoint is refused because it leaves no work to acquire a workspace. For a completed run, select an earlier checkpoint explicitly or retry the workflow from the beginning.

post/api/v1/runs/{id}/fork

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or API key in cookie __fabro_session

Path parameters

idstring required

Unique run identifier (ULID).

Request body

targetstring nullable

Optional checkpoint target such as @2, build, or build@1. Defaults to the latest checkpoint.

Response

New run created and started

source_run_idstring required
new_run_idstring required
targetstring required

The checkpoint the fork was resolved to, as @ordinal.

checkpoint_shastring required

The commit the new run's workspace starts on.

executioninteger required

The Petri execution of the fork position.

firinginteger required

The Petri firing of the fork position.

rerun_lastboolean required

Whether the position's stage runs again in the new run.

Changes