Services /

Create build service

Creates a new build service.

Path parameters

projectId
string required
ID of the project

Request body

{object}

name
string required
The name of the service.
min length
3
max length
20
pattern
^[a-zA-Z](-?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
description
string
A description of the service.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
billing
{object} required

deploymentPlan
string required
The ID of the deployment plan to use.
pattern
^[A-Za-z0-9-]+$

vcsData
{object} required

projectUrl
string required
URL of the Git repo to build.
projectType
string required
The VCS provider to use.
one of
bitbucket, gitlab, github, self-hosted
vcsId
string
If projectType is self-hosted, the ID of the self-hosted vcs to use.
pattern
^[A-Za-z0-9-]+\/[A-Za-z0-9-]+$
dockerFilePath
string required
The file path of the Dockerfile.
pattern
^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]+$
dockerWorkDir
string required
The working directory of the Dockerfile.
pattern
^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]*$

buildConfiguration
{object}

branchRestrictions
[array]

string
pattern
^[a-zA-Z/*0-9-]*$

prRestrictions
[array]

string
pattern
^[a-zA-Z/*0-9-]*$

buildArguments
{object}
An object containing the build arguments to set for the service

Response body

{object}

id
string required
The ID of the newly created service
serviceType
string required
The type of the service created
name
string required
The name of the newly created service.
description
string
The description of the newly created service.

API

CLI

JS client

POST /v1/projects/{projectId}/services/build

Example request

request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Service","description":"A service description","billing":{"deploymentPlan":"nf-compute-20"},"vcsData":{"projectUrl":"https://github.com/northflank/gatsby-with-northflank","projectType":"github","dockerFilePath":"/Dockerfile","dockerWorkDir":"/"},"buildConfiguration":{"branchRestrictions":[null],"prRestrictions":[null]},"buildArguments":{"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"}}' \
  https://api.northflank.com/v1/projects/{projectId}/services/build

Example response

200 OK

Details about the newly created service.

JSON

{
  "id": "new-service",
  "serviceType": "build",
  "name": "New Service",
  "description": "This is a new service."
}

Example response

409 Conflict

There is already a service with the same derived identifier