Schedule Details ================ The Following Lists the Expected Format and Details of Our Rrules
post
/api/v2/schedules/
- DTSTART is required and must follow the following format: DTSTART:YYYYMMDDTHHMMSSZ
- DTSTART is expected to be in UTC
- INTERVAL is required
- SECONDLY is not supported
- RRULE must precede the rule statements
- BYDAY is supported but not BYDAY with a numerical prefix
- BYYEARDAY and BYWEEKNO are not supported
- Only one rrule statement per schedule is supported
- COUNT must be < 1000
Here are some example rrules:
"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5"
"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1"
"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU"
"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1"
"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z"
Request
Supported Media Types
- application/json
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
201 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