Builds

cancelBuild

PUT /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/cancel

Cancel a build

Cancels an in-flight build in-process (transitions non-terminal jobs and tears down their sandboxes). Idempotent: cancelling an already-terminal build is a no-op. Returns the reloaded build with its updated state.

import { cancelBuild } from "@harmont/cloud";

cancelBuild(options): RequestResult<CancelBuildResponse>

Returns CancelBuildResponse

See PUT /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/cancel for the full request and response schema.

createBuild

POST /api/v0/organizations/{org}/pipelines/{pipeline}/builds

Create a build

Creates a build for the pipeline and starts execution in-process. When pipeline_ir is supplied the IR is materialised directly; when it is absent the engine renders the pipeline's IR in a sandbox VM first (rendering never happens on the API host). A manual build against a pipeline that disallows manual builds yields 403; an IR that fails to render/parse/plan yields 422 (the build row is created with its error fields set).

import { createBuild } from "@harmont/cloud";

createBuild(options): RequestResult<CreateBuildResponse>

Body CreateBuildRequest (optional)

Returns CreateBuildResponse

See POST /api/v0/organizations/{org}/pipelines/{pipeline}/builds for the full request and response schema.

createBuildBySource

POST /api/v0/organizations/{org}/builds

Create a build by repo + source slug

Creates a build by addressing the pipeline through its repo-natural identity (repo_name + source_slug) rather than the org-global slug. This is the hm run path. Resolution, manual-build gating, billing, and IR handling are otherwise identical to createBuild. A repo/source slug that matches no pipeline yields 404.

import { createBuildBySource } from "@harmont/cloud";

createBuildBySource(options): RequestResult<CreateBuildBySourceResponse>

Body CreateRepoBuildRequest (optional)

Returns CreateBuildBySourceResponse

See POST /api/v0/organizations/{org}/builds for the full request and response schema.

getBuild

GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}

Get a build

Returns the build identified by its pipeline-scoped number. An unknown number (or one in another pipeline) is reported as 404.

import { getBuild } from "@harmont/cloud";

getBuild(options): RequestResult<GetBuildResponse>

Returns GetBuildResponse

See GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number} for the full request and response schema.

getBuildLogToken

GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/log-token

Mint a build-scoped log token

Returns a short-lived (~1 hour) HMAC token the SSE log stream accepts, scoped to this build. Pass it as the stream's token query parameter.

import { getBuildLogToken } from "@harmont/cloud";

getBuildLogToken(options): RequestResult<GetBuildLogTokenResponse>

Returns GetBuildLogTokenResponse

See GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/log-token for the full request and response schema.

listBuilds

GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds

List a pipeline's builds

Returns the pipeline's builds, newest first, paginated.

import { listBuilds } from "@harmont/cloud";

listBuilds(options): RequestResult<ListBuildsResponse>

Returns ListBuildsResponse

See GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds for the full request and response schema.