v1beta
Double column
curl
API
CLI

Jobs /

Update job settings

Updates settings for the job

URL parameters

    • project

      string required

      ID of the project

    • job

      string required

      ID of the job

Request attributes

  • object

    • backoffLimit

      integer

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

    • activeDeadlineSeconds

      integer

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

      min: 1

    • schedule

      string

      The cron timer scheduling when to run the job. Required for cron jobs and unavailable for other job types.

      pattern: (@(annually|yearly|monthly|weekly|daily|hourly))|((((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|\*) ?){5})

    • concurrencyPolicy

      string

      Whether this job should run when another instance of the job is already running. Only available for cron jobs. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one.

      one of: allow, forbid, replace

    • startingDeadlineSeconds

      integer

      The period of time, in seconds, to count the number of missed schedules. If `null`, resets to the default behaviour of 100 missed schedules. Only available for cron jobs.

API
CLI

POST /v1beta/projects/{project}/jobs/{job}/settings

Example request

request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"backoffLimit":0,"activeDeadlineSeconds":600,"schedule":"30 8 * * *","concurrencyPolicy":"allow","startingDeadlineSeconds":240}' \
  https://api.northflank.com/v1beta/projects/{project}/jobs/{job}/settings

Example response

200 OK

success

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com