v1
Double column
API
CLI
JS Client

Jobs /

Start job build

Start a new build for the given job. Given a commit sha, it will build that commit.

Required permission

Project > Jobs > Deployment > Deploy Build

Path parameters

    • projectId

      string required

      ID of the project

    • jobId

      string required

      ID of the job

Request body

  • {object}

    Start a build with the current settings

    • sha

      string

      Commit sha to build. If not provided, will build the most recent commit of the job's branch.

OR
  • {object}

    Start a build with overrides for the current settings

    • sha

      string

      Commit sha to build. If not provided, will build the most recent commit of the job's branch.

    • overrides

      {object}

      An optional object that may specify several different overrides on the build level.

      • buildArguments

        {object}

        Build arguments that will be set on this build only. In case of conflicts these values take precedence.

    Response body

    • {object}

      Response object.

      • data

        {object} required

        Result data.

        • id

          string required

          ID of the build.

        • branch

          string

          Name of the branch the built commit belongs to.

        • pullRequestId

          number

          ID of the pull request the commit belongs to.

        • sha

          string

          The sha of the built commit.

        • createdAt

          string

          Timestamp of the build initiation.

        • status

          string

          The status of the build.

        • concluded

          boolean

          Whether the build has finished.

    API
    CLI
    JS Client

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

    Example request

    Request body
    Start a build with the current settings
    curl
    curl --header "Content-Type: application/json" \
      --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
      --request POST \
      --data '{"sha":"262ed9817b3cad5142fbceabe0c9e371e390d616"}' \
      http://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build
    OR
    Start a build with overrides for the current settings
    curl
    curl --header "Content-Type: application/json" \
      --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
      --request POST \
      --data '{"sha":"262ed9817b3cad5142fbceabe0c9e371e390d616","overrides":{"buildArguments":{"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"}}}' \
      http://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build

    Example response

    200 OK

    Returns data about the build initiated

    JSON

    {
      "data": {
        "id": "joyous-view-6290",
        "branch": "main",
        "sha": "12c15e7ee25fd78f567ebf87f9178b8ad70025b3",
        "createdAt": "2021-07-28T15:55:38.296Z",
        "status": "PENDING",
        "concluded": false
      }
    }

    © 2022 Northflank Ltd. All rights reserved.