Retry checkpoint build

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Starts a new preview build for a checkpoint and returns without waiting for it to finish.

Use it when a checkpoint's preview_status in List checkpoints is failed. It works on a checkpoint in any state. When the checkpoint's commit already has a build, nothing is rebuilt and the checkpoint is marked ready straight away.

The build runs in the background. Poll List checkpoints and watch the checkpoint's preview_status until it's ready or failed. When it fails, build_error.message says why.

Only one build of a commit runs at a time. Retrying while another build of the same commit is still running doesn't start a second one in parallel. The retry waits for that build and only builds again if it didn't succeed. If the wait runs too long, the checkpoint is marked failed with a build_error.message saying it timed out waiting for another build, and you can retry once that build has finished.

<Warning>A checkpoint whose git_commit_hash is null was saved before the app's code was kept in git. Retrying its build first saves that checkpoint's code to the app as a new commit, which changes the app's current code.</Warning>

<Note>This endpoint accepts a personal API key. A read-only key is refused, and workspace API keys are not accepted.</Note>

post/api/apps/{app_id}/app-checkpoints/{checkpoint_id}/retry-build

Path parameters

checkpoint_idstring required

ID of the checkpoint, as returned in id by List checkpoints.

ID of the checkpoint, as returned in id by List checkpoints.

app_idstring required

ID of the app.

ID of the app.

Response

Where the build stands, and the commit being built.

status'building' | 'ready' | 'skipped' required

Where the build stands when the call returns. Either building (the build started in the background), ready (the checkpoint's commit was already built, so nothing was rebuilt), or skipped (the app was imported from an external repository, and those apps have no preview build).

git_commit_hashstring required

Git commit hash of the code being built, the same as the checkpoint's git_commit_hash.

Example response

{
  "status": "building",
  "git_commit_hash": "a1b2c3d4e5f67890abcdef1234567890abcdef12"
}

Changes

Changed in 1 of the 18 revisions of this API.1

Of the 18 revisions, 1 has no diff computed.