Jobs /
Get job
Required permission
Project > Jobs > General > Read
Path parameters
projectId
string requiredID of the project
jobId
string requiredID of the job
Response body
- {object}
Response object.
data
{object} requiredResult data.
id
string requiredIdentifier for the job
appId
string requiredFull identifier used for job deployment
name
string requiredJob name
description
stringA short description of the job
projectId
string requiredID of the project that the job belongs to
jobType
string requiredType of the job (manual or cron)
one ofmanual, croncreatedAt
string requiredThe time the job was created.
vcsData
{object}projectUrl
string requiredURL of the repository being built
projectType
string requiredVCS provider for the repo being built
one ofbitbucket, gitlab, github, self-hostedselfHostedVcsId
stringID of the self-hosted VCS, if applicable.
projectBranch
stringBranch of the repo being built
publicRepo
booleanWhether the repo is being accessed without authentication.
dockerWorkDir
string requiredWorking directory used by the dockerfile
dockerFilePath
string requiredFile path of the Dockerfile
buildConfiguration
{object}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
.max length260 isAllowList
booleanIf
true
, the functionality ofpathIgnoreRules
will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules inpathIgnoreRules
.ciIgnoreFlagsEnabled
booleanIf
true
, enables commit ignore flags. If a commit message contains one or more of the flags inciIgnoreFlags
, that commit will not be built.ciIgnoreFlags
[array]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]"]
- string
A commit ignore flag.
max length72 dockerfileTarget
stringIf your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here.
dockerCredentials
[array]- string
The ID of the docker credentials to use.
pattern^[A-Za-z0-9-]+$ includeGitFolder
booleanInclude .git folder inside the build context
fullGitClone
booleanInclude the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set.
storage
{object}ephemeralStorage
{object}storageSize
integerEphemeral storage per build in MB
one of16384, 32768, 65536, 131072, 262144, 524288min16384max65536buildEngineConfiguration
{object}buildEngine
stringThe build engine used.
one ofbuildpack, kaniko, buildkitbuildpack
{object}Details about Buildpack settings.
builder
stringThe Buildpack stack used.
one ofHEROKU_22, HEROKU_22_CLASSIC, HEROKU_20, HEROKU_18, GOOGLE_V1, CNB_ALPINE, CNB_BIONIC, PAKETO_TINY, PAKETO_BASE, PAKETO_FULLbuildpackLocators
[array]Array of custom Buildpacks used.
- string
Url or registry identifier of custom Buildpack.
useCache
booleanShould build dependencies be cached?
buildkit
{object}Details about Buildkit settings.
useCache
booleanShould intermediate image layers be cached?
kaniko
{object}Details about Kaniko settings.
useCache
booleanShould intermediate image layers be cached?
disabledCI
boolean requiredWhether Continuous Integration is disabled
disabledCD
boolean requiredWhether Continuous Deployment is disabled
deployment
{object}region
stringRegion where this job is deployed and built
buildpack
{object}Details about the Buildpack overrides for this deployment.
configType
string requiredType of buildpack run configuration.
one ofdefault, customProcess, customCommand, customEntrypointCustomCommand, originalEntrypointCustomCommandcustomProcess
stringCustom process which should be run.
customEntrypoint
stringCustom entrypoint which should be run.
customCommand
stringCustom command which should be run.
docker
{object}Details about the Docker overrides for this deployment.
configType
string requiredOverride configuration which is used at runtime.
one ofdefault, customEntrypoint, customCommand, customEntrypointCustomCommandcustomEntrypoint
stringThe CMD to run instead of the default if entrypoint override is enabled.
customCommand
stringThe CMD to run instead of the default if CMD override is enabled.
storage
{object}Details about storage settings for this deployment.
ephemeralStorage
{object}Details about ephemeral storage settings for this deployment.
storageSize
number requiredEphemeral storage per container in MB
billing
{object} requireddeploymentPlan
string requiredID of the billing plan used by this job
suspended
booleanCron specific. Whether or not the job's automatic scheduling is suspended
settings
{object} requiredJob settings
cron
{object}Cron job specific settings
schedule
stringThe cron timer scheduling when to run the job.
concurrencyPolicy
stringWhether this job should run when another instance of the job is already running.
one ofAllow, Forbid, ReplacebackoffLimit
integer requiredThe number of attempts to rerun a job before it is marked as failed.
activeDeadlineSeconds
integer requiredThe maximum amount of time, in seconds, for a job to run before it is marked as failed.
min1cluster
{object} requiredCluster information
id
string requiredThe id of the cluster associated with this project.
name
string requiredThe name of the cluster associated with this project.
namespace
stringNamespace this resource is located within on the cluster.
GET /v1/projects/{projectId}/jobs/{jobId}
Example response
200 OK
JSON
{
"data": {
"id": "example-job",
"appId": "/example-user/default-project/example-job",
"name": "Example Job",
"tags": [
"my-tag"
],
"description": "This is the job description",
"projectId": "default-project",
"jobType": "cron",
"createdAt": "2021-01-20T11:19:53.175Z",
"vcsData": {
"projectUrl": "https://github.com/northflank/gatsby-with-northflank",
"projectType": "github",
"selfHostedVcsId": "example-team/self-hosted-vcs",
"projectBranch": "master",
"publicRepo": false,
"dockerWorkDir": "/",
"dockerFilePath": "/Dockerfile"
},
"buildConfiguration": {
"pathIgnoreRules": [
"README.md"
],
"isAllowList": false,
"ciIgnoreFlags": [
"[skip ci]"
],
"dockerCredentials": [
"example-docker-credential"
],
"storage": {
"ephemeralStorage": {
"storageSize": 16384
}
}
},
"buildEngineConfiguration": {
"buildEngine": "buildpack",
"buildpack": {
"builder": "HEROKU_22",
"buildpackLocators": [
"https://buildpack-registry.heroku.com/cnb/mars/create-react-app"
]
}
},
"disabledCI": false,
"disabledCD": false,
"deployment": {
"region": "europe-west",
"buildpack": {
"configType": "default"
},
"docker": {
"configType": "default"
},
"storage": {
"ephemeralStorage": {
"storageSize": 1024
}
}
},
"billing": {
"deploymentPlan": "nf-compute-20"
},
"suspended": false,
"settings": {
"cron": {
"schedule": "30 8 * * *",
"concurrencyPolicy": "Allow"
},
"backoffLimit": 0,
"activeDeadlineSeconds": 600
},
"cluster": {
"id": "nf-europe-west",
"name": "nf-europe-west",
"namespace": "ns-8zy2mcjh9zn2"
}
}
}