API
Start typing to search…

Create a report schedule

post
https://{hostname}/etp-report/v3/configs//schedules

Creates a new report schedule for a given SIA configuration.

Path Params
integer
required

A unique identifier for each configuration.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
criterias
object

The report criteria.

boolean

Indicates a daily report schedule.

string | null
enum

Specifies the day of the week to generate the report. Refer to Report scheduling for details.

Allowed:
emails
array of strings
required
length ≥ 0

Specifies the email addresses to send generated reports.

emails*
boolean

Enables the report schedule.

filters
object

Optional filters to apply while generating the report.

string
length ≥ 1

Format of the report.

boolean

Indicates an HTML formatted report.

boolean

Indicates a new report schedule.

string
enum
required

The report schedule frequency, either DAILY, or WEEKLY. Refer to Report scheduling for details.

Allowed:
string
enum
required

The report template. The only currently supported syntax is THREAT_EVENTS_BY_LOCATION_AND_DOMAIN.

Allowed:
string
enum

The report schedule configuration status, either ENABLED or DISABLED.

Allowed:
boolean

Indicates if the report should use filters.

string
required
length ≥ 1

Specifies a user-timezone-offset for generating the report. For example, -05:00.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated about 1 month ago