CloudCron Schedule Next API

Schemas


S3FileUploadRequest

  • filestring · binary · required

S3BucketListResponse

  • namestring · required

HealthCheckResponse

  • statusstring · required
  • timestampstring · date-time · required

S3ObjectMetadata

  • keystring · required
  • sizeinteger · required
  • contentTypestring · required
  • lastModifiedstring · date-time · required

S3ObjectListResponse

  • keystring · required
  • sizeinteger · required
  • contentTypestring · required
  • lastModifiedstring · date-time · required

S3DeleteResponse

  • messagestring · required

ErrorResponse

  • errorstring · required

    Human-readable error message describing the problem.

  • codestring · enum · required

    Machine-readable error code for programmatic handling.

    Enum values:
    BAD_REQUEST
    INVALID_CRON
    INVALID_TIMEZONE
    NO_FUTURE_OCCURRENCE
    NOT_IMPLEMENTED
    DST_AMBIGUOUS
    DST_NON_EXISTENT
  • detailsobject · required

    Additional error context and troubleshooting information. Structure varies by error type.

  • timestampstring · date-time · required

    Error occurrence timestamp in ISO8601 UTC format.

SuccessBase

  • successboolean · required

HealthData

  • statusstring
  • timestampstring · date-time

Bucket

  • namestring

BucketList

  • namestring

ObjectMetadata

  • keystring
  • sizeinteger
  • contentTypestring
  • lastModifiedstring · date-time

ObjectList

  • keystring
  • sizeinteger
  • contentTypestring
  • lastModifiedstring · date-time

TokenData

  • tokenstring · required
  • expiresAtstring · date-time · required
  • providerstring

ConduitData

  • payloadobject · required

    Response payload from the conduit operation

ParsedAddress

  • streetstring · required

    The street address line (e.g., '6315 W Yucca St')

  • citystring · required

    The city name

  • statestring · required

    State, province, or region code

  • zipstring · required

    Postal or ZIP code

  • countrystring · required

    Country name

ReportData

  • reportIdstring · required

    Unique identifier for the generated report

  • generatedAtstring · date-time · required

    Timestamp when the report was generated

  • dataobject

    The actual report data (structure varies by report type)

  • parametersobject

    Parameters used to generate this report

ErrorEnvelope

  • successboolean · required
  • errorobject · required

TokenRequest

  • grant_typestring · enum · required
    Enum values:
    client_credentials
    refresh_token
    password
    Default: client_credentials
  • client_idstring
  • client_secretstring
  • refresh_tokenstring
  • usernamestring
  • passwordstring
  • scopestring

BaseResponse

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

HolidaysConfig

  • usestring · enum
    Enum values:
    none
    known
    custom
    Default: none
  • countrystring
  • datesstring[]

ScheduleNextRequest

  • cronstring · cron5 · required

    5-field CRON expression (minute hour day_of_month month day_of_week).

    Format: minute hour day_of_month month day_of_week

    • minute: 0-59
    • hour: 0-23
    • day_of_month: 1-31
    • month: 1-12
    • day_of_week: 0-7 (0 or 7 is Sunday)

    Supported operators: *, -, ,, / Not supported: Quartz tokens (?, L, W, #), seconds field (6+ fields)

  • tzstring · iana-tz

    IANA timezone identifier for execution time calculation. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

    Default: UTC
  • fromstring · date-time · pattern: .*Z$

    Starting time for next occurrence calculation in ISO8601 UTC format. Must end with 'Z' suffix. If not provided, defaults to current time.

  • ambiguityPolicystring · enum

    Policy for handling DST ambiguity when local times are non-existent (spring-forward) or ambiguous (fall-back).

    • first-valid: Use the first valid time (default)
    • second-valid: Use the second valid time
    • error: Return error for ambiguous times
    Enum values:
    first-valid
    second-valid
    error
    Default: first-valid
  • macrosboolean

    Enable business macros processing. Currently not implemented in MVP. Future phases will support @EOM, @EOQ, @semi-monthly, etc.

    Default: true
  • plainstring

    Plain language schedule input (e.g., "Every Monday at 9am").

    Not implemented in MVP - Sending this field returns 501 NOT_IMPLEMENTED. Will be supported in Phase 6.

  • holidaysobject

    Holiday configuration for filtering execution times. Currently only use: 'none' is supported.

  • returnstring · enum · deprecated · required

    DEPRECATED: This parameter is deprecated and ignored. Both nextIso and nextDate are always returned regardless of this parameter's value.

    Previously specified which timestamp formats to include in the response:

    • iso: Only nextIso field (ISO8601 with timezone offset)
    • date: Only nextDate field (calendar date in target timezone)
    • both: Both nextIso and nextDate fields (default)

    For backwards compatibility, this field is still accepted but has no effect on the response format.

    Enum values:
    iso
    date
    both
    Default: both

TimerNextRequest

  • cronstring
  • fromstring · date-time
  • tzstring
  • returnstring · enum
    Enum values:
    iso
    date
    both
    Default: both
  • ambiguityPolicystring · enum
    Enum values:
    first-valid
    second-valid
    error
    Default: first-valid

ScheduleNextResponse

  • nextIsostring · date-time · required

    Next execution time in ISO8601 UTC format. Always returned regardless of deprecated 'return' parameter.

  • nextDatestring · date · required

    Next execution date in YYYY-MM-DD format in the requested timezone. Always returned regardless of deprecated 'return' parameter.

  • schedlstring · required

    Canonical SCHEDL (Schedule Language) representation of the schedule. Format: " tz="

  • expandedCronstring · required

    Normalized 5-field CRON string with single spaces when input is valid. Null if normalization cannot be produced, with warning added to warnings array.

  • explanationstring · required

    Human-readable explanation of the schedule using 24-hour format. Format: "At HH:mm on "

  • warningsstring[] · required

    Array of human-readable warning codes about schedule processing. May include DST adjustments, deprecated parameter warnings, normalization fallback, etc.

ScheduleValidateRequest

  • cronstring
  • tzstring

ScheduleValidateResponse

  • validboolean
  • normalizedCronstring
  • explanationstring
  • nextPreviewstring[]

HolidayList

  • countrystring
  • yearinteger
  • datesstring[]