Update an existing scheduled job

put

http://127.0.0.1:8080/gms/job

Modifies the schedule, configuration, or enabled status of an existing job. Cannot modify runNow jobs or change job category. Requires READ_WRITE role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

required

≥ 1

Unique identifier of the job to update. Must reference an existing scheduled job that is not a runNow job.

Body Params

Updated job configuration. The jobCategory field is ignored as category cannot be changed after creation.

Request body for updating an existing scheduled job via PUT. The jobCategory field is ignored since category cannot be changed after creation.

jobCategory

integer

required

Job category identifier. This field is required but ignored during update - job category cannot be changed. To change category, delete and recreate the job.

schedule

object

required

Schedule definition for PUT updates. Must include effectiveTime - runNow is not allowed when updating jobs.

config

object

required

Job-specific configuration object. Structure varies by jobCategory. Cannot be null.

description

string

length ≤ 255

Human-readable description of the job purpose.

targetAppliance

object

Specifies which appliances or groups the job will target.

enabled

boolean

Defaults to true

Whether the job should be active. When set to false, the job is removed from Quartz scheduler but retained in database. Default is true.

Responses

204

Job updated successfully. The job has been rescheduled in Quartz with the new configuration.

401

Unauthorized - Authentication required.

403

Forbidden - User lacks READ_WRITE role required for updates.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/html

400Bad Request - Validation failed for the update request.