Services /

Start service build

Start a new build for the given combined or build service. If given a commit sha, it will build that commit. If given a branch name or pull request ID, it will build the most recent commit from that branch or PR (build services only).

Required permission

Project > Services > Deployment > Deploy Build

Path parameters

projectId
string required
ID of the project
serviceId
string required
ID of the service

Request body

{object}

sha
string
Commit sha to build.
branch
string
Branch to build from. If sha is missing, the latest commit of this branch will be built. Only supported by build services.
pullRequestId
number
ID of a pull request to build from. If sha is missing, the latest commit of this pull request will be built. Only supported by build services.

Response body

{object}
Response object.

data
{object} required
Result data.

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}/services/{serviceId}/build

Example request

Request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"sha":"262ed9817b3cad5142fbceabe0c9e371e390d616"}' \
  https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/build

Example response

200 OK

Returns data about the build initiated

JSON

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