Build

Update a build

Updates a build.

patch/build/{id}

Path parameters

idinteger required

The ID of the build to read.

Request body

status'pending' | 'in_progress' | 'failed' | 'successful'

The status of the build.

Example request

{
  "status": "pending"
}

Response

The build was updated.

idinteger required

The ID of the build.

application_idinteger

The ID of the application that the build belongs to.

branchstring required

The branch that the asset was built from.

created_atstring date-time required

The ISO-8601 UTC timestamp of when the build was created.

updated_atstring date-time nullable

The ISO-8601 UTC timestamp of when the build was last updated.

descriptionstring nullable

A description of the build.

nrnstring nullable

The NRN of the build.

status'pending' | 'in_progress' | 'failed' | 'successful' required

The status of the build.

Example response

{
  "id": 123,
  "application_id": 345,
  "branch": "main",
  "commit": {
    "id": "123abc",
    "permalink": "https://example.com/1234"
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-02T00:00:00Z",
  "description": "This is a description of the build.",
  "nrn": "organization=1:account=2:namespace=3:application=234:build=123",
  "status": "pending"
}

Changes