Skip to main content
POST
/
api
/
v1
/
jobs
Create job
curl --request POST \
  --url http://localhost:3000/api/v1/jobs \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "name": "<string>",
  "schedule": "<string>",
  "task": {},
  "description": "<string>",
  "enabled": true
}
'
{
  "success": true,
  "data": {
    "job": {
      "id": "<string>",
      "name": "<string>",
      "schedule": "<string>",
      "description": "<string>",
      "task": {},
      "enabled": true,
      "lastRun": "2023-11-07T05:31:56Z",
      "nextRun": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Body

application/json
name
string
required

Job name

schedule
string
required

Cron expression

task
object
required

Task configuration

description
string

Job description

enabled
boolean
default:true

Response

Job created

success
boolean
required
data
object