Cancel a build

Request cancellation of a build and return 202 Accepted.

Cancellation runs asynchronously: the endpoint verifies the build exists and then hands it off to a background workflow that marks the build as cancelling, asks the cloud build provider to stop it, and polls until the build reaches a terminal state before recording the final status. Only builds that are still queued or running are actually cancelled; if the build has already finished, or cancellation is already in progress, the request is still accepted but has no effect. The returned record reflects the build’s state at the time of the call, so it will not yet show the pending cancellation. The request is rejected if no such build exists for the caller’s account.

POST /v5/builds/{build_id}/cancel

Cancel a build

cURL

curl --request POST \
  --url https://api.egp.scale.com/v5/builds/{build_id}/cancel \
  --header 'x-api-key: <api-key>'

202

{
  "id": "<string>",
  "cloud_provider_build_id": "<string>",
  "agent_name": "<string>",
  "image_name": "<string>",
  "image_tag": "<string>",
  "build_status": "queued",
  "source_repo": "<string>",
  "source_commit": "<string>",
  "source_ref": "<string>",
  "source_subpath": "<string>",
  "working_tree_hash": "<string>",
  "source_dirty": true,
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "type": "user",
    "object": "identity"
  },
  "object": "agentex_cloud_build",
  "agent_id": "<string>",
  "image_url": "<string>",
  "image_digest": "<string>",
  "build_start_time": "2023-11-07T05:31:56Z",
  "build_end_time": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key · string · header · required

Headers

x-selected-account-id · string | null

Path Parameters

build_id · string · required

Response

202

application/json

Successful Response

id · string · required

The unique identifier of the entity.

cloud_provider_build_id · string · required

The unique identifier of the build from the cloud provider, or an internal UUID when an existing image is copied without a provider build.

agent_name · string · required

The name of the agent that this build belongs to

image_name · string · required

The name of the container image to build.

image_tag · string · required

The tag for the container image.

build_status · enum<string> · required

The current build lifecycle status

Available options: queued, running, success, failed, cancelling, cancelled, deleting, delete_failed, timed_out, error, unknown

source_repo · string | null · required

Normalized git remote the build context came from (host/path, no credentials).

source_commit · string | null · required

Git commit the build context was at, when a git work tree.

source_ref · string | null · required

Git branch or tag for source_commit, when resolvable.

source_subpath · string | null · required

Build-context path relative to the repo root (which agent, in a monorepo).

working_tree_hash · string | null · required

Deterministic SHA-256 content hash of the build inputs (not the tarball).

source_dirty · boolean | null · required

Whether the work tree had uncommitted changes at build time (null outside git).

account_id · string · required

The ID of the account that owns the given entity.

created_at · string<date-time> · required

The date and time when the entity was created in ISO format.

created_by · Identity · object · required

The identity that created the entity.

Show child attributes

object · string · default: agentex_cloud_build

Allowed value: "agentex_cloud_build"

agent_id · string | null

The UUID of the agent that this build belongs to

image_url · string | null

The URL of the container image. This is not guaranteed to be present until the build is complete.

image_digest · string | null

Registry manifest digest of the pushed image (e.g. sha256:...). Reported by the cloud provider when the build completes; null until then, and null on builds whose provider path does not report one. Unlike image_url, it names the exact image bytes and cannot be repointed.

build_start_time · string<date-time> | null

When the cloud provider started the build

build_end_time · string<date-time> | null

When the cloud provider finished the build