Update a Schedule
put
/api/v2/schedules/{id}/
Make a PUT or PATCH request to this resource to update this schedule. The following fields may be modified:
-
rrule: A value representing the schedules iCal recurrence rule. (string, required) -
name: Name of this schedule. (string, required) description: Optional description of this schedule. (string, default="")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default="")job_type: (choice)None: --------- (default)"": ---------run: Runcheck: Check
job_tags: (string, default="")skip_tags: (string, default="")limit: (string, default="")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)
unified_job_template: (id, required)enabled: Enables processing of this schedule. (boolean, default=True)
For a PUT request, include all fields in the request.
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
search(optional): string
A search term.
Root Schema : schema
Type:
Show Source
object-
description(optional):
string
-
diff_mode(optional):
boolean
-
enabled(optional):
boolean
Enables processing of this schedule.
-
extra_data(optional):
string
-
inventory(optional):
integer
Inventory applied as a prompt, assuming job template prompts for inventory
-
job_tags(optional):
string
-
job_type(optional):
string
-
limit(optional):
string
-
name:
string
-
rrule:
string
A value representing the schedules iCal recurrence rule.
-
scm_branch(optional):
string
-
skip_tags(optional):
string
-
unified_job_template:
integer
-
verbosity(optional):
string