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 ofcron, manualcreatedAt
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
. buildEngineConfiguration
{object}buildEngine
stringThe build engine used.
one ofbuildpack, kaniko, buildkitbuildpack
{object}Details about Buildpack settings.
builder
stringThe Buildpack stack used.
one ofHEROKU_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.
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
billing
{object} requireddeploymentPlan
string requiredID of the billing plan used by this job
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.
min1
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",
"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"
]
},
"buildEngineConfiguration": {
"buildEngine": "buildpack",
"buildpack": {
"builder": "HEROKU_20",
"buildpackLocators": [
"https://buildpack-registry.heroku.com/cnb/mars/create-react-app"
]
},
"kaniko": {}
},
"disabledCI": false,
"disabledCD": false,
"deployment": {
"region": "europe-west"
},
"billing": {
"deploymentPlan": "nf-compute-20"
},
"settings": {
"cron": {
"schedule": "30 8 * * *",
"concurrencyPolicy": "Allow"
},
"backoffLimit": 0,
"activeDeadlineSeconds": 600
}
}
}