JUjumpcloud
Reports

Create a Scheduled Report Run

Create a new Scheduled Report Run.

Sample Request

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

Request

Request body

Response

artifactUrlstring nullable

Presigned download URL when the run succeeded (same link as email/slack notifications). Falls back to a relative API path only when no stored URL exists.

completedAtstring date-time
displayNamestring nullable

Scheduled report display name (primary label in history UI)

fileSizestring nullable

File size in bytes

idstring
rowCountstring nullable

Emitted as string in JSON (e.g. "123"); omit when not set to avoid validation errors.

scheduleFrequencystring nullable

Stored and returned as lowercase: daily, weekly, monthly, quarterly

scheduleTimestring nullable

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

scheduledReportIdstring
startedAtstring date-time
statusstring

Status: IN_PROGRESS, SUCCESS, FAILED

timeZonestring nullable

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

timeoutAtstring date-time nullable

Omit when not set to avoid null (validator expects string or absent).

Changes

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