Skip to main content
PATCH
/
v1
/
jobs
/
{job_id}
Update Job
curl --request PATCH \
  --url https://sdk.nimbleway.com/v1/jobs/{job_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "schedule": {
    "cron": "<string>",
    "enabled": true
  },
  "inputs": {
    "file_path": "<string>",
    "data": [
      {}
    ]
  },
  "destination": {
    "path": "<string>",
    "format": "parquet"
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "agent_name": "<string>",
  "description": "<string>",
  "schedule": {
    "cron": "<string>",
    "enabled": true
  },
  "inputs": {
    "file_path": "<string>",
    "data": [
      {}
    ]
  },
  "destination": {
    "path": "<string>",
    "format": "parquet"
  },
  "last_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id
string
required

Cookies

token
string | null

Body

application/json

Partial update for an existing job; omitted fields are left unchanged.

display_name
string | null

New display name.

description
string | null

New description.

schedule
JobSchedule · object

New cron schedule.

inputs
JobInputs · object

New input data configuration.

destination
JobDestination · object

New output destination.

Response

Successful Response

A configured job: an agent plus its schedule, inputs, and destination.

id
string
required

Unique job identifier (job_).

Pattern: ^job_[1-9][0-9]*$
name
string
required

Job name.

display_name
string | null

Human-friendly job name shown in the UI.

agent_name
string | null

Name of the agent this job runs.

description
string | null

Free-text description of the job.

schedule
JobSchedule · object

Cron schedule controlling automatic runs.

inputs
JobInputs · object

Input data configuration for the job.

destination
JobDestination · object

Where the job writes its results.

last_run_at
string<date-time> | null

Timestamp of the most recent run.

last_run_status
enum<string> | null

Status of the most recent run.

Available options:
PENDING,
RUNNING,
SUCCESS,
FAILED,
CANCELLED,
TIMEOUT,
WARNING
created_at
string<date-time> | null

When the job was created.

updated_at
string<date-time> | null

When the job was last updated.