Akamai APIs API Documentation
Create a report schedule
POST https://{{host}}/etp-report/v3/configs/:configId/schedules
Creates a new report schedule for a given SIA configuration.
Body
PARAM
| Key | Datatype | Required | Description |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status Created
| {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Report scheduling configuration, on a daily or weekly basis.",
"id": "resource:/descriptors/etp-report/v3/schemas/report-schedule#",
"properties": {
"createdBy": {
"description": "Identifies the user who initially created the report schedule configuration.",
"readOnly": true,
"type": "string"
},
"createdDate": {
"description": "ISO 8601 timestamp string indicating when the report schedule configuration was initially created.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"criterias": {
"description": "Describes the report criterias",
"properties": {
"siteIds": {
"description": "The siteIds applicable to the report",
"items": {
"description": "The id of the site",
"type": "string"
},
"type": "array"
}
},
"required": [
"siteIds"
],
"type": "object"
},
"daily": {
"description": "Indicates if reports are scheduled daily",
"type": "boolean"
},
"dayOfWeek": {
"description": "Specifies the day of the week the report generates, either `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, or `SUNDAY`. Only used when `recurrence` is set to `WEEKLY`, otherwise `null`. ",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"type": [
"string",
"nu Curl curl -X POST 'https://host/etp-report/v3/configs/:configId/schedules?accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"daily":true,"dayOfWeek":null,"emails":["user@example.com"],"enable":true,"format":"HTML","isHtml":true,"isNew":true,"recurrence":"DAILY","reportTemplate":"THREAT_EVENTS_BY_LOCATION_AND_DOMAIN","status":"ENABLED","useFilters":false,"userTimeZone":"America/New_York"}' ENDPOINTS |