JUjumpcloud
Reports

Create a Scheduled Report

Create a Scheduled Report.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/reports/scheduled \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
 -d '{ {Scheduled_Report_Parameters} }' \
post/reports/scheduled

Request

Request body

Response

createdAtstring date-time
cronExpressionstring

Generated cron expression (read-only, computed from schedule_frequency, schedule_time, and time_zone)

daysstring[]

Weekly: e.g. ["MONDAY", "THURSDAY"]. Monthly/quarterly: ["FIRST_DAY"] or ["LAST_DAY"]. Daily: omit or [].

descriptionstring
displayNamestring required
endDatestring date-time nullable

Optional end date for the schedule

exportTypestring required
idstring
isActiveboolean required
lastRunAtstring date-time nullable
lastRunStatusstring
nextRunAtstring date-time
reportIdstring byte nullable

Report definition ID (report_views.object_id or report_templates.object_id); hex in API. Omitted when not set.

reportTypestring nullable

report_view or report_template

scheduleFrequencystring required
scheduleTimestring required

Time of day for the schedule (e.g., "09:00 AM", "14:30")

startDatestring date-time nullable

Optional start date for the schedule

timeZonestring required

Timezone for the schedule (e.g., "GMT-2", "America/New_York")

updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.