--- updatedAt: 2026-08-25T12:06:23.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/etp-reporting/llms.txt --- # Update a report schedule Updates the configuration of a specified report schedule. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Report schedules", "version": "v3" }, "openapi": "3.0.0", "paths": { "/configs/{configId}/schedules/{scheduleId}": { "put": { "description": "Updates the configuration of a specified report schedule.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/put-config-schedule" }, "operationId": "put-config-schedule", "parameters": [ { "description": "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).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "criterias": { "siteIds": [] }, "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", "scheduleId": 16460, "status": "ENABLED", "useFilters": false, "userTimeZone": "America/New_York" }, "schema": { "additionalProperties": false, "description": "Configures daily or weekly scheduled reports.", "properties": { "criterias": { "additionalProperties": false, "description": "The report criteria.", "properties": { "siteIds": { "description": "The site IDs for the report.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "siteIds" ], "type": "object" }, "daily": { "description": "Indicates a daily report schedule.", "type": "boolean" }, "dayOfWeek": { "description": "Specifies the day of the week to generate the report. Refer to [Report scheduling](https://techdocs.akamai.com/etp-reporting/reference/report-scheduling) for details.", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "nullable": true, "type": "string" }, "emails": { "description": "Specifies the email addresses to send generated reports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enable": { "description": "Enables the report schedule.", "type": "boolean" }, "filters": { "additionalProperties": false, "description": "Optional filters to apply while generating the report.", "properties": { "filters": { "description": "Filter strings to exclude or include report data. See the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) object for a complete list.", "enum": [ "INTERNALIP", "SOURCEPORT", "DESTINATIONPORT", "SINKHOLEID", "SINKHOLEIP", "HOSTNAME", "MACHINENAME", "UUID", "DESTINATIONIP", "SITE", "LIST", "POLICY", "ACTION", "CATEGORY", "ISALERT", "CONFIDENCE", "DOMAIN" ], "type": "string" } }, "type": "object" }, "format": { "description": "Format of the report.", "minLength": 1, "type": "string" }, "isHtml": { "description": "Indicates an HTML formatted report.", "type": "boolean" }, "isNew": { "description": "Indicates a new report schedule.", "type": "boolean" }, "recurrence": { "description": "The report schedule frequency, either `DAILY`, or `WEEKLY`. Refer to [Report scheduling](https://techdocs.akamai.com/etp-reporting/reference/report-scheduling) for details.", "enum": [ "DAILY", "WEEKLY" ], "type": "string" }, "reportTemplate": { "description": "The report template. The only currently supported syntax is `THREAT_EVENTS_BY_LOCATION_AND_DOMAIN`.", "enum": [ "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN" ], "type": "string" }, "scheduleId": { "description": "__Read-only__ A unique identifier for the report schedule configuration.", "minimum": 0, "readOnly": true, "type": "integer" }, "status": { "description": "The report schedule configuration status, either `ENABLED` or `DISABLED`.", "enum": [ "ENABLED", "DISABLED" ], "type": "string" }, "useFilters": { "description": "Indicates if the report should use filters.", "type": "boolean" }, "userTimeZone": { "description": "Specifies a user-timezone-offset for generating the report. For example, `-05:00`.", "minLength": 1, "type": "string" } }, "required": [ "recurrence", "userTimeZone", "emails", "reportTemplate" ], "type": "object", "x-akamai": { "file-path": "schemas/report-schedule-post-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "createdBy": "alfulani", "creationDate": "2017-06-22T11:12:55Z", "criterias": { "siteIds": [] }, "daily": true, "dayOfWeek": "MONDAY", "emails": [ "user1@company.com", "user2@company.com" ], "enable": true, "filters": { "isAlert": { "in": [ "true" ] } }, "isHtml": true, "isNew": true, "modifiedBy": "mrossi", "modifiedDate": "2017-06-28T11:12:55Z", "recurrence": "WEEKLY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 100, "status": "ENABLED", "useFilters": false, "userTimeZone": "+05:30" }, "schema": { "additionalProperties": true, "description": "Report scheduling configuration, on a daily or weekly basis.", "properties": { "createdBy": { "description": "The user who initially created the report schedule configuration.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the report schedule configuration's creation.", "format": "date-time", "type": "string" }, "criterias": { "additionalProperties": false, "description": "Describes the report criteria.", "properties": { "siteIds": { "description": "The site IDs applicable to the report.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "siteIds" ], "type": "object" }, "daily": { "description": "Indicates a daily report schedule.", "type": "boolean" }, "dayOfWeek": { "description": "Specifies the day of the week to generate the report. Refer to [Report scheduling](https://techdocs.akamai.com/etp-reporting/reference/report-scheduling) for details.", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "nullable": true, "type": "string" }, "emails": { "description": "Specifies the email addresses to send generated reports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enable": { "description": "Enables the report schedule.", "type": "boolean" }, "filters": { "additionalProperties": true, "description": "Specifies filters to apply while generating the report.", "properties": { "filters": { "description": "Filter strings to exclude or include report data. Refer to [Filters object](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "enum": [ "INTERNALIP", "SOURCEPORT", "DESTINATIONPORT", "SINKHOLEID", "SINKHOLEIP", "HOSTNAME", "MACHINENAME", "UUID", "DESTINATIONIP", "SITE", "LIST", "POLICY", "ACTION", "CATEGORY", "ISALERT", "CONFIDENCE", "DOMAIN" ], "type": "string" } }, "type": "object" }, "format": { "description": "Format of the report.", "minLength": 1, "type": "string" }, "isHtml": { "description": "Indicates an HTML formatted report.", "type": "boolean" }, "isNew": { "description": "Indicates a new report.", "type": "boolean" }, "modifiedBy": { "description": "The user who last modified the report schedule configuration.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp string marking the report schedule configuration's last modification.", "format": "date-time", "type": "string" }, "recurrence": { "description": "Specifies the frequency of the report schedule, either `DAILY`, or `WEEKLY`.", "enum": [ "DAILY", "WEEKLY" ], "type": "string" }, "reportTemplate": { "description": "Specifies the report template. The only currently supported syntax is `THREAT_EVENTS_BY_LOCATION_AND_DOMAIN`.", "enum": [ "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN" ], "type": "string" }, "scheduleId": { "description": "A unique identifier for the report schedule configuration.", "minimum": 0, "type": "integer" }, "status": { "description": "Specifies the status of the report schedule configuration, either `ENABLED` or `DISABLED`.", "enum": [ "ENABLED", "DISABLED" ], "type": "string" }, "useFilters": { "description": "Indicates if the report should use filters.", "type": "boolean" }, "userTimeZone": { "description": "Specifies a user timezone offset for generating the report. For example, `-05:00`.", "minLength": 1, "type": "string" } }, "required": [ "recurrence", "userTimeZone", "emails", "reportTemplate" ], "type": "object", "x-akamai": { "file-path": "schemas/report-schedule.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "detail": "The system cannot understand your request. Please check the syntax and correct any problems.", "instance": "1e4c346b-3a36-4527-9c37-86ae748b87c5", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "detail": "Start time is invalid. Code-000104", "instance": "0415df5e-6e9c-4596-bdd3-9ada53b63599", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" } } }, "schema": { "additionalProperties": true, "description": "A common [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Response error.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem response error object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/http-problem.yaml" } } } }, "description": "[Bad Request](https://techdocs.akamai.com/etp-reporting/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "A common [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Response error.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem response error object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/http-problem.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/etp-reporting/reference/403).", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Invalid SIA configuration 101. Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "A common [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Response error.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem response error object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/http-problem.yaml" } } } }, "description": "[Configuration not Found](https://techdocs.akamai.com/etp-reporting/reference/404).", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Update a report schedule", "tags": [ "Report schedules" ] }, "parameters": [ { "description": "A unique identifier for each report schedule configuration.", "in": "path", "name": "scheduleId", "required": true, "schema": { "example": 1000, "type": "integer" }, "x-akamai": { "file-path": "parameters/schedule-id-path.yaml" } }, { "description": "A unique identifier for each configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 100, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/schedule.yaml", "path-info": "/configs/{configId}/schedules/{scheduleId}" } } }, "servers": [ { "url": "https://{hostname}/etp-report/v3" } ], "tags": [ { "description": "Set up schedules to generate SIA reports.", "name": "Report schedules" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "12-report-schedule.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ``` # Sibling pages * [Create a report schedule](https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule.md) * [List report schedules](https://techdocs.akamai.com/etp-reporting/reference/get-config-schedules.md) * [Get a report schedule](https://techdocs.akamai.com/etp-reporting/reference/get-config-schedule.md) * [Remove a report schedule](https://techdocs.akamai.com/etp-reporting/reference/delete-config-schedule.md) * [Disable a report schedule](https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule-disable.md) * [Enable a report schedule](https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule-enable.md)