---
title: "Update job build options"
method: POST
path: "/v1/projects/{projectId}/jobs/{jobId}/build-options"
tags: ["Jobs", "project"]
deprecated: true
---

# Update job build options

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

## Request

- Base URL: `https://placeholder/v1`
- URL: `https://placeholder/v1/v1/projects/{projectId}/jobs/{jobId}/build-options`
- Auth: none required
- TypeScript: <https://skmtc.dev/northflank/apis/northflank-api/docs/v1/projects/:projectId/jobs/:jobId/build-options/post.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

Updates the build options for a given job.

## Path parameters

- `projectId` string, required: ID of the project
- `jobId` string, required: ID of the job

## Request body

- union: Update job build settings
  - object: Build from a Dockerfile
    - `dockerfile` object, required
      - `buildEngine` 'buildkit' | 'kaniko': Build engine to use. Defaults to recommended build engine `buildkit`
      - `dockerFilePath` string: The file path of the Dockerfile.
      - `dockerWorkDir` string: The working directory of the Dockerfile.
      - `dockerfileContents` string, nullable: Plain UTF-8 Dockerfile contents. Ordinary API and immediate-build values are literal. In template contexts only `${args.*}` and `${refs.*}` are resolved; native Docker `${...}` syntax is preserved. Sensitive values must use Docker secret mounts rather than template expressions or sensitive arguments or references.
      - `scan` object
        - `enabled` boolean, required
      - `buildkit` object
        - `useCache` boolean: Use persistent storage to cache build layers.
        - `cacheStorageSize` integer: The amount of persistent storage available to each build in MB.
    - `pathIgnoreRules` string[]: 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.
    - `isAllowList` boolean: If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`.
    - `ciIgnoreFlagsEnabled` boolean: If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built.
    - `ciIgnoreFlags` string[]: An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]`
    - `ignoreEmptyCommits` boolean: If `true`, commits that do not modify any files will not trigger a build. Defaults to `false`, meaning empty commits build regardless of other build rules.
    - `dockerfileTarget` string: If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here.
    - `dockerCredentials` string[]
    - `includeGitFolder` boolean: Include .git folder inside the build context
    - `fullGitClone` boolean: Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set.
    - `enableGitLfs` boolean: Enable Git LFS support for the build
    - `storage` object
      - `ephemeralStorage` object
        - `storageSize` 16384 | 32768 | 65536 | 131072 | 262144 | 524288: Ephemeral storage per build in MB
  - object: Build from a Buildpack
    - `buildpack` object, required
      - `builder` 'HEROKU_26' | 'HEROKU_24' | 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_22' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_RESOLUTE' | 'PAKETO_NOBLE' | 'PAKETO_JAMMY_TINY' | 'PAKETO_JAMMY_BASE' | 'PAKETO_JAMMY_FULL' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL': Buildpack stack to use. Defaults to recommended stack `HEROKU_26`.
      - `buildpackLocators` string[]: Array of custom buildpacks to use.
      - `buildContext` string: The working directory to build in.
      - `useCache` boolean: Should build dependencies be cached?
      - `scan` object
        - `enabled` boolean, required
    - `pathIgnoreRules` string[]: 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.
    - `isAllowList` boolean: If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`.
    - `ciIgnoreFlagsEnabled` boolean: If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built.
    - `ciIgnoreFlags` string[]: An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]`
    - `ignoreEmptyCommits` boolean: If `true`, commits that do not modify any files will not trigger a build. Defaults to `false`, meaning empty commits build regardless of other build rules.
  - object: Don't modify build type settings
    - `pathIgnoreRules` string[]: 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.
    - `isAllowList` boolean: If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`.
    - `ciIgnoreFlagsEnabled` boolean: If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built.
    - `ciIgnoreFlags` string[]: An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]`
    - `ignoreEmptyCommits` boolean: If `true`, commits that do not modify any files will not trigger a build. Defaults to `false`, meaning empty commits build regardless of other build rules.
    - `dockerfileTarget` string: If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here.
    - `dockerCredentials` string[]
    - `includeGitFolder` boolean: Include .git folder inside the build context
    - `fullGitClone` boolean: Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set.
    - `enableGitLfs` boolean: Enable Git LFS support for the build
    - `storage` object
      - `ephemeralStorage` object
        - `storageSize` 16384 | 32768 | 65536 | 131072 | 262144 | 524288: Ephemeral storage per build in MB

## Response `200`

The operation was performed successfully.

---

[API](https://skmtc.dev/northflank/apis/northflank-api.md) - [All operations](https://skmtc.dev/northflank/apis/northflank-api/llms.txt) - [OpenAPI document](https://skmtc.dev/northflank/apis/northflank-api/revisions/6511db980148?raw)
