Create a new build

post/builds

Creates a new build job. Source code should be uploaded as a tar.gz archive in the multipart form data.

ReturnsExpand Collapse

Build = object { id, created_at, status, 9 more }

id: string

Build job identifier

created_at: string

Build creation timestamp

formatdate-time

status: BuildStatus

Build job status

Accepts one of the following:

"queued"

"building"

"pushing"

"ready"

"failed"

"cancelled"

builder_instance_id: optional string

Instance ID of the builder VM (for debugging)

completed_at: optional string

Build completion timestamp

formatdate-time

duration_ms: optional number

Build duration in milliseconds

formatint64

error: optional string

Error message (only when status is failed)

image_digest: optional string

Digest of built image (only when status is ready)

image_ref: optional string

Full image reference (only when status is ready)

provenance: optional BuildProvenance { base_image_digest, buildkit_version, lockfile_hashes, 2 more }

base_image_digest: optional string

Pinned base image digest used

buildkit_version: optional string

BuildKit version used

lockfile_hashes: optional map[string]

Map of lockfile names to SHA256 hashes

source_hash: optional string

SHA256 hash of source tarball

timestamp: optional string

Build completion timestamp

formatdate-time

queue_position: optional number

Position in build queue (only when status is queued)

started_at: optional string

Build start timestamp

formatdate-time

Create a new build

curl http://localhost:8080/builds \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $HYPEMAN_API_KEY" \
    -F source=undefined

{
  "id": "build-abc123",
  "created_at": "2019-12-27T18:11:19.117Z",
  "status": "queued",
  "builder_instance_id": "builder_instance_id",
  "completed_at": "2019-12-27T18:11:19.117Z",
  "duration_ms": 0,
  "error": "error",
  "image_digest": "image_digest",
  "image_ref": "image_ref",
  "provenance": {
    "base_image_digest": "base_image_digest",
    "buildkit_version": "buildkit_version",
    "lockfile_hashes": {
      "foo": "string"
    },
    "source_hash": "source_hash",
    "timestamp": "2019-12-27T18:11:19.117Z"
  },
  "queue_position": 0,
  "started_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "build-abc123",
  "created_at": "2019-12-27T18:11:19.117Z",
  "status": "queued",
  "builder_instance_id": "builder_instance_id",
  "completed_at": "2019-12-27T18:11:19.117Z",
  "duration_ms": 0,
  "error": "error",
  "image_digest": "image_digest",
  "image_ref": "image_ref",
  "provenance": {
    "base_image_digest": "base_image_digest",
    "buildkit_version": "buildkit_version",
    "lockfile_hashes": {
      "foo": "string"
    },
    "source_hash": "source_hash",
    "timestamp": "2019-12-27T18:11:19.117Z"
  },
  "queue_position": 0,
  "started_at": "2019-12-27T18:11:19.117Z"
}