Update a report schedule

put https://{hostname}/etp-report/v3/configs/{configId}/schedules/{scheduleId}

Updates the configuration of a specified report schedule.

Path Params

scheduleId

integer

required

A unique identifier for each report schedule configuration.

configId

integer

required

A unique identifier for each configuration.

Query Params

accountSwitchKey

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.

daily

boolean

Indicates a daily report schedule.

dayOfWeek

string | null

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

emails

array of strings

required

length ≥ 0

Specifies the email addresses to send generated reports.

emails*

enable

boolean

Enables the report schedule.

filters

object

Optional filters to apply while generating the report.

format

string

length ≥ 1

Format of the report.

isHtml

boolean

Indicates an HTML formatted report.

isNew

boolean

Indicates a new report schedule.

recurrence

string

required

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

reportTemplate

string

required

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

status

string

The report schedule configuration status, either ENABLED or DISABLED.

useFilters

boolean

Indicates if the report should use filters.

userTimeZone

string

required

length ≥ 1

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

Responses

Response body

object

createdBy

string

length ≥ 1

The user who initially created the report schedule configuration.

createdDate

date-time

ISO 8601 timestamp marking the report schedule configuration's creation.

criterias

object

Describes the report criteria.

siteIds

array of strings

required

length ≥ 0

The site IDs applicable to the report.

siteIds*

daily

boolean

Indicates a daily report schedule.

dayOfWeek

string | null

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

MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY

emails

array of strings

required

length ≥ 0

Specifies the email addresses to send generated reports.

emails*

enable

boolean

Enables the report schedule.

filters

object

Specifies filters to apply while generating the report.

Has additional fields

format

string

length ≥ 1

Format of the report.

isHtml

boolean

Indicates an HTML formatted report.

isNew

boolean

Indicates a new report.

modifiedBy

string

length ≥ 1

The user who last modified the report schedule configuration.

modifiedDate

date-time

ISO 8601 timestamp string marking the report schedule configuration's last modification.

recurrence

string

required

Specifies the frequency of the report schedule, either DAILY, or WEEKLY.

DAILY WEEKLY

reportTemplate

string

required

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

THREAT_EVENTS_BY_LOCATION_AND_DOMAIN

scheduleId

integer

≥ 0

A unique identifier for the report schedule configuration.

status

string

Specifies the status of the report schedule configuration, either ENABLED or DISABLED.

ENABLED DISABLED

useFilters

boolean

Indicates if the report should use filters.

userTimeZone

string

required

length ≥ 1

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

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://hostname/etp-report/v3/configs/configId/schedules/scheduleId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "recurrence": "DAILY",
8
  "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN"
9
}
10
'


xxxxxxxxxx
31
}
1
{
2
  "createdBy": "alfulani",
3
  "creationDate": "2017-06-22T11:12:55Z",
4
  "criterias": {
5
    "siteIds": []
6
  },
7
  "daily": true,
8
  "dayOfWeek": "MONDAY",
9
  "emails": [
10
    "user1@akamai.com",
11
    "user2@akamai.com"
12
  ],
13
  "enable": true,
14
  "filters": {
15
    "isAlert": {
16
      "in": [
17
        "true"
18
      ]
19
    }
20
  },
21
  "isHtml": true,
22
  "isNew": true,
23
  "modifiedBy": "mrossi",
24
  "modifiedDate": "2017-06-28T11:12:55Z",
25
  "recurrence": "WEEKLY",

200Successful response.

400Bad Request.

403Access forbidden.

404Configuration not Found.