v1
Double column
API
CLI
JS client

Jobs /

Get job details

Gets information about the given job

Path parameters

    • projectId

      string required

      ID of the project

    • jobId

      string required

      ID of the job

Response body

  • {object}
    • id

      string required

      Identifier for the job

    • appId

      string required

      Full identifier used for job deployment

    • name

      string required

      Job name

    • description

      string

      A short description of the job

    • projectId

      string required

      ID of the project that the service belongs to

    • jobType

      string required

      Type of the job (normal or cron)

    • vcsData

      {object}
      • projectUrl

        string required

        URL of the repository being built

      • projectType

        string required

        VCS provider for the repo being built

      • vcsId

        string

        ID of the self-hosted VCS, if applicable.

      • projectBranch

        string

        Branch of the repo being built

      • dockerWorkDir

        string required

        Working directory used by the dockerfile

      • dockerFilePath

        string required

        File path of the Dockerfile

    • disabledCI

      boolean required

      Whether Continuous Integration is disabled

    • disabledCD

      boolean required

      Whether Continuous Deployment is disabled

    • deployment

      {object}
      • region

        string

        Region where this job is deployed and built

    • billing

      {object} required
      • deploymentPlan

        string required

        ID of the billing plan used by this job

    • settings

      {object} required

      Job settings

      • cron

        {object}

        Cron job specific settings

        • schedule

          string

          The cron timer scheduling when to run the job.

        • concurrencyPolicy

          string

          Whether this job should run when another instance of the job is already running.

          one of
          Allow, Forbid, Replace
      • backoffLimit

        integer required

        The number of attempts to rerun a job before it is marked as failed.

      • activeDeadlineSeconds

        integer required

        The maximum amount of time, in seconds, for a job to run before it is marked as failed.

        min
        1
API
CLI
JS client

GET /v1/projects/{projectId}/jobs/{jobId}

Example response

200 OK

Details about the job.

JSON

{
  "id": "example-job",
  "appId": "/example-user/default-project/example-job",
  "name": "Example Job",
  "description": "This is the job description",
  "projectId": "default-project",
  "jobType": "cron",
  "vcsData": {
    "projectUrl": "https://github.com/northflank/gatsby-with-northflank",
    "projectType": "github",
    "vcsId": "example-team/self-hosted-vcs",
    "projectBranch": "master",
    "dockerWorkDir": "/",
    "dockerFilePath": "/Dockerfile"
  },
  "disabledCI": false,
  "disabledCD": false,
  "deployment": {
    "region": "europe-west"
  },
  "billing": {
    "deploymentPlan": "nf-compute-20"
  },
  "settings": {
    "cron": {
      "schedule": "30 8 * * *",
      "concurrencyPolicy": "Allow"
    },
    "backoffLimit": 0,
    "activeDeadlineSeconds": 600
  }
}

© 2021 Northflank Ltd. All rights reserved.