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

SDK Method

files_sdk.scheduled_export.list()

Return Object

ListObj[ScheduledExport]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import files_sdk

try:
  scheduled_exports = files_sdk.scheduled_export.list()
  for scheduled_export in scheduled_exports.auto_paging_iter():
    # Operate on scheduled_export
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Scheduled Export

SDK Method

files_sdk.scheduled_export.find()

Return Object

ScheduledExport

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Scheduled Export ID.

Example Request

import files_sdk

try:
  scheduled_export = files_sdk.scheduled_export.find(id)
  # Operate on scheduled_export
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Create Scheduled Export

SDK Method

files_sdk.scheduled_export.create()

Return Object

ScheduledExport

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
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		Report-specific options. permission_audit supports group_by with user or path.
user_id
int64		Site Admin user who receives the completed export e-mail.
disabled
boolean		falseIf 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

import files_sdk

try:
  scheduled_export = files_sdk.scheduled_export.create({
    "name": "Monthly access review",
    "export_type": "permission_audit"
  })
  # Operate on scheduled_export
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Update Scheduled Export

SDK Method

scheduled_export.update()

Return Object

ScheduledExport

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
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		Report-specific options. permission_audit supports group_by with user or path.
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

import files_sdk

try:
  # Find the scheduled_export object by its id.
  scheduled_export = files_sdk.scheduled_export.find(id)
  scheduled_export.update({
    "name": "Monthly access review"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Delete Scheduled Export

SDK Method

scheduled_export.delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import files_sdk

try:
  # Find the scheduled_export object by its id.
  scheduled_export = files_sdk.scheduled_export.find(id)
  scheduled_export.delete()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The ScheduledExport Object

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

AttributeDescription
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		Report-specific options. permission_audit supports group_by with user or path.
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 run time.
last_export_id
int64		Most recent Export ID created by this schedule.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.