Jobs /

Update job build options

Updates the build options for a given job.

Required permission

Project > Jobs > General > Update

Path parameters

projectId
string required
ID of the project
jobId
string required
ID of the job

Request body

{object}
Build from a Dockerfile

dockerfile
{object} required

buildEngine
string
Build engine to use. Defaults to recommended build engine kaniko
one of
kaniko, buildkit
useCache
boolean
Should intermediate image layers be cached? Only supported by Kaniko.
dockerFilePath
string
The file path of the Dockerfile.
pattern
^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]+$
dockerWorkDir
string
The working directory of the Dockerfile.
pattern
^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]*$

pathIgnoreRules
[array]
An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow .gitignore syntax.

string
A path ignore rule, following .gitignore syntax. For example, *.md will ignore all files ending with .md.

{object}
Build from a Buildpack

buildpack
{object} required

builder
string
Buildpack stack to use. Defaults to recommended stack HEROKU_20.
one of
HEROKU_20, HEROKU_18, GOOGLE_V1, CNB_ALPINE, CNB_BIONIC, PAKETO_TINY, PAKETO_BASE, PAKETO_FULL
buildpackLocators
[array]
Array of custom buildpacks to use.

string
Url or registry identifier of custom buildpack.

buildContext
string
The working directory to build in.
pattern
^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]*$

pathIgnoreRules
[array]
An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow .gitignore syntax.

string
A path ignore rule, following .gitignore syntax. For example, *.md will ignore all files ending with .md.

{object}
Don't modify build type settings

pathIgnoreRules
[array]
An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow .gitignore syntax.

string
A path ignore rule, following .gitignore syntax. For example, *.md will ignore all files ending with .md.

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

POST /v1/projects/{projectId}/jobs/{jobId}/build-options

Example request

Request body

Build from a Dockerfile

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"dockerfile":{"buildEngine":"kaniko","useCache":false,"dockerFilePath":"/Dockerfile","dockerWorkDir":"/"},"pathIgnoreRules":["README.md"]}' \
  http://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build-options

Build from a Buildpack

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"buildpack":{"builder":"HEROKU_20","buildpackLocators":["https://buildpack-registry.heroku.com/cnb/mars/create-react-app"],"buildContext":"/"},"pathIgnoreRules":["README.md"]}' \
  http://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build-options

Don't modify build type settings

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"pathIgnoreRules":["README.md"]}' \
  http://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build-options

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}