canvases

Apply a lifecycle action (retry, pin, unpin, cancel) to one build.

post/api/projects/{project_id}/canvases/{id}/builds/action/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/builds/action/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this canvas.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

action'retry' | 'pin' | 'unpin' | 'cancel' required
  • retry - retry
  • pin - pin
  • unpin - unpin
  • cancel - cancel
build_idstring uuid required

Response

idstring uuid required

The build's id.

source_version_idstring uuid required

The source version this build compiled.

build_status'queued' | 'building' | 'ready' | 'failed' required
  • queued - queued
  • building - building
  • ready - ready
  • failed - failed
integritystring nullable required

Hex SHA-256 over the manifest — the artifact's integrity anchor. Null until ready.

artifact_urlstring nullable required

Signed URL for the ready build's entry HTML. Null until ready or when artifact delivery is unavailable.

pinnedboolean required

Pinned builds are retained for the lifetime of the canvas.

created_atstring date-time required

When the build was queued.

finished_atstring date-time nullable required

When the build reached a terminal state.

Changes

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