REST endpoints: Scheduled reports

These endpoints mirror the CLI commands described in Scheduled reports. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

POST /scheduled_reports/create

Create a scheduled report.

CLI command: scheduled_reports create

Body fields (JSON)

Name	Type	Required	Description
ReportName	string	Yes	Name of the report (25 characters or fewer).
RecipientsEmails	array of string	Yes	Email addresses to receive the report.
Periodicity	string	Yes	How often to send the report: Daily, Weekly, Monthly, Quarterly, or Yearly.
TimeToSendFirstReport	date-time	Yes	Date and time to send the first report (must be in the future).
CommandPaths	array of string	Yes	Paths of the List commands to include in the report (up to 6).
CommandParameters	array of string	No	Parameters for each command in CommandPaths, in matching order.

DELETE /scheduled_reports/delete

Delete a scheduled report.

CLI command: scheduled_reports delete

Query parameters

Name	Type	Required	Description
reportName	string	Yes	The report to delete.

PUT /scheduled_reports/edit

Edit a scheduled report.

CLI command: scheduled_reports edit

Query parameters

Name	Type	Required	Description
reportName	string	Yes	The report to edit.

Body fields (JSON)

Name	Type	Required	Description
ReportName	string	Yes	The report to edit.
RecipientsEmails	array of string	No	Email addresses to receive the report. Replaces the current list; recipients left out are removed.
Periodicity	string	No	How often to send the report: Daily, Weekly, Monthly, Quarterly, or Yearly.
TimeToSendFirstReport	date-time	No	New date and time for the first report (must be in the future). Changing it restarts the send schedule.
CommandPaths	array of string	No	Paths of the List commands to include in the report (up to 6).
CommandParameters	array of string	No	Parameters for each command in CommandPaths, in matching order.

GET /scheduled_reports/list

List scheduled reports.

CLI command: scheduled_reports list

Query parameters

Name	Type	Required	Description
reportName	string	No	Filter by report name.

Response: a list of ScheduledReportElement objects in Result.ScheduledReportElement, each with: ReportName (string), InitiatorUsername (string), RecipientsEmails (array of string), Periodicity (string), CommandPaths (array of string), CommandParameters (array of string), TimeToSendFirstReport (date-time), TimeToSendNextReport (date-time).

POST /scheduled_reports/recipients_emails/add

Add recipients to a scheduled report.

CLI command: scheduled_reports recipients_emails add

Body fields (JSON)

Name	Type	Required	Description
ReportName	string	Yes	The report to add recipients to.
RecipientsEmails	array of string	Yes	Email addresses to add (duplicates are ignored).

DELETE /scheduled_reports/recipients_emails/delete

Remove recipients from a scheduled report.

CLI command: scheduled_reports recipients_emails delete

Query parameters

Name	Type	Required	Description
reportName	string	Yes	The report to remove recipients from.
recipientsEmails	array of string	Yes	Email addresses to remove. At least one recipient must remain.

---

See also: Requests and responses - Authentication - Examples