Scheduled Exports

A Scheduled Export defines a recurring schedule for generating one of the built-in CSV exports and e-mailing it to a Site Admin recipient.

List Scheduled Exports

Command

files-cli scheduled-exports list

Output

Outputs a list of ScheduledExport objects according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Additional Arguments

Example Request

files-cli scheduled-exports list

Show Scheduled Export

Command

files-cli scheduled-exports find

Output

Outputs a ScheduledExport object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Flags

Flag	Description
--id= int64 Required	Scheduled Export ID.

Example Request

files-cli scheduled-exports find \
  --id=1

Create Scheduled Export

Command

files-cli scheduled-exports create

Output

Outputs a ScheduledExport object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Flags

Flag	Default	Description
--name= string Required		Name for this scheduled export.
--export-type= string Required		Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
--export-options= object		Options for the report selected by export_type.
--user-id= int64		Site Admin user who receives the completed export e-mail.
--disabled boolean	`false`	If true, this scheduled export will not run.
--trigger= string	`"daily"`	Schedule trigger type: `daily` or `custom_schedule`. Possible values: `daily`, `custom_schedule`
--interval= string		If trigger is `daily`, this specifies how often to run the scheduled export.
--recurring-day= int64		If trigger is `daily`, this selects the day number inside the chosen interval.
--recurring-days= array(int64)		If trigger is `daily`, this selects one or more day numbers inside a `week`, `month`, `quarter`, or `year` interval.
--schedule-id= int64		If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
--schedule-days-of-week= array(int64)		If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
--schedule-times-of-day= array(string)		Times of day in HH:MM format for the scheduled export schedule.
--schedule-time-zone= string		Time zone used by the scheduled export schedule.
--holiday-region= string		Optional holiday region used by the scheduled export schedule.

Example Request

files-cli scheduled-exports create \
  --name="Monthly access review" \
  --export-type="permission_audit"

Update Scheduled Export

Command

files-cli scheduled-exports update

Output

Outputs a ScheduledExport object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Flags

Flag	Description
--id= int64 Required	Scheduled Export ID.
--name= string	Name for this scheduled export.
--export-type= string	Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
--export-options= object	Options for the report selected by export_type.
--user-id= int64	Site Admin user who receives the completed export e-mail.
--disabled boolean	If true, this scheduled export will not run.
--trigger= string	Schedule trigger type: `daily` or `custom_schedule`. Possible values: `daily`, `custom_schedule`
--interval= string	If trigger is `daily`, this specifies how often to run the scheduled export.
--recurring-day= int64	If trigger is `daily`, this selects the day number inside the chosen interval.
--recurring-days= array(int64)	If trigger is `daily`, this selects one or more day numbers inside a `week`, `month`, `quarter`, or `year` interval.
--schedule-id= int64	If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
--schedule-days-of-week= array(int64)	If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
--schedule-times-of-day= array(string)	Times of day in HH:MM format for the scheduled export schedule.
--schedule-time-zone= string	Time zone used by the scheduled export schedule.
--holiday-region= string	Optional holiday region used by the scheduled export schedule.

Example Request

files-cli scheduled-exports update \
  --id=1 \
  --name="Monthly access review"

Delete Scheduled Export

Command

files-cli scheduled-exports delete

Output

No output is returned.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Flags

Flag	Description
--id= int64 Required	Scheduled Export ID.

Example Request

files-cli scheduled-exports delete \
  --id=1

The ScheduledExport Object

Some of the commands above return a ScheduledExport object. The attributes of this object are listed below.

Attribute	Description
id int64	Scheduled Export ID
name string	Name for this scheduled export.
export_type string	Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
report_name string	Human-readable report name.
export_options object	Options for the report selected by export_type.
user_id int64	Site Admin user who receives the completed export e-mail.
disabled boolean	If true, this scheduled export will not run.
trigger string	Schedule trigger type: `daily` or `custom_schedule`. Possible values: `daily`, `custom_schedule`
interval string	If trigger is `daily`, this specifies how often to run the scheduled export.
recurring_day int64	If trigger is `daily`, this selects the day number inside the chosen interval.
recurring_days array(int64)	If trigger is `daily`, this selects one or more day numbers inside a `week`, `month`, `quarter`, or `year` interval.
schedule_id int64	If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
schedule_days_of_week array(int64)	If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
schedule_times_of_day array(string)	Times of day in HH:MM format for the scheduled export schedule.
schedule_time_zone string	Time zone used by the scheduled export schedule.
holiday_region string	Optional holiday region used by the scheduled export schedule.
human_readable_schedule string	Human-readable schedule description.
last_run_at date-time	Most recent scheduled attempt time, including attempts that failed validation.
last_export_id int64	Most recent Export ID created by this schedule.
last_error string	Validation error from the most recent scheduled attempt. The schedule remains enabled and retries at its next scheduled time. Cleared when an export is successfully created; does not describe errors during export generation.
created_at date-time	Creation time.
updated_at date-time	Last update time.

export_options

Options for the report selected by export_type. Each field names the report that uses it. share_link_audit and group_membership_audit have no options. Other keys are stored but not used.

Value Hash Parameter	Description
path string	folder_size_audit only. Folder to start from. Omitted or null uses the root folder.
max_depth integer	folder_size_audit only. Number of folder levels below path to include. Null or a value below 1 uses 10. A numeric string such as `"50"` is also accepted and stored as sent.
size_threshold integer	folder_size_audit only. Minimum folder size to include, in GB. Null or a value below 1 uses 1. A numeric string such as `"50"` is also accepted and stored as sent.
all_folders boolean	folder_size_audit only. If enabled, every folder up to max_depth is included regardless of size_threshold. Use `true` or `false`. Any value other than `false` or `null` enables it, including integers such as `0` and `1`.
group_by string	permission_audit only. Groups rows by `user` or `path`. Null and other values use `user`.

Example export_options

{
  "group_by": "user"
}

Scheduled Exports

List Scheduled Exports

Command

Output

Authorization Requirement

Additional Arguments

Pagination

Sorting

Filtering

Show Scheduled Export

Command

Output

Authorization Requirement

Flags

Create Scheduled Export

Command

Output

Authorization Requirement

Flags

Update Scheduled Export

Command

Output

Authorization Requirement

Flags

Delete Scheduled Export

Command

Output

Authorization Requirement

Flags

The ScheduledExport Object

export_options