API v1 ReferenceAgent Schedules

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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agentIdstringRequiredformat: "uuid"
The agent id.

Request

The cadence preview request.
cronRulestringRequired1-100 characters
The cron rule used for recurring execution.
recurrenceIntervalintegerRequired1-99
The number of matching cron occurrences between scheduled runs.
timezonestringRequired1-100 characters
The IANA timezone used to evaluate the cron rule.
scheduleIdstring or nullOptionalformat: "uuid"
The optional existing schedule whose current cadence phase is used.

Response

OK
nextRunOnstringOptionalformat: "date-time"
The next selected occurrence in UTC.
isFirstRunbooleanOptional
Whether the occurrence starts a new cadence phase.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
503
Service Unavailable Error