Sign in
agentSchedules

Previews a schedule occurrence.

Calculates the next occurrence for the supplied cadence without changing the schedule.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/agents/{agentId}/schedules/nextoccurrence

Path parameters

agentIdstring uuid required

The Custom Agent ID.

Request body

cronRulestring required

The cron rule used for recurring execution.

recurrenceIntervalinteger required

The number of matching cron occurrences between scheduled runs.

timezonestring required

The IANA timezone used to evaluate the cron rule.

scheduleIdstring uuid nullable

The optional existing schedule whose current cadence phase is used.

Response

OK

nextRunOnstring date-time

The next selected occurrence in UTC.

isFirstRunboolean

Whether the occurrence starts a new cadence phase.

Changes

Changed in 1 of the 11 revisions of this API.1