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)
execution_environment: The container image to be used for execution. (id, default=``)forks: (integer, default=None)job_slice_count: (integer, default=None)timeout: (integer, default=None)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
Root Schema : Schedule
Type:
Show Source
object-
created:
string
Title:
CreatedRead Only:true -
description:
string
Title:
Description -
diff_mode:
boolean
Title:
Diff mode -
dtend:
string(date-time)
Title:
DtendRead Only:trueThe last occurrence of the schedule occurs before this time, aftewards the schedule expires. -
dtstart:
string(date-time)
Title:
DtstartRead Only:trueThe first occurrence of the schedule occurs on or after this time. -
enabled:
boolean
Title:
EnabledDefault Value:trueEnables processing of this schedule. -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
extra_data:
object Extra data
Title:
Extra data -
forks:
integer
Title:
ForksMinimum Value:0 -
id:
integer
Title:
IDRead Only:true -
inventory:
integer
Title:
InventoryInventory applied as a prompt, assuming job template prompts for inventory -
job_slice_count:
integer
Title:
Job slice countMinimum Value:0 -
job_tags:
string
Title:
Job tags -
job_type:
string
Title:
Job typeAllowed Values:[ "run", "check" ] -
limit:
string
Title:
Limit -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:512 -
next_run:
string(date-time)
Title:
Next runRead Only:trueThe next time that the scheduled action will run. - related: string
-
rrule(required):
string
Title:
RruleMinimum Length:1A value representing the schedules iCal recurrence rule. -
scm_branch:
string
Title:
Scm branch -
skip_tags:
string
Title:
Skip tags -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
timeout:
integer
Title:
Timeout -
timezone:
string
Title:
TimezoneRead Only:trueThe timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. -
type:
string
Title:
TypeRead Only:true -
unified_job_template(required):
integer
Title:
Unified job template -
until:
string
Title:
UntilRead Only:trueThe date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned -
url:
string
Title:
UrlRead Only:true -
verbosity:
string
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ]
Nested Schema : Extra data
Type:
objectTitle:
Extra dataResponse
Supported Media Types
- application/json
200 Response
Root Schema : Schedule
Type:
Show Source
object-
created:
string
Title:
CreatedRead Only:true -
description:
string
Title:
Description -
diff_mode:
boolean
Title:
Diff mode -
dtend:
string(date-time)
Title:
DtendRead Only:trueThe last occurrence of the schedule occurs before this time, aftewards the schedule expires. -
dtstart:
string(date-time)
Title:
DtstartRead Only:trueThe first occurrence of the schedule occurs on or after this time. -
enabled:
boolean
Title:
EnabledDefault Value:trueEnables processing of this schedule. -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
extra_data:
object Extra data
Title:
Extra data -
forks:
integer
Title:
ForksMinimum Value:0 -
id:
integer
Title:
IDRead Only:true -
inventory:
integer
Title:
InventoryInventory applied as a prompt, assuming job template prompts for inventory -
job_slice_count:
integer
Title:
Job slice countMinimum Value:0 -
job_tags:
string
Title:
Job tags -
job_type:
string
Title:
Job typeAllowed Values:[ "run", "check" ] -
limit:
string
Title:
Limit -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:512 -
next_run:
string(date-time)
Title:
Next runRead Only:trueThe next time that the scheduled action will run. - related: string
-
rrule(required):
string
Title:
RruleMinimum Length:1A value representing the schedules iCal recurrence rule. -
scm_branch:
string
Title:
Scm branch -
skip_tags:
string
Title:
Skip tags -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
timeout:
integer
Title:
Timeout -
timezone:
string
Title:
TimezoneRead Only:trueThe timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. -
type:
string
Title:
TypeRead Only:true -
unified_job_template(required):
integer
Title:
Unified job template -
until:
string
Title:
UntilRead Only:trueThe date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned -
url:
string
Title:
UrlRead Only:true -
verbosity:
string
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ]
Nested Schema : Extra data
Type:
objectTitle:
Extra data