Sign in

v1

latestSwagger 2.02026-07-1711511.8 KB
jobs

Create or updates a new job.

post/jobs

Query parameters

runoncreatestring

If present, regardless of any value, causes the job to be run immediately after being succesfully created or updated.

This will cause the server to wait until the job has finished before returning a result.

Request body

namestring required

Name for the job.

displaynamestring

Nice name for the job. Optional.

schedulestring required

Cron expression for the job.

timezonestring

Timezone where the job will be executed. By default and when field is set to empty string, the job will run in local time.

ownerstring

Owner of the job

owner_emailstring

Email of the owner

success_countinteger

Number of successful executions

error_countinteger

Number of failed executions

last_successstring date-time

Last time this job executed successfully

last_errorstring date-time

Last time this job failed

disabledboolean

Disabled state of the job

tagsobject

Target nodes tags of this job

metadataobject

Extra metadata tags for this job

retriesinteger

Number of times to retry a failed job execution

parent_jobstring

The name/id of the job that will trigger the execution of this job

dependent_jobsstring[]

Array containing the jobs that depends on this one

processorsProcessors

Processor plugins used to process executions results of this job

concurrencystring

Concurrency policy for the job allow/forbid

executorstring

Executor plugin used to run the job

executor_configobject

Executor plugin parameters

statusstring

Status of the job

Example request

{
  "name": "job1",
  "schedule": "@every 10s",
  "timezone": "Europe/Berlin",
  "owner": "Platform Team",
  "owner_email": "platform@example.com",
  "tags": {
    "server": "true"
  },
  "metadata": {
    "office": "Barcelona"
  },
  "retries": 2,
  "parent_job": "parent_job",
  "dependent_jobs": [
    "dependent_job"
  ],
  "processors": {
    "files": {
      "forward": true
    }
  },
  "concurrency": "allow",
  "executor": "shell",
  "executor_config": {
    "command": "echo 'Hello from Dkron'"
  },
  "status": "success"
}

Response

Successful response

namestring required

Name for the job.

displaynamestring

Nice name for the job. Optional.

schedulestring required

Cron expression for the job.

timezonestring

Timezone where the job will be executed. By default and when field is set to empty string, the job will run in local time.

ownerstring

Owner of the job

owner_emailstring

Email of the owner

success_countinteger

Number of successful executions

error_countinteger

Number of failed executions

last_successstring date-time

Last time this job executed successfully

last_errorstring date-time

Last time this job failed

disabledboolean

Disabled state of the job

tagsobject

Target nodes tags of this job

metadataobject

Extra metadata tags for this job

retriesinteger

Number of times to retry a failed job execution

parent_jobstring

The name/id of the job that will trigger the execution of this job

dependent_jobsstring[]

Array containing the jobs that depends on this one

processorsProcessors

Processor plugins used to process executions results of this job

concurrencystring

Concurrency policy for the job allow/forbid

executorstring

Executor plugin used to run the job

executor_configobject

Executor plugin parameters

statusstring

Status of the job

Example response

{
  "name": "job1",
  "schedule": "@every 10s",
  "timezone": "Europe/Berlin",
  "owner": "Platform Team",
  "owner_email": "platform@example.com",
  "tags": {
    "server": "true"
  },
  "metadata": {
    "office": "Barcelona"
  },
  "retries": 2,
  "parent_job": "parent_job",
  "dependent_jobs": [
    "dependent_job"
  ],
  "processors": {
    "files": {
      "forward": true
    }
  },
  "concurrency": "allow",
  "executor": "shell",
  "executor_config": {
    "command": "echo 'Hello from Dkron'"
  },
  "status": "success"
}