{ "components": { "parameters": { "cardinality-query": { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, "config-id-path": { "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" } }, "dimension-threat-query": { "description": "Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "destinationIP", "site", "list", "policy", "action", "category", "confidence", "clientIP", "transportType", "dohAttribution", "sublocationId", "devicePostureRisk", "detectionType", "deviceId", "onrampType", "encryptedInternalClientIP", "encryptedInternalClientName", "encryptedUserName", "deviceOwnerId", "dlpDictionaryId", "dlpPatternId", "dlpFileHash", "fileType", "applicationId", "riskId", "operationId", "threatId", "severityId", "httpRequestMethod", "uri", "proxyDestinationPort", "reason", "l7Protocol", "blockDescription" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-threat-query.yaml" } }, "end-time-sec-query": { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, "filters-query-threat": { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter threat report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-threats.yaml" } }, "x-akamai": { "file-path": "parameters/filters-query-threat.yaml" } }, "start-time-sec-query": { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } } }, "responses": { "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } }, "insufficient-permissions-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" } }, "not-found-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" } } }, "schemas": { "DETECTION_TYPE": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "DP_RISK": { "enum": [ "low", "medium" ], "type": "string" }, "HTTP_METHOD": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "IS_ONRAMP": { "enum": [ "No", "Yes" ], "type": "string" }, "L7_PROTOCOL": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "ONRAMP_TYPE": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "SEVERITY": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "common-time-series-response": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } }, "events": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "file-detail": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "filters-criteria": { "additionalProperties": false, "description": "Filter criteria options to filter report data.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "filters-criteria-boolean": { "additionalProperties": false, "description": "Filter criteria options to filter report data.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "filters-criteria-detection-type": { "additionalProperties": true, "description": "Filter criteria options for detection type to filter report data. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "filters-criteria-dp-risk": { "additionalProperties": false, "description": "Indicates the data protection risk level. Use `low` for devices with low risk, and use `medium` for devices with medium risk.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "filters-criteria-http-methods": { "additionalProperties": false, "description": "Filter criteria options for HTTP Method to filter report data. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "filters-criteria-integer": { "additionalProperties": false, "description": "Filter criteria options to filter report data.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "filters-criteria-l7protocol": { "additionalProperties": false, "description": "Filter criteria options for L7 Protocol to filter report data. Either `DNS`, `HTTP`, or `HTTP(s)`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "filters-criteria-onramp": { "additionalProperties": false, "description": "Filter criteria options for onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "filters-criteria-onramp-type": { "additionalProperties": false, "description": "Filter criteria options for onramp type. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "filters-criteria-severity": { "additionalProperties": false, "description": "Severity level filters. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "filters-threats": { "additionalProperties": false, "description": "Options to filter threat report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-threats.yaml" } }, "http-problem": { "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" } }, "http-problem-nested": { "description": "A nested problem response error object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-nested.yaml" } }, "identifier-id": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "page-info": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } }, "query": { "additionalProperties": false, "description": "Requested DNS query information.", "properties": { "clientIp": { "description": "The requesting client's IP address.", "type": "string" }, "deviceId": { "description": "ID of the device.", "minLength": 1, "type": "string" }, "deviceName": { "description": "Name of device used.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier for the device owner.", "type": "string" }, "dnsIp": { "description": "The DNS resolver IP address.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "queryType": { "description": "The DNS query type, such as `A` or `CNAME`.", "minLength": 1, "type": "string" }, "resolved": { "description": "The details about the requested DNS query resolution.", "items": { "additionalProperties": false, "properties": { "asn": { "description": "Autonomous system number used for resolution.", "minLength": 1, "type": "string" }, "asname": { "description": "Autonomous system name used for resolution.", "minLength": 1, "type": "string" }, "response": { "description": "Resolved domain or IP address.", "minLength": 1, "type": "string" }, "type": { "description": "DNS resolution type. For example: `A` or `CNAME`.", "minLength": 1, "type": "string" } }, "required": [ "asn", "response", "type" ], "type": "object" }, "minItems": 0, "type": "array" }, "time": { "description": "Time of DNS request in ISO 8601 format.", "format": "date-time", "type": "string" }, "uuid": { "description": "UUID value.", "minLength": 1, "type": "string" } }, "required": [ "time", "clientIp", "dnsIp", "domain", "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/query.yaml" } }, "sinkhole-events-details": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "threat-event-details-nested": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "threat-events-aggregate-site": { "additionalProperties": false, "description": "Response with details.", "properties": { "aggregations": { "description": "An aggregated list of events or traffic for the given time period.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the aggregation.", "minLength": 1, "type": "string" }, "total": { "description": "The total count of threat events for the identifier for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" }, "minItems": 1, "type": "array" }, "dimension": { "additionalProperties": false, "description": "Indicates the dimension value to aggregate by.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the dimension.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "aggregations", "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-aggregate-site.yaml" } }, "threat-events-details": { "additionalProperties": false, "description": "Threat event report details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "event": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "id": { "description": "A unique identifier for the column object.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "The layer 7 protocol used to make the DNS query or web request. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "query": { "additionalProperties": false, "description": "Requested DNS query information.", "properties": { "clientIp": { "description": "The requesting client's IP address.", "type": "string" }, "deviceId": { "description": "ID of the device.", "minLength": 1, "type": "string" }, "deviceName": { "description": "Name of device used.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier for the device owner.", "type": "string" }, "dnsIp": { "description": "The DNS resolver IP address.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "queryType": { "description": "The DNS query type, such as `A` or `CNAME`.", "minLength": 1, "type": "string" }, "resolved": { "description": "The details about the requested DNS query resolution.", "items": { "additionalProperties": false, "properties": { "asn": { "description": "Autonomous system number used for resolution.", "minLength": 1, "type": "string" }, "asname": { "description": "Autonomous system name used for resolution.", "minLength": 1, "type": "string" }, "response": { "description": "Resolved domain or IP address.", "minLength": 1, "type": "string" }, "type": { "description": "DNS resolution type. For example: `A` or `CNAME`.", "minLength": 1, "type": "string" } }, "required": [ "asn", "response", "type" ], "type": "object" }, "minItems": 0, "type": "array" }, "time": { "description": "Time of DNS request in ISO 8601 format.", "format": "date-time", "type": "string" }, "uuid": { "description": "UUID value.", "minLength": 1, "type": "string" } }, "required": [ "time", "clientIp", "dnsIp", "domain", "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/query.yaml" } } }, "required": [ "id", "configId", "l7Protocol", "query", "event" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details.yaml" } }, "threat-events-details-request": { "additionalProperties": true, "description": "Request parameters for a detailed report of events.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter threat report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-threats.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`. Defaults to `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details-request.yaml" } }, "threat-events-details-response": { "additionalProperties": true, "description": "A detailed list of threat events for the given time period.", "properties": { "dataRows": { "description": "Threat event report details and a list of matching events.", "items": { "additionalProperties": false, "description": "Threat event report details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "event": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "id": { "description": "A unique identifier for the column object.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "The layer 7 protocol used to make the DNS query or web request. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "query": { "additionalProperties": false, "description": "Requested DNS query information.", "properties": { "clientIp": { "description": "The requesting client's IP address.", "type": "string" }, "deviceId": { "description": "ID of the device.", "minLength": 1, "type": "string" }, "deviceName": { "description": "Name of device used.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier for the device owner.", "type": "string" }, "dnsIp": { "description": "The DNS resolver IP address.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "queryType": { "description": "The DNS query type, such as `A` or `CNAME`.", "minLength": 1, "type": "string" }, "resolved": { "description": "The details about the requested DNS query resolution.", "items": { "additionalProperties": false, "properties": { "asn": { "description": "Autonomous system number used for resolution.", "minLength": 1, "type": "string" }, "asname": { "description": "Autonomous system name used for resolution.", "minLength": 1, "type": "string" }, "response": { "description": "Resolved domain or IP address.", "minLength": 1, "type": "string" }, "type": { "description": "DNS resolution type. For example: `A` or `CNAME`.", "minLength": 1, "type": "string" } }, "required": [ "asn", "response", "type" ], "type": "object" }, "minItems": 0, "type": "array" }, "time": { "description": "Time of DNS request in ISO 8601 format.", "format": "date-time", "type": "string" }, "uuid": { "description": "UUID value.", "minLength": 1, "type": "string" } }, "required": [ "time", "clientIp", "dnsIp", "domain", "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/query.yaml" } } }, "required": [ "id", "configId", "l7Protocol", "query", "event" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details.yaml" } }, "minItems": 1, "type": "array" }, "pageInfo": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } } }, "required": [ "dataRows", "pageInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details-response.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference" }, "info": { "description": "Access and analyze reports for acceptable user policy (AUP) events, DNS activity, network traffic connections, security connector events, and threat events.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Secure Internet Access Enterprise Reporting API", "version": "v3" }, "openapi": "3.0.0", "paths": { "/configs/{configId}/access-logs/details": { "post": { "description": "Lists the IDP access logs for a configuration for a given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-access-logs-details" }, "operationId": "post-access-logs-details", "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": { "endTimeSec": 1589965237, "filters": { "eventName": { "in": [ "login_attempt" ] } }, "startTimeSec": 1587459637, "upToCount": 500 }, "schema": { "additionalProperties": false, "description": "Specifies IDP access log details.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter IdP report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "eventName": { "additionalProperties": false, "description": "Filter report data by event name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-idp.yaml" } }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" }, "upToCount": { "description": "The number of records expected in the report.", "minimum": 0, "type": "integer" } }, "required": [ "startTimeSec", "endTimeSec", "filters" ], "type": "object", "x-akamai": { "file-path": "schemas/idp-access-log-post-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "text/csv": { "example": "# Time Zone: UTC +00:00\nAuditStartTime,ConfigId,SiteId,SiteName,ConnectionId,AllowUnauthenticated,EventName,InternalClientIp,Message,Username,UserId,Groups\n2020-05-26T09:16:23.434,1041,51279,EDI squid proxy,0x3706B3105044C12BAD1C,false,login_attempt,null,,null,null,\n2020-05-26T09:02:56.879,1041,51279,EDI squid proxy,0x3706B316503872A3AD39,false,login_attempt,null,,null,null,\n2020-05-26T09:16:20.874,1041,51279,EDI squid proxy,0x3706B3105044B5F9AD19,false,login_attempt,null,,null,null,\n2020-05-26T09:16:23.196,1041,51279,EDI squid proxy,0x3706B3105044C198AD1D,false,login_attempt,null,,null,null,\n2020-05-26T09:16:22.553,1041,51279,EDI squid proxy,0x3706B3105044BEC8AD1B,false,login_attempt,null,,null,null,\n2020-05-26T09:16:23.767,1041,51279,EDI squid proxy,0x3706B3135044B618965A,false,login_attempt,null,,null,null,\n2020-05-26T06:55:05.928,1041,51279,EDI squid proxy,0x3706B3104FC338DFA91B,false,login_attempt,null,,null,null,\n2020-05-26T06:24:55.093,1041,51279,EDI squid proxy,0x3706B3164FA7C4A3AC6B,false,login_attempt,null,,null,null,\n2020-05-26T06:30:13.068,1041,51279,EDI squid proxy,0x3706B3154FAC93E81162A,false,login_attempt,null,,null,null," } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report IDP access log details", "tags": [ "IDP access logs" ] }, "parameters": [ { "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/access-logs-details.yaml", "path-info": "/configs/{configId}/access-logs/details" } }, "/configs/{configId}/aup-events/aggregate": { "get": { "description": "Lists total counts for AUP events, aggregated for the given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-aup-events" }, "operationId": "get-aup-events", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "category", "policy", "site", "applicationId", "l7Protocol", "clientRequestId", "deviceId", "deviceOwnerId", "devicePostureRisk", "dlpDictionaryId", "dlpPatternId", "fileType", "group", "encryptedInternalClientIP", "encryptedInternalClientName", "matchedGroups", "onrampType", "operationId", "reason", "riskId", "sublocationId", "encryptedUserId", "encryptedUserName" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-aup-query.yaml" } }, { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter AUP events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "applicationId": { "additionalProperties": false, "description": "Filter report data by application IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserId": { "additionalProperties": false, "description": "Filter report data by userId, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "group": { "additionalProperties": false, "description": "Filter report data by user group type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter report data by alert status, either `true` or `false`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "matchedGroups": { "additionalProperties": false, "description": "Filter report data by matched user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "operationId": { "additionalProperties": false, "description": "Filter data based on operation.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-aup-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-query-aup.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregations": [ { "id": "-1", "name": "Gambling", "total": 321 }, { "id": "1", "name": "Firearms", "total": 201 }, { "id": "2", "name": "Violence", "total": 98 }, { "id": "3", "name": "Adult", "total": 12 }, { "id": "OTHERS", "total": 6 } ], "dimension": { "id": "category", "name": "category", "total": 5 } }, "schema": { "additionalProperties": false, "description": "Aggregated report details and a list of matching events.", "properties": { "aggregations": { "description": "Aggregated information about events.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The total count of activity for the identifier for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "id", "total" ], "type": "object" }, "minItems": 0, "type": "array" }, "dimension": { "additionalProperties": false, "description": "Aggregated dimension level information.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "aggregations", "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/aggregate.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report AUP event totals", "tags": [ "AUP events" ] }, "parameters": [ { "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/aup-events-aggregate.yaml", "path-info": "/configs/{configId}/aup-events/aggregate" } }, "/configs/{configId}/aup-events/details": { "post": { "description": "Provides all threat events record details for a given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-events-details" }, "operationId": "post-events-details", "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": { "endTimeSec": 1589965237, "filters": {}, "orderBy": "DESC", "pageNumber": 1, "pageSize": 5, "startTimeSec": 1587459637 }, "schema": { "additionalProperties": true, "description": "Request parameters for a detailed events report.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter AUP events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "applicationId": { "additionalProperties": false, "description": "Filter report data by application IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserId": { "additionalProperties": false, "description": "Filter report data by userId, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "group": { "additionalProperties": false, "description": "Filter report data by user group type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter report data by alert status, either `true` or `false`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "matchedGroups": { "additionalProperties": false, "description": "Filter report data by matched user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "operationId": { "additionalProperties": false, "description": "Filter data based on operation.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-aup-events.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec", "endTimeSec", "orderBy" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-events-details-request.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "configId": "1041", "event": { "actionId": "6", "actionName": "Classify", "categoryId": "24", "categoryName": "24", "clientRequestId": "00019749", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacnc.com", "internalIP": "192.0.2.0", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.222", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2020-05-26T06:34:53Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "24", "listName": "24", "onRamp": "Yes", "onrampType": "etp-client", "policyEvaluationSource": "dns", "policyId": "38307", "policyName": "E2E-CML", "reason": "Akamai Intelligence (DNS)", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "threatId": 2000, "threatName": "AUP", "trigger": "domain" }, "id": "0", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.109", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "dnsIp": "192.0.2.151", "domain": "d.la1-c2-ia4.salesforceliveagent.com.", "queryType": "A", "resolved": [ { "asn": "14340", "asname": "N/A", "response": "192.0.2.62", "type": "A" }, { "asn": "14340", "asname": "N/A", "response": "192.0.2.178", "type": "A" }, { "asn": "14340", "asname": "N/A", "response": "192.0.2.183", "type": "A" } ], "time": "2020-05-26T06:34:53Z", "uuid": "198.18.193.241-198.18.193.228-1590474893-46281-35384" } }, { "configId": "1041", "event": { "actionId": "6", "actionName": "Classify", "categoryId": "24", "categoryName": "24", "clientRequestId": "00019748", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacnc.com", "internalIP": "192.0.2.165", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.251", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2020-05-26T06:34:52Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "24", "listName": "24", "onRamp": "Yes", "onrampType": "etp-client", "policyEvaluationSource": "dns", "policyId": "38307", "policyName": "E2E-CML", "reason": "Akamai Intelligence (DNS)", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "threatId": 2000, "threatName": "AUP", "trigger": "domain" }, "id": "1", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.171", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "dnsIp": "192.0.2.1", "domain": "teams.microsoft.com.", "queryType": "A", "resolved": [ { "asn": "8068", "asname": "N/A", "response": "192.0.2.102", "type": "A" } ], "time": "2020-05-26T06:34:52Z", "uuid": "198.18.193.241-198.18.193.228-1590474892-14345-62675" } }, { "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "categoryId": "1", "categoryName": "Malware", "clientRequestId": "", "confidenceId": "2", "confidenceName": "Known", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacnc.com", "internalIP": "192.0.2.124", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.132", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2020-05-26T06:34:51Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "1", "listName": "Malware", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "reason": "Akamai Intelligence (DNS)", "severityId": 2, "severityLevel": "High", "siteId": "-1", "siteName": "Unidentified IPs", "threatId": 5070, "threatName": "Known Malware", "trigger": "domain" }, "id": "2", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.104", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.231", "domain": "1590449691.akamaisiamalware.com.", "queryType": "AAAA", "resolved": [ { "asn": "N/A", "asname": "N/A", "response": "N/A", "type": "N/A" } ], "time": "2020-05-26T06:34:51Z", "uuid": "198.18.193.241-198.18.179.134-1590474891-6340-2976" } }, { "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "categoryId": "1", "categoryName": "Malware", "clientRequestId": "", "confidenceId": "2", "confidenceName": "Known", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacnc.com", "internalIP": "192.0.2.136", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.176", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2020-05-26T06:34:51Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "1", "listName": "Malware", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "reason": "Akamai Intelligence (DNS)", "severityId": 2, "severityLevel": "High", "siteId": "-1", "siteName": "Unidentified IPs", "threatId": 5070, "threatName": "Known Malware", "trigger": "domain" }, "id": "3", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.149", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.94", "domain": "1590449691.akamaisiamalware.com.", "queryType": "A", "resolved": [ { "asn": "14618", "asname": "aws", "response": "192.0.2.33", "type": "A" } ], "time": "2020-05-26T06:34:51Z", "uuid": "198.18.193.241-198.18.179.134-1590474891-42367-7406" } }, { "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "categoryId": "5", "categoryName": "DNS Exfiltration", "clientRequestId": "", "confidenceId": "1", "confidenceName": "Suspected", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacnc.com", "internalIP": "192.0.2.165", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.207", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2020-05-26T06:34:51Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "4", "listName": "DNS Exfiltration", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "reason": "Akamai Intelligence (DNS)", "severityId": 4, "severityLevel": "Low", "siteId": "-1", "siteName": "Unidentified IPs", "threatId": 5135, "threatName": "Suspected DNS tunneling", "trigger": "domain" }, "id": "4", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.132", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.240", "domain": "1590449691.akamaisiamalware.com.e2e-sia.org.", "queryType": "AAAA", "resolved": [ { "asn": "N/A", "asname": "N/A", "response": "N/A", "type": "N/A" } ], "time": "2020-05-26T06:34:51Z", "uuid": "198.18.193.241-198.18.179.134-1590474891-5081-49572" } } ], "pageInfo": { "pageNumber": 1, "pageSize": 5, "totalRecords": 97913 } }, "schema": { "additionalProperties": false, "description": "A detailed list of AUP events for the given time period.", "properties": { "dataRows": { "description": "High-level AUP event details and a list of matching events.", "items": { "additionalProperties": false, "description": "AUP event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "event": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "id": { "description": "A unique identifier for the column object.", "type": "string" }, "isEvent": { "description": "Indicates if the event is an AUP event.", "type": "boolean" }, "l7Protocol": { "description": "The layer 7 protocol used to make the DNS query or web request. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "query": { "additionalProperties": false, "description": "Requested DNS query information.", "properties": { "clientIp": { "description": "The requesting client's IP address.", "type": "string" }, "deviceId": { "description": "ID of the device.", "minLength": 1, "type": "string" }, "deviceName": { "description": "Name of device used.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier for the device owner.", "type": "string" }, "dnsIp": { "description": "The DNS resolver IP address.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "queryType": { "description": "The DNS query type, such as `A` or `CNAME`.", "minLength": 1, "type": "string" }, "resolved": { "description": "The details about the requested DNS query resolution.", "items": { "additionalProperties": false, "properties": { "asn": { "description": "Autonomous system number used for resolution.", "minLength": 1, "type": "string" }, "asname": { "description": "Autonomous system name used for resolution.", "minLength": 1, "type": "string" }, "response": { "description": "Resolved domain or IP address.", "minLength": 1, "type": "string" }, "type": { "description": "DNS resolution type. For example: `A` or `CNAME`.", "minLength": 1, "type": "string" } }, "required": [ "asn", "response", "type" ], "type": "object" }, "minItems": 0, "type": "array" }, "time": { "description": "Time of DNS request in ISO 8601 format.", "format": "date-time", "type": "string" }, "uuid": { "description": "UUID value.", "minLength": 1, "type": "string" } }, "required": [ "time", "clientIp", "dnsIp", "domain", "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/query.yaml" } }, "request": { "additionalProperties": false, "description": "The details about the web request.", "properties": { "clientIp": { "description": "The IP address of the source NAT branch or machine.", "type": "string" }, "clientPort": { "description": "The TCP port used by the client machine to connect the destination.", "minimum": 0, "type": "integer" }, "connectionId": { "description": "The unique identifier of the TCP connection created.", "minLength": 1, "type": "string" }, "destinationIP": { "description": "The IP address of the target machine to send the request.", "type": "string" }, "destinationPort": { "description": "The TCP port used to connect the destination machine.", "minimum": 0, "type": "integer" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "endTime": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "headers": { "description": "The details about the HTTP request headers.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP request header.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP request header.", "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "minItems": 1, "type": "array" }, "method": { "description": "The HTTP action used to interact with the destination.", "minLength": 1, "type": "string" }, "queryStrings": { "description": "The details about the query parameters sent as part of the web request.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the query parameter.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the query parameter.", "minLength": 0, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "minItems": 0, "type": "array" }, "startTime": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" }, "uri": { "description": "The path part of the URL.", "minLength": 1, "type": "string" }, "uuid": { "description": "A unique ID for the request.", "type": "string" } }, "required": [ "startTime", "connectionId", "domain", "uri" ], "type": "object", "x-akamai": { "file-path": "schemas/request.yaml" } }, "response": { "additionalProperties": false, "description": "The details about the response to the web request.", "properties": { "endTime": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "hash": { "description": "The hashed value of the response.", "type": "string" }, "headers": { "description": "The details about the HTTP response headers.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP response header.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP response header.", "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "minItems": 0, "type": "array" }, "responseCode": { "description": "The response's HTTP status code.", "type": "string" }, "startTime": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "headers" ], "type": "object", "x-akamai": { "file-path": "schemas/response.yaml" } } }, "required": [ "id", "configId", "l7Protocol", "query", "event" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-events-details.yaml" } }, "minItems": 0, "type": "array" }, "pageInfo": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } } }, "required": [ "dataRows" ], "type": "object", "x-akamai": { "file-path": "schemas/post-events-details-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report AUP event details", "tags": [ "AUP events" ] }, "parameters": [ { "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/aup-events-details.yaml", "path-info": "/configs/{configId}/aup-events/details" } }, "/configs/{configId}/aup-events/time-series": { "get": { "description": "Lists total counts for AUP events, aggregated by hour.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-events-time-series" }, "operationId": "get-events-time-series", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "category", "policy", "site", "applicationId", "l7Protocol", "clientRequestId", "deviceId", "deviceOwnerId", "devicePostureRisk", "dlpDictionaryId", "dlpPatternId", "fileType", "group", "encryptedInternalClientIP", "encryptedInternalClientName", "matchedGroups", "onrampType", "operationId", "reason", "riskId", "sublocationId", "encryptedUserId", "encryptedUserName" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-aup-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter AUP events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "applicationId": { "additionalProperties": false, "description": "Filter report data by application IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserId": { "additionalProperties": false, "description": "Filter report data by userId, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "group": { "additionalProperties": false, "description": "Filter report data by user group type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter report data by alert status, either `true` or `false`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "matchedGroups": { "additionalProperties": false, "description": "Filter report data by matched user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "operationId": { "additionalProperties": false, "description": "Filter data based on operation.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-aup-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-query-aup.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "timeStamp" }, { "id": "aup-events", "name": "AUP_EVENTS" } ], "rows": [ [ "2016-05-03T18:24:17Z", 8 ], [ "2016-05-03T18:53:05Z", 946 ], [ "2016-05-03T19:21:53Z", 888 ], [ "2016-05-03T19:50:41Z", 398 ], [ "2016-05-03T20:19:29Z", 79 ], [ "2016-05-03T20:48:17Z", 25 ], [ "2016-05-03T21:17:05Z", 300 ], [ "2016-05-03T21:45:53Z", 395 ], [ "2016-05-03T22:14:41Z", 715 ], [ "2016-05-03T22:43:29Z", 671 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report AUP event time series", "tags": [ "AUP events" ] }, "parameters": [ { "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/aup-events-time-series.yaml", "path-info": "/configs/{configId}/aup-events/time-series" } }, "/configs/{configId}/deep-scan-reports": { "get": { "description": "Deepscan results for a configuration's offline network for a given time period. Use the path obtained from `/threat-events`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-scan-reports" }, "operationId": "get-scan-reports", "parameters": [ { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "schema": { "example": "{\"action\":{\"in\":[\"1\"]},\"isAlert\":{\"in\":[\"true\"]},\"site\":{\"in\":[\"-1\"]},\"list\":{\"in\":[\"1\"]},\"policy\":{\"in\":[\"164\"]},\"category\":{\"in\":[\"1\"]},\"domain\":{\"in\":[\"njit.edu.\"]},\"destinationIp\":{\"in\":[\"1.2.1.43\"]},\"country\":{\"in\":[\"US\"]}}", "type": "string" }, "x-akamai": { "file-path": "parameters/filters-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "description": "A Deepscan report in a PDF file.", "format": "binary", "type": "string", "x-akamai": { "file-path": "schemas/deepscan-report-response.yaml" } } } }, "description": "A binary PDF file." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Get deepscan details report", "tags": [ "Deepscan reports" ] }, "parameters": [ { "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/deep-scan-reports.yaml", "path-info": "/configs/{configId}/deep-scan-reports" } }, "/configs/{configId}/dns-activities/aggregate": { "get": { "description": "Lists the count of DNS activities aggregated for the given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-dns-activities" }, "operationId": "get-dns-activities", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "site", "clientIP", "policy", "action", "applicationId", "asName", "category", "clientRequestId", "deviceId", "deviceOwnerId", "dohAttribution", "encryptedInternalClientIP", "encryptedInternalClientName", "onrampType", "queryType", "destinationIP", "riskId", "scId", "sublocationId", "transportType" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-dns-query.yaml" } }, { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter DNS events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "applicationId": { "additionalProperties": false, "description": "Filter by AVC application.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "queryType": { "additionalProperties": false, "description": "Filter report data by query type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by risk values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "scId": { "additionalProperties": false, "description": "Filter report data by security connector values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-dns-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-dns-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregations": [ { "id": "US", "name": "United States", "total": 123442 }, { "id": "JP", "name": "Japan", "total": 92342 }, { "id": "IN", "name": "India", "total": 23434 }, { "id": "UK", "name": "UK Scotland", "total": 234445 }, { "id": "OTHERS", "name": "Misc Site", "total": 23423431 } ], "dimension": { "id": "geo", "name": "geo", "total": 5 } }, "schema": { "additionalProperties": false, "description": "High-level DNS activity event geo details and a list of matching events.", "properties": { "aggregations": { "description": "High level aggregated report.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The total count of DNS activity for the identifier for the given aggregation.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" }, "minItems": 0, "type": "array" }, "dimension": { "additionalProperties": false, "description": "High level aggregated dimension details.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "aggregations", "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-activities-aggregate-geo.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report DNS activity totals", "tags": [ "DNS activity reports" ] }, "parameters": [ { "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/dns-activities-aggregate.yaml", "path-info": "/configs/{configId}/dns-activities/aggregate" } }, "/configs/{configId}/dns-activities/details": { "post": { "description": "Lists raw DNS events for a given time period. This operation Lists the first 500 configurable results.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-dns-activities-details" }, "operationId": "post-dns-activities-details", "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": { "endTimeSec": 1589965237, "filters": {}, "orderBy": "DESC", "pageNumber": 1, "pageSize": 5, "startTimeSec": 1587459637 }, "schema": { "additionalProperties": false, "description": "Request parameters for a detailed report of DNS events.", "properties": { "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter DNS events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "applicationId": { "additionalProperties": false, "description": "Filter by AVC application.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "queryType": { "additionalProperties": false, "description": "Filter report data by query type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by risk values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "scId": { "additionalProperties": false, "description": "Filter report data by security connector values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-dns-events.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec", "endTimeSec", "orderBy" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-events-details-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "alexaRanking": -1, "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "clientRequestId": "", "confidenceName": "Unknown", "deepScanned": false, "internalClientIP": "N/A", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "siteId": "-1", "siteName": "Unidentified IPs", "trigger": "null" }, "hitCount": 1, "id": "0", "query": { "clientIp": "192.0.2.239", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.166", "domain": "1590448430.akamaisiamalware.com.", "queryType": "A", "resolved": [ { "asn": "14618", "asname": "aws", "response": "192.0.2.40", "type": "A" } ], "time": "2020-05-26T06:00:00Z" } }, { "alexaRanking": 1000, "configId": "1041", "event": { "actionId": "6", "actionName": "Classify", "clientRequestId": "00019313", "confidenceName": "Unknown", "deepScanned": false, "internalClientIP": "N/A", "onRamp": "Yes", "onrampType": "etp-client", "policyEvaluationSource": "dns", "policyId": "38307", "policyName": "E2E-CML", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "trigger": "null" }, "hitCount": 1, "id": "1", "query": { "clientIp": "192.0.2.5", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "dnsIp": "192.0.2.148", "domain": "spocs.gsiaocket.com.", "queryType": "A", "resolved": [ { "asn": "14618", "asname": "aws", "response": "192.0.2.226", "type": "A" }, { "asn": "14618", "asname": "aws", "response": "192.0.2.141", "type": "A" }, { "asn": "14618", "asname": "aws", "response": "192.0.2.91", "type": "A" }, { "asn": "14618", "asname": "aws", "response": "192.0.2.205", "type": "A" } ], "time": "2020-05-26T06:00:00Z" } }, { "alexaRanking": 1000000, "configId": "1041", "event": { "actionId": "10", "actionName": "Bypass", "clientRequestId": "00019274", "confidenceName": "Unknown", "deepScanned": false, "internalClientIP": "N/A", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "32965", "policyName": "Westford OFF Network policy", "siteId": "5003", "siteName": "Off Network SIA Clients", "trigger": "null" }, "hitCount": 1, "id": "2", "query": { "clientIp": "192.0.2.33", "deviceId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad", "deviceName": "WIN81-ENT-210", "dnsIp": "192.0.2.83", "domain": "cme-linuscmewlhrwlhr-013-wlhr-public.wbx2.com.", "queryType": "A", "resolved": [ { "asn": "13445", "asname": "N/A", "response": "192.0.2.24", "type": "A" } ], "time": "2020-05-26T06:00:00Z" } }, { "alexaRanking": -1, "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "clientRequestId": "", "confidenceName": "Unknown", "deepScanned": false, "internalClientIP": "N/A", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "siteId": "-1", "siteName": "Unidentified IPs", "trigger": "null" }, "hitCount": 1, "id": "3", "query": { "clientIp": "192.0.2.177", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.16", "domain": "1590447770.akamaisiamalware.com.", "queryType": "A", "resolved": [ { "asn": "14618", "asname": "aws", "response": "192.0.2.145", "type": "A" } ], "time": "2020-05-26T06:00:00Z" } }, { "alexaRanking": 1000000, "configId": "1041", "event": { "actionId": "10", "actionName": "Bypass", "clientRequestId": "00032083", "confidenceName": "Unknown", "deepScanned": false, "internalClientIP": "N/A", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "38307", "policyName": "E2E-CML-", "siteId": "51277", "siteName": "E2E Mac 179.159 site", "trigger": "null" }, "hitCount": 1, "id": "4", "query": { "clientIp": "192.0.2.176", "deviceId": "630ace6b-4f26-41df-b411-cd652512cb04", "deviceName": "Lab-Mac-19818179159.local", "dnsIp": "192.0.2.53", "domain": "e6589.dscb.akamaiedge.net.", "queryType": "A", "resolved": [ { "asn": "20940", "asname": "qwest", "response": "192.0.2.220", "type": "A" } ], "time": "2020-05-26T06:00:00Z" } } ], "pageInfo": { "pageNumber": 1, "pageSize": 5, "totalRecords": 685134 } }, "schema": { "additionalProperties": true, "description": "DNS activity events for the given time period.", "properties": { "dataRows": { "description": "High-level DNS activity event details and a list of matching events.", "items": { "additionalProperties": false, "description": "High-level DNS activity event details and a list of matching events.", "properties": { "alexaRanking": { "description": "The Alexa ranking for the event. A value of -1 indicates no ranking data.", "minimum": -1, "type": "integer" }, "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "event": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "hitCount": { "description": "The total number of DNS hits.", "minimum": 0, "type": "integer" }, "id": { "description": "A unique identifier for the column object.", "minLength": 1, "type": "string" }, "query": { "additionalProperties": false, "description": "Requested DNS query information.", "properties": { "clientIp": { "description": "The requesting client's IP address.", "type": "string" }, "deviceId": { "description": "ID of the device.", "minLength": 1, "type": "string" }, "deviceName": { "description": "Name of device used.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier for the device owner.", "type": "string" }, "dnsIp": { "description": "The DNS resolver IP address.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "queryType": { "description": "The DNS query type, such as `A` or `CNAME`.", "minLength": 1, "type": "string" }, "resolved": { "description": "The details about the requested DNS query resolution.", "items": { "additionalProperties": false, "properties": { "asn": { "description": "Autonomous system number used for resolution.", "minLength": 1, "type": "string" }, "asname": { "description": "Autonomous system name used for resolution.", "minLength": 1, "type": "string" }, "response": { "description": "Resolved domain or IP address.", "minLength": 1, "type": "string" }, "type": { "description": "DNS resolution type. For example: `A` or `CNAME`.", "minLength": 1, "type": "string" } }, "required": [ "asn", "response", "type" ], "type": "object" }, "minItems": 0, "type": "array" }, "time": { "description": "Time of DNS request in ISO 8601 format.", "format": "date-time", "type": "string" }, "uuid": { "description": "UUID value.", "minLength": 1, "type": "string" } }, "required": [ "time", "clientIp", "dnsIp", "domain", "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/query.yaml" } } }, "required": [ "id", "configId", "hitCount", "alexaRanking", "query", "event" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-activity-details.yaml" } }, "minItems": 0, "type": "array" }, "pageInfo": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } } }, "required": [ "dataRows" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-events-details-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report DNS activity event details", "tags": [ "DNS activity reports" ] }, "parameters": [ { "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/dns-activities-details.yaml", "path-info": "/configs/{configId}/dns-activities/details" } }, "/configs/{configId}/dns-activities/time-series": { "get": { "description": "Lists the count of DNS activities, aggregated by hour.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-dns-activities-time-series" }, "operationId": "get-dns-activities-time-series", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "site", "clientIP", "policy", "action", "applicationId", "asName", "category", "clientRequestId", "deviceId", "deviceOwnerId", "dohAttribution", "encryptedInternalClientIP", "encryptedInternalClientName", "onrampType", "queryType", "destinationIP", "riskId", "scId", "sublocationId", "transportType" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-dns-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter DNS events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "applicationId": { "additionalProperties": false, "description": "Filter by AVC application.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "queryType": { "additionalProperties": false, "description": "Filter report data by query type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by risk values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "scId": { "additionalProperties": false, "description": "Filter report data by security connector values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-dns-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-dns-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "timestamp" }, { "id": "US", "name": "United States" }, { "id": "JP", "name": "Japan" }, { "id": "IN", "name": "India" }, { "id": "OTHERS", "name": "Other sites" } ], "rows": [ [ "2016-05-03T18:24:17Z", 8, 231, 235, 588 ], [ "2016-05-03T18:53:05Z", 946, 134, 62, 86 ], [ "2016-05-03T19:21:53Z", 888, 985, 36, 851 ], [ "2016-05-03T19:50:41Z", 398, 847, 934, 131 ], [ "2016-05-03T20:19:29Z", 794, 691, 18, 444 ], [ "2016-05-03T20:48:17Z", 25, 109, 428, 359 ], [ "2016-05-03T21:17:05Z", 300, 202, 266, 473 ], [ "2016-05-03T21:45:53Z", 395, 501, 955, 783 ], [ "2016-05-03T22:14:41Z", 715, 7, 619, 227 ], [ "2016-05-03T22:43:29Z", 671, 490, 525, 140 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report DNS activity time series", "tags": [ "DNS activity reports" ] }, "parameters": [ { "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/dns-activities-time-series.yaml", "path-info": "/configs/{configId}/dns-activities/time-series" } }, "/configs/{configId}/feedbacks/details": { "post": { "description": "Reports the threat for a domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-feedback-details" }, "operationId": "post-feedback-details", "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": { "customerEmailId": "bjones@tech-corp.com", "dimension": "domain", "dimensionValue": "Ouk.net", "feedbackDesc": "Akamai internal application.", "feedbackType": "fnf" }, "schema": { "additionalProperties": false, "description": "Feedback details for a reported threat.", "properties": { "accountName": { "description": "Name of the account with feedback.", "type": "string" }, "ackMailSentTime": { "description": "__Read-only__ ISO 8601 timestamp marking receipt of email acknowledgment.", "format": "date-time", "readOnly": true, "type": "string" }, "avcInfo": { "additionalProperties": false, "description": "Details of AVC info related to IOC.", "properties": { "appDescription": { "description": "Description of the AVC app.", "minLength": 1, "type": "string" }, "appId": { "description": "Unique identifier for the application's AVC category.", "minLength": 1, "type": "string" }, "appName": { "description": "The AVC app name.", "minLength": 1, "type": "string" }, "categoryDescription": { "description": "The category description.", "minLength": 1, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "The category name.", "minLength": 1, "type": "string" }, "deprecated": { "description": "Deprecates the AVC app.", "type": "boolean" }, "operationIds": { "description": "List of operation IDs.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "operations": { "description": "List of operations for the IOC AVC event.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for AVC operation.", "minLength": 0, "type": "string" }, "name": { "description": "Name of the AVC operation.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "proxy": { "description": "Enables the proxy.", "type": "boolean" }, "riskDescription": { "description": "The risk category description.", "minLength": 1, "type": "string" }, "riskId": { "description": "A unique identifier for the risk category.", "minLength": 1, "type": "string" }, "riskName": { "description": "The risk category name.", "minLength": 1, "type": "string" }, "uri": { "description": "URI for the AVC category.", "minLength": 1, "type": "string" } }, "required": [ "uri", "appId", "appName", "appDescription", "categoryId", "categoryName", "categoryDescription", "riskId", "riskName", "riskDescription", "proxy", "operations", "operationIds" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-avc-info.yaml" } }, "currentCategory": { "description": "The threat security category. Either `Malware`, `Phishing`, `C&C`, `DNS Exfiltration`, `Risky domains`, or `File sharing`.", "enum": [ "Malware", "Phishing", "C&C", "Risky domains", "File sharing" ], "minLength": 1, "type": "string" }, "customerEmailId": { "description": "__Read-only__ The email address of the contract's customer.", "readOnly": true, "type": "string" }, "dimension": { "description": "The dimension to assign to the threat.", "minLength": 1, "type": "string" }, "dimensionValue": { "description": "The dimension value.", "minLength": 1, "type": "string" }, "feedbackDesc": { "description": "A description of the feedback.", "minLength": 1, "type": "string" }, "feedbackType": { "description": "The type of feedback threat.", "minLength": 1, "type": "string" }, "portalUrl": { "description": "The feedback URL.", "type": "string" }, "reportedTime": { "description": "__Read-only__ ISO 8601 timestamp marking the feedback report.", "format": "date-time", "readOnly": true, "type": "string" }, "submittedBy": { "description": "The name of the user who submitted the feedback.", "minLength": 1, "type": "string" }, "threatOpsNotifiedTime": { "description": "__Read-only__ ISO 8601 timestamp marking when Akamai Ops received notification about the threat.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "dimensionValue", "customerEmailId", "feedbackDesc" ], "type": "object", "x-akamai": { "file-path": "schemas/feedback-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report a threat", "tags": [ "Feedback reports" ] }, "get": { "description": "Returns feedback information about a domain based on the feedback type.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-feedbacks-details" }, "operationId": "get-feedbacks-details", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "CATEGORY", "COUNTRY", "ASNAME", "ASN", "CLIENTPORT", "CLIENTIP", "DESTINATIONPORT", "DESTINATIONIP", "SITE", "DOMAIN", "ACTION", "HTTPREQUESTMETHOD" ], "example": "CATEGORY", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-query.yaml" } }, { "description": "The specified dimension value. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimensionValue", "required": true, "schema": { "example": "0uk.net", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-value-query.yaml" } }, { "description": "The type of feedback to query.", "in": "query", "name": "feedbackType", "required": true, "schema": { "example": "not_categorized", "type": "string" }, "x-akamai": { "file-path": "parameters/feedback-type-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "ackMailSentTime": "2020-05-20T14:02:32Z", "currentCategory": "C&C", "customerEmailId": "lgumpina@akamai.com", "dimensionValue": "0uk.net.", "feedbackDesc": "this is a bad domain", "reportedTime": "2020-05-20T14:02:31Z", "submittedBy": "afero", "threatOpsNotifiedTime": "2020-05-20T14:02:32Z" } ], "schema": { "description": "Feedback details for a reported threat.", "items": { "additionalProperties": false, "properties": { "accountName": { "description": "Name of the account with feedback.", "type": "string" }, "ackMailSentTime": { "description": "__Read-only__ ISO 8601 timestamp marking receipt of email acknowledgment.", "format": "date-time", "readOnly": true, "type": "string" }, "avcInfo": { "additionalProperties": false, "description": "Details of AVC info related to IOC.", "properties": { "appDescription": { "description": "Description of the AVC app.", "minLength": 1, "type": "string" }, "appId": { "description": "Unique identifier for the application's AVC category.", "minLength": 1, "type": "string" }, "appName": { "description": "The AVC app name.", "minLength": 1, "type": "string" }, "categoryDescription": { "description": "The category description.", "minLength": 1, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "The category name.", "minLength": 1, "type": "string" }, "deprecated": { "description": "Deprecates the AVC app.", "type": "boolean" }, "operationIds": { "description": "List of operation IDs.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "operations": { "description": "List of operations for the IOC AVC event.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for AVC operation.", "minLength": 0, "type": "string" }, "name": { "description": "Name of the AVC operation.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "proxy": { "description": "Enables the proxy.", "type": "boolean" }, "riskDescription": { "description": "The risk category description.", "minLength": 1, "type": "string" }, "riskId": { "description": "A unique identifier for the risk category.", "minLength": 1, "type": "string" }, "riskName": { "description": "The risk category name.", "minLength": 1, "type": "string" }, "uri": { "description": "URI for the AVC category.", "minLength": 1, "type": "string" } }, "required": [ "uri", "appId", "appName", "appDescription", "categoryId", "categoryName", "categoryDescription", "riskId", "riskName", "riskDescription", "proxy", "operations", "operationIds" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-avc-info.yaml" } }, "currentCategory": { "description": "The threat security category. Either `Malware`, `Phishing`, `C&C`, `DNS Exfiltration`, `Risky domains`, or `File sharing`.", "enum": [ "Malware", "Phishing", "C&C", "Risky domains", "File sharing" ], "minLength": 1, "type": "string" }, "customerEmailId": { "description": "__Read-only__ The email address of the contract's customer.", "readOnly": true, "type": "string" }, "dimension": { "description": "The dimension to assign to the threat.", "minLength": 1, "type": "string" }, "dimensionValue": { "description": "The dimension value.", "minLength": 1, "type": "string" }, "feedbackDesc": { "description": "A description of the feedback.", "minLength": 1, "type": "string" }, "feedbackType": { "description": "The type of feedback threat.", "minLength": 1, "type": "string" }, "portalUrl": { "description": "The feedback URL.", "type": "string" }, "reportedTime": { "description": "__Read-only__ ISO 8601 timestamp marking the feedback report.", "format": "date-time", "readOnly": true, "type": "string" }, "submittedBy": { "description": "The name of the user who submitted the feedback.", "minLength": 1, "type": "string" }, "threatOpsNotifiedTime": { "description": "__Read-only__ ISO 8601 timestamp marking when Akamai Ops received notification about the threat.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "dimensionValue", "customerEmailId", "feedbackDesc" ], "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/feedback-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Get feedback event detail report", "tags": [ "Feedback reports" ] }, "parameters": [ { "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/feedbacks-details.yaml", "path-info": "/configs/{configId}/feedbacks/details" } }, "/configs/{configId}/ioc/time-series": { "get": { "description": "Lists the DNS activities of a configuration for a given domain or IP, aggregated by day. Omit `startTimeSec` and `endTimeSec` from the request URL to return all available historical information.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-time-series" }, "operationId": "get-time-series", "parameters": [ { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "TIMESTAMP" }, { "id": "TOTAL", "name": "TOTAL" } ], "rows": [ [ "2017-02-23T00:00:00Z", 0 ], [ "2017-02-24T00:00:00Z", 0 ], [ "2017-02-25T00:00:00Z", 0 ], [ "2017-02-26T00:00:00Z", 0 ], [ "2017-02-27T00:00:00Z", 0 ], [ "2017-02-28T00:00:00Z", 0 ], [ "2017-03-01T00:00:00Z", 0 ], [ "2017-03-02T00:00:00Z", 0 ], [ "2017-03-03T00:00:00Z", 0 ], [ "2017-03-04T00:00:00Z", 0 ], [ "2017-03-05T00:00:00Z", 0 ], [ "2017-03-06T00:00:00Z", 0 ], [ "2017-03-07T00:00:00Z", 0 ], [ "2017-03-08T00:00:00Z", 0 ], [ "2017-03-09T00:00:00Z", 0 ], [ "2017-03-10T00:00:00Z", 0 ], [ "2017-03-11T00:00:00Z", 0 ], [ "2017-03-12T00:00:00Z", 0 ], [ "2017-03-13T00:00:00Z", 0 ], [ "2017-03-14T00:00:00Z", 0 ], [ "2017-03-15T00:00:00Z", 0 ], [ "2017-03-16T00:00:00Z", 2 ], [ "2017-03-17T00:00:00Z", 0 ], [ "2017-03-18T00:00:00Z", 0 ], [ "2017-03-19T00:00:00Z", 0 ], [ "2017-03-20T00:00:00Z", 0 ], [ "2017-03-21T00:00:00Z", 0 ], [ "2017-03-22T00:00:00Z", 0 ], [ "2017-03-23T00:00:00Z", 0 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Get IOC time series report", "tags": [ "IOC reports" ] }, "parameters": [ { "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/ioc-time-series.yaml", "path-info": "/configs/{configId}/ioc/time-series" } }, "/configs/{configId}/network-traffic/connections/aggregate": { "get": { "description": "Lists the count of network traffic connections totals, grouped by query parameters.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-network-traffic-connections" }, "operationId": "get-network-traffic-connections", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "destinationPort", "droppedReason", "site", "country", "domain", "asName", "clientRequestId", "destinationIP", "encryptedInternalClientIP", "encryptedInternalClientName", "ovfActionId", "onrampType", "action", "sublocationId", "clientIP", "clientPort" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-nt-traffic-query.yaml" } }, { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter NT traffic report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientPort": { "additionalProperties": false, "description": "Filter report data by client port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "country": { "additionalProperties": false, "description": "Filter report data by geographical regions.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "droppedReason": { "additionalProperties": false, "description": "Filter report data by dropped reason.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "ovfActionId": { "additionalProperties": false, "description": "Filter report data by invalid certificate action IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-nt-traffic.yaml" } }, "x-akamai": { "file-path": "parameters/filters-nt-traffic-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregations": [ { "id": "Request is not compliant with HTTP protocol", "name": "Request is not compliant with HTTP protocol", "total": 324 }, { "id": "Client is using deprecated SSL protocol", "name": "Client is using deprecated SSL protocol", "total": 314 }, { "id": "Client is using deprecated SSL cipher", "name": "Client is using deprecated SSL cipher", "total": 303 }, { "id": "Origin TLS certificate is Invalid", "name": "Origin TLS certificate is Invalid", "total": 203 }, { "id": "Origin SSL Handshake failed", "name": "Origin SSL Handshake failed", "total": 203 }, { "id": "Origin connection failure", "name": "Origin connection failure", "total": 5027 }, { "id": "Client connection failure", "name": "Client connection failure", "total": 40532 }, { "id": "DNS resolution failed - Invalid domain name", "name": "DNS resolution failed - Invalid domain name", "total": 2433 }, { "id": "DNS resolved - No Address returned", "name": "DNS resolved - No Address returned", "total": 4213 } ], "dimension": { "id": "droppedReason", "name": "droppedReasonname", "total": 9 } }, "schema": { "additionalProperties": false, "description": "Aggregated network traffic connection event details and a list of matching events.", "properties": { "aggregations": { "description": "Aggregated list of events or traffic for the given time period.", "items": { "additionalProperties": false, "description": "An aggregated list of events or traffic for the given time period.", "properties": { "id": { "description": "A unique identifier for the column object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the column identifier.", "minLength": 0, "type": "string" }, "total": { "description": "The total count of security events for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "id", "total" ], "type": "object", "x-akamai": { "file-path": "schemas/total.yaml" } }, "minItems": 0, "type": "array" }, "dimension": { "additionalProperties": false, "description": "Aggregation is done base on this dimension.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/network-traffic-connections-aggregate.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report network traffic connections totals", "tags": [ "Network traffic connections" ] }, "parameters": [ { "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/network-traffic-aggregate.yaml", "path-info": "/configs/{configId}/network-traffic/connections/aggregate" } }, "/configs/{configId}/network-traffic/connections/details": { "post": { "description": "Lists network traffic connections for a given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-network-traffic-connections-details" }, "operationId": "post-network-traffic-connections-details", "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": { "endTimeSec": 1589965237, "filters": {}, "orderBy": "DESC", "pageNumber": 1, "pageSize": 5, "startTimeSec": 1587459637 }, "schema": { "additionalProperties": false, "description": "Request parameters for a detailed report of events.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter NT traffic report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientPort": { "additionalProperties": false, "description": "Filter report data by client port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "country": { "additionalProperties": false, "description": "Filter report data by geographical regions.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "droppedReason": { "additionalProperties": false, "description": "Filter report data by dropped reason.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "ovfActionId": { "additionalProperties": false, "description": "Filter report data by invalid certificate action IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-nt-traffic.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec", "endTimeSec" ], "type": "object", "x-akamai": { "file-path": "schemas/network-traffic-events-details-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "clientIP": "192.0.2.4", "clientPort": 37565, "clientRequestId": "4655ba63-0adb-4ce5-a5a9-ae0fd616ef36-15904748887626277-3075", "connEndTime": "2020-05-26T06:34:48Z", "connStartTime": "2020-05-26T06:34:48Z", "connectionId": "0x3706B3154FB0D3711164C", "destinationIP": "192.0.2.36", "destinationPort": 80, "domain": "nevada-stage.akasia.net.", "dropInfo": { "droppedReason": "N/A", "wasDropped": false }, "httpUserAgent": "EtpClient:3.0.0", "httpVersion": "1.1", "id": "0", "internalClientIP": "192.0.2.150", "machineId": "4655ba63-0adb-4ce5-a5a9-ae0fd616ef36", "machineName": "DESKTOP-5FL9GBR", "onrampType": "etp_offnet_client", "ovfActionId": -1, "ovfActionName": "N/A", "policyAction": "onramp", "siteId": 5003, "siteName": "Off Network SIA Clients", "stats": { "httpRequestCount": 1, "inBytes": 0, "outBytes": 0 } }, { "clientIP": "192.0.2.181", "clientPort": 34908, "clientRequestId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad-15904748107656327-1199", "connEndTime": "2020-05-26T06:34:47Z", "connStartTime": "2020-05-26T06:34:47Z", "connectionId": "0x3706B3144FB0D23C9E88", "destinationIP": "192.0.2.103", "destinationPort": 80, "domain": "nevada-stage.akasia.net.", "dropInfo": { "droppedReason": "N/A", "wasDropped": false }, "httpUserAgent": "EtpClient:3.0.0", "httpVersion": "1.1", "id": "1", "internalClientIP": "192.0.2.58", "machineId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad", "machineName": "WIN81-ENT-210", "onrampType": "etp_offnet_client", "ovfActionId": -1, "ovfActionName": "N/A", "policyAction": "onramp", "siteId": 5003, "siteName": "Off Network SIA Clients", "stats": { "httpRequestCount": 1, "inBytes": 0, "outBytes": 0 } }, { "clientIP": "192.0.2.8", "clientPort": 33395, "clientRequestId": "630ace6b-4f26-41df-b411-cd652512cb04-15904748508376060-2350", "connEndTime": "2020-05-26T06:34:34Z", "connStartTime": "2020-05-26T06:34:34Z", "connectionId": "0x3706B3154FB09DED1164B", "destinationIP": "192.0.2.208", "destinationPort": 80, "domain": "nevada-stage.akasia.net.", "dropInfo": { "droppedReason": "N/A", "wasDropped": false }, "httpUserAgent": "siaClient (unknown version) CFNetwork/1121.1.2 Darwin/19.3.0 (x86_64) EtpClient:3.0.0", "httpVersion": "1.1", "id": "2", "internalClientIP": "192.0.2.145", "machineId": "630ace6b-4f26-41df-b411-cd652512cb04", "machineName": "Lab-Mac-19818179159.local", "onrampType": "etp_client", "ovfActionId": -1, "ovfActionName": "N/A", "policyAction": "onramp", "siteId": 51277, "siteName": "E2E Mac 179.159 site", "stats": { "httpRequestCount": 1, "inBytes": 0, "outBytes": 0 } }, { "clientIP": "192.0.2.25", "clientPort": 43337, "clientRequestId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad-15904747907591129-1198", "connEndTime": "2020-05-26T06:34:27Z", "connStartTime": "2020-05-26T06:34:27Z", "connectionId": "0x3706B3144FB084179E86", "destinationIP": "192.0.2.251", "destinationPort": 80, "domain": "nevada-stage.akasia.net.", "dropInfo": { "droppedReason": "N/A", "wasDropped": false }, "httpUserAgent": "EtpClient:3.0.0", "httpVersion": "1.1", "id": "3", "internalClientIP": "192.0.2.218", "machineId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad", "machineName": "WIN81-ENT-210", "onrampType": "etp_offnet_client", "ovfActionId": -1, "ovfActionName": "N/A", "policyAction": "onramp", "siteId": 5003, "siteName": "Off Network SIA Clients", "stats": { "httpRequestCount": 1, "inBytes": 0, "outBytes": 0 } }, { "clientIP": "192.0.2.182", "clientPort": 43231, "clientRequestId": "60978b6d-3b85-4366-920b-ed00935e0706-15904748554127546-6037", "connEndTime": "2020-05-26T06:34:14Z", "connStartTime": "2020-05-26T06:34:14Z", "connectionId": "0x3706B3174FB05214C6A4", "destinationIP": "192.0.2.166", "destinationPort": 80, "domain": "nevada-stage.akasia.net.", "dropInfo": { "droppedReason": "N/A", "wasDropped": false }, "httpUserAgent": "EtpClient:3.0.0", "httpVersion": "1.1", "id": "4", "internalClientIP": "192.0.2.29", "machineId": "60978b6d-3b85-4366-920b-ed00935e0706", "machineName": "DESKTOP-5FL9GBR", "onrampType": "etp_offnet_client", "ovfActionId": -1, "ovfActionName": "N/A", "policyAction": "onramp", "siteId": 5003, "siteName": "Off Network SIA Clients", "stats": { "httpRequestCount": 1, "inBytes": 0, "outBytes": 0 } } ], "pageInfo": { "pageNumber": 1, "pageSize": 5, "totalRecords": 164614 } }, "schema": { "additionalProperties": false, "description": "Detailed list of network traffic events for the given time period.", "properties": { "dataRows": { "description": "Network traffic connection event details and a list of matching events.", "items": { "additionalProperties": false, "description": "Network traffic connection event details and a list of matching events.", "properties": { "clientIP": { "description": "The requesting client's IP address.", "type": "string" }, "clientPort": { "description": "The requesting client's Port.", "minimum": 0, "type": "integer" }, "clientRequestId": { "description": "ID representing the client request.", "minLength": 0, "type": "string" }, "connEndTime": { "description": "Connection end time in ISO 8601 format.", "type": "string" }, "connStartTime": { "description": "Connection start time in ISO 8601 format.", "type": "string" }, "connectionId": { "description": "Unique ID of the network connections.", "minLength": 1, "type": "string" }, "decryptedInternalClientIP": { "description": "The decrypted form of client IP.", "type": "string" }, "destinationIP": { "description": "The destination IP address.", "type": "string" }, "destinationPort": { "description": "Destination / origin port.", "minimum": 0, "type": "integer" }, "deviceOwnerId": { "description": "Unique identifier of the device owner.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "dropInfo": { "additionalProperties": false, "description": "Dropped information about the network connection.", "properties": { "droppedReason": { "description": "Dropped reason of that network connection.", "minLength": 1, "type": "string" }, "wasDropped": { "description": "Was the network connection dropped.", "type": "boolean" } }, "required": [ "wasDropped", "droppedReason" ], "type": "object" }, "encryptedInternalClientIp": { "description": "The IP address of the client machine in encrypted form.", "type": "string" }, "encryptedInternalClientName": { "description": "A descriptive name of the client machine in encrypted form.", "minLength": 1, "type": "string" }, "httpUserAgent": { "description": "User agent specified over HTTP.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "HTTP protocol version used.", "minLength": 1, "type": "string" }, "id": { "description": "Unique ID of the network connections event.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "IP address of the internal client machine.", "type": "string" }, "machineId": { "description": "Unique ID for the machine.", "minLength": 1, "type": "string" }, "machineName": { "description": "Name of the machine used.", "minLength": 1, "type": "string" }, "onrampType": { "description": "Onramp type used. Either `dns`, `etp_client`, `etp_offnet_client`, `explicit_proxy_http`, `explicit_proxy_tls`, `http_forwarder`, `ipsec_tunnel`, `N/A`, `onramp_dns`, or `tpaas`.", "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "minLength": 0, "type": "string" }, "ovfActionId": { "description": "ID of the Open Virtualization Format (OVF) action exercised.", "minimum": -1, "type": "integer" }, "ovfActionName": { "description": "Name of the OVF action exercised.", "minLength": 1, "type": "string" }, "policyAction": { "description": "Policy action exercised.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site from where the connection established.", "minimum": 1, "type": "integer" }, "siteName": { "description": "Site name from where the connection established.", "minLength": 1, "type": "string" }, "stats": { "additionalProperties": false, "description": "Statistics about the network connection.", "properties": { "httpRequestCount": { "description": "Total HTTP request count of that network connection.", "minimum": 0, "type": "integer" }, "inBytes": { "description": "Total incoming bytes of that network connection.", "minimum": 0, "type": "integer" }, "outBytes": { "description": "Total outgoing bytes of that network connection.", "minimum": 0, "type": "integer" } }, "required": [ "httpRequestCount", "inBytes", "outBytes" ], "type": "object" }, "sublocationId": { "description": "A unique identifier for the sublocation from where the connection established.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name from where the connection established.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyAction", "onrampType", "httpVersion", "httpUserAgent", "machineName", "clientRequestId", "dropInfo", "ovfActionName", "id", "connectionId", "domain", "connStartTime", "connEndTime" ], "type": "object", "x-akamai": { "file-path": "schemas/network-traffic-connections-details.yaml" } }, "minItems": 0, "type": "array" }, "pageInfo": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } } }, "required": [ "dataRows" ], "type": "object", "x-akamai": { "file-path": "schemas/network-traffic-events-details-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report network traffic connections details", "tags": [ "Network traffic connections" ] }, "parameters": [ { "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/network-traffic-details.yaml", "path-info": "/configs/{configId}/network-traffic/connections/details" } }, "/configs/{configId}/network-traffic/connections/time-series": { "get": { "description": "Lists network traffic connections totals, aggregated by hour.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-connections-time-series" }, "operationId": "get-connections-time-series", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "destinationPort", "droppedReason", "site", "country", "domain", "asName", "clientRequestId", "destinationIP", "encryptedInternalClientIP", "encryptedInternalClientName", "ovfActionId", "onrampType", "action", "sublocationId", "clientIP", "clientPort" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-nt-traffic-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter NT traffic report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientPort": { "additionalProperties": false, "description": "Filter report data by client port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "country": { "additionalProperties": false, "description": "Filter report data by geographical regions.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "droppedReason": { "additionalProperties": false, "description": "Filter report data by dropped reason.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "ovfActionId": { "additionalProperties": false, "description": "Filter report data by invalid certificate action IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-nt-traffic.yaml" } }, "x-akamai": { "file-path": "parameters/filters-nt-traffic-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "TIMESTAMP" }, { "id": "Unsupported Protocol", "name": "Unsupported Protocol" }, { "id": "Weak Cipher Suites", "name": "Weak Cipher Suites" }, { "id": "Weak SSL Protocol", "name": "Weak SSL Protocol" }, { "id": "Origin Validation Failure", "name": "Origin Validation Failure" }, { "id": "OTHERS", "name": "OTHERS" } ], "rows": [ [ "2018-02-28T18:00:00Z", 100, 0, 0, 50, 0 ], [ "2018-02-28T20:00:00Z", 250, 0, 0, 40, 0 ], [ "2018-02-28T22:00:00Z", 60, 0, 0, 10, 0 ], [ "2018-03-01T00:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T02:00:00Z", 10, 0, 0, 4, 1 ], [ "2018-03-01T04:00:00Z", 0, 2, 0, 0, 0 ], [ "2018-03-01T06:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T08:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T10:00:00Z", 0, 0, 40, 50, 60 ], [ "2018-03-01T12:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T14:00:00Z", 104, 0, 0, 0, 0 ], [ "2018-03-01T16:00:00Z", 300, 0, 0, 2, 0 ], [ "2018-03-01T18:00:00Z", 5398, 0, 0, 0, 0 ], [ "2018-03-01T20:00:00Z", 0, 0, 0, 0, 0 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report network traffic connections time series", "tags": [ "Network traffic connections" ] }, "parameters": [ { "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/network-traffic-time-series.yaml", "path-info": "/configs/{configId}/network-traffic/connections/time-series" } }, "/configs/{configId}/proxy-traffic/transactions/aggregate": { "get": { "description": "Lists the count of proxy traffic transaction totals, grouped by the chosen query aggregation..", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-proxy-traffic-transactions" }, "operationId": "get-proxy-traffic-transactions", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "site", "policy", "destinationIP", "encryptedInternalClientIP", "encryptedUserName", "action", "applicationId", "asName", "clientPort", "clientRequestId", "destinationIp", "destinationPort", "deviceId", "deviceOwnerId", "devicePostureRisk", "dlpDictionaryId", "dlpFileHash", "fileType", "country", "group", "httpRequestMethod", "encryptedInternalClientName", "matchedGroups", "onrampType", "operationId", "dlpPatternId", "reason", "responseCode", "riskId", "clientIp", "sublocationId", "encryptedUserId" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-proxy-traffic-query.yaml" } }, { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter Http traffic events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "applicationId": { "additionalProperties": false, "description": "Filter by AVC application.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientPort": { "additionalProperties": false, "description": "Filter by Client port number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "country": { "additionalProperties": false, "description": "Filter report data by geographical regions.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserId": { "additionalProperties": false, "description": "Filter report data by userId, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "group": { "additionalProperties": false, "description": "Filter report data by user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isEvent": { "additionalProperties": false, "description": "Filter report data if its part of the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "matchedGroups": { "additionalProperties": false, "description": "Filter report data by matched user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "operationId": { "additionalProperties": false, "description": "Filter data based on operation.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "responseCode": { "additionalProperties": false, "description": "Filter report data by response code.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by risk values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-proxy-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-proxy-traffic-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregations": [ { "id": "GET", "name": "GET", "total": 3303 }, { "id": "POST", "name": "POST", "total": 101 } ], "dimension": { "id": "httpRequestMethod", "name": "httpRequestMethod", "total": 2 } }, "schema": { "additionalProperties": false, "description": "Proxy traffic transaction event details and a list of matching events.", "properties": { "aggregations": { "description": "An aggregated list of events or traffic for the given time period.", "items": { "additionalProperties": false, "description": "An aggregated list of events or traffic for the given time period.", "properties": { "id": { "description": "A unique identifier for the column object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the column identifier.", "minLength": 0, "type": "string" }, "total": { "description": "The total count of security events for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "id", "total" ], "type": "object", "x-akamai": { "file-path": "schemas/total.yaml" } }, "minItems": 0, "type": "array" }, "dimension": { "additionalProperties": false, "description": "The dimension value to aggregate by.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "aggregations", "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-traffic-transactions-aggregate.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report proxy traffic transactions totals", "tags": [ "Proxy traffic transactions" ] }, "parameters": [ { "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/proxy-traffic-aggregate.yaml", "path-info": "/configs/{configId}/proxy-traffic/transactions/aggregate" } }, "/configs/{configId}/proxy-traffic/transactions/details": { "post": { "description": "Lists proxy network traffic connections for a given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-traffic-transaction-details" }, "operationId": "post-traffic-transaction-details", "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": { "endTimeSec": 1589965237, "filters": {}, "orderBy": "DESC", "pageNumber": 1, "pageSize": 5, "startTimeSec": 1587459637 }, "schema": { "additionalProperties": false, "description": "Request parameters for a detailed report of events.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter Http traffic events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "applicationId": { "additionalProperties": false, "description": "Filter by AVC application.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientPort": { "additionalProperties": false, "description": "Filter by Client port number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "country": { "additionalProperties": false, "description": "Filter report data by geographical regions.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserId": { "additionalProperties": false, "description": "Filter report data by userId, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "group": { "additionalProperties": false, "description": "Filter report data by user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isEvent": { "additionalProperties": false, "description": "Filter report data if its part of the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "matchedGroups": { "additionalProperties": false, "description": "Filter report data by matched user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "operationId": { "additionalProperties": false, "description": "Filter data based on operation.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "responseCode": { "additionalProperties": false, "description": "Filter report data by response code.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by risk values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-proxy-events.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-transaction-events-details-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "event": { "actionId": "4", "actionName": "Block - Error Page", "blockDescription": "The URL hosts malware.", "categoryId": "73", "categoryName": "73", "clientRequestId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad-15904747363383674-1195", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacncstage.com", "internalIP": "192.0.2.235", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.89", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "deepScanned": false, "deepscanReportPath": "", "detectionTime": "2020-05-26T06:33:33Z", "detectionType": "inline", "deviceId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad", "deviceName": "WIN81-ENT-210", "httpUserAgent": "Windows-Update-Agent/7.9.9600.19670 Client-Protocol/1.21 EtpClient:3.0.0", "httpVersion": "1.1", "internalClientIP": "192.0.2.7", "listId": "-1", "listIdentifiers": [ { "categoryId": 73, "categoryName": "73", "confidenceId": 0, "confidenceName": "Unknown", "listId": -1, "listName": "unknown", "threatId": 0, "threatName": "Unclassified" } ], "listName": "unknown", "matchedGroups": [], "onrampType": "etp_offnet_client", "policyId": "32965", "policyName": "Westford OFF Network policy", "reason": "Acceptable use policy", "severityId": 0, "severityLevel": "Unclassified", "siteId": "5003", "siteName": "Off Network SIA Clients", "trigger": "null" }, "id": "0", "isEvent": true, "l7Protocol": "HTTP", "request": { "clientIp": "192.0.2.168", "clientPort": 48176, "connectionId": "0x3706B3124FAFAF8C9574", "destinationIP": "192.0.2.122", "destinationPort": 80, "domain": "statsfe2.ws.microsoft.com.", "headers": [ { "name": "Cache-Control", "value": "no-cache" }, { "name": "Content-Length", "value": "2369" }, { "name": "Content-Type", "value": "text/xml; charset=utf-8" }, { "name": "Host", "value": "statsfe2.ws.microsoft.com" }, { "name": "Pragma", "value": "no-cache" }, { "name": "User-Agent", "value": "Windows-Update-Agent/7.9.9600.19670 Client-Protocol/1.21 EtpClient:3.0.0" }, { "name": "X-Forwarded-For", "value": "172.25.162.210, 172.25.162.210" } ], "method": "POST", "queryStrings": [], "startTime": 1590474813791, "uri": "/ReportingWebService/ReportingWebService.asmx", "uuid": "1b72e77c-254a-4ba9-a456-2a1b4407d65b" }, "response": { "endTime": 1590474813793, "hash": "", "headers": [] }, "userIdentity": { "encryptedUserID": "", "encryptedUserName": "", "groups": [] } }, { "event": { "actionId": "5", "actionName": "Allow", "blockDescription": "The URL hosts malware.", "categoryId": "104", "categoryName": "104", "clientRequestId": "c37a4c4e-a7cd-400f-820d-b82762c52975-15904747127323964-48715", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacncstage.com", "internalIP": "192.0.2.190", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.173", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "deepScanned": false, "deepscanReportPath": "", "detectionTime": "2020-05-26T06:32:30Z", "detectionType": "N/A", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "httpUserAgent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Teams/1.3.00.12058 Chrome/69.0.3497.128 Electron/4.2.12 Safari/537.36 EtpClient:3.0.0", "httpVersion": "1.1", "internalClientIP": "192.0.2.25", "listId": "-1", "listIdentifiers": [ { "categoryId": 104, "categoryName": "104", "confidenceId": 0, "confidenceName": "Unknown", "listId": -1, "listName": "unknown", "threatId": 0, "threatName": "Unclassified" } ], "listName": "unknown", "matchedGroups": [], "onrampType": "etp_client", "policyId": "0", "policyName": "0", "reason": "Acceptable use policy", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "trigger": "null" }, "id": "1", "isEvent": false, "l7Protocol": "HTTPS", "request": { "clientIp": "192.0.2.45", "clientPort": 34656, "connectionId": "0x3706B30F4FAEB4B27FB1", "destinationIP": "2001:db8:5ad7:b1f8:6411:d14f:971c:7bfe", "destinationPort": 443, "domain": "statics.teams.cdn.office.net.", "headers": [ { "name": "Accept", "value": "image/webp,image/apng,image/*,*/*;q=0.8" }, { "name": "Accept-Encoding", "value": "gzip, deflate, br" }, { "name": "Accept-Language", "value": "en-US" }, { "name": "Connection", "value": "keep-alive" }, { "name": "Host", "value": "statics.teams.cdn.office.net" }, { "name": "Referer", "value": "https://teams.microsoft.com/_" }, { "name": "User-Agent", "value": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Teams/1.3.00.12058 Chrome/69.0.3497.128 Electron/4.2.12 Safari/537.36" } ], "method": "GET", "queryStrings": [ { "name": "cb", "value": "1590474712726" } ], "startTime": 1590474750161, "uri": "/evergreen-assets/icons/1x1-000000ff.png", "uuid": "38c91e98-37fc-40f0-876e-ba60104b4d35" }, "response": { "endTime": 1590474750226, "hash": "", "headers": [ { "name": "Access-Control-Allow-Origin", "value": "*" }, { "name": "Cache-Control", "value": "public, max-age=604777" }, { "name": "Connection", "value": "keep-alive" }, { "name": "Content-Length", "value": "68" }, { "name": "Content-MD5", "value": "5E5+z+yZNWYywTzT6qPiUA==" }, { "name": "Content-Type", "value": "image/png" }, { "name": "Date", "value": "Tue, 26 May 2020 06:32:30 GMT" }, { "name": "ETag", "value": "\"0x8D6D3F4152295F5\"" }, { "name": "Last-Modified", "value": "Wed, 08 May 2019 20:30:59 GMT" }, { "name": "Server", "value": "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0" } ] }, "userIdentity": { "encryptedUserID": "", "encryptedUserName": "", "groups": [] } }, { "event": { "actionId": "5", "actionName": "Allow", "blockDescription": "The URL hosts malware.", "categoryId": "55", "categoryName": "Streaming Websites", "clientRequestId": "c37a4c4e-a7cd-400f-820d-b82762c52975-15904746798952196-48708", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacncstage.com", "internalIP": "192.0.2.159", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.147", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "deepScanned": false, "deepscanReportPath": "", "detectionTime": "2020-05-26T06:31:58Z", "detectionType": "N/A", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "httpUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36 EtpClient:3.0.0", "httpVersion": "1.1", "internalClientIP": "192.0.2.224", "listId": "-1", "listIdentifiers": [ { "categoryId": 55, "categoryName": "Streaming Websites", "confidenceId": 0, "confidenceName": "Unknown", "listId": -1, "listName": "unknown", "threatId": 0, "threatName": "Unclassified" }, { "categoryId": 73, "categoryName": "73", "confidenceId": 0, "confidenceName": "Unknown", "listId": -1, "listName": "unknown", "threatId": 0, "threatName": "Unclassified" } ], "listName": "unknown", "matchedGroups": [], "onrampType": "etp_client", "policyId": "0", "policyName": "0", "reason": "Acceptable use policy", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "trigger": "null" }, "id": "2", "isEvent": false, "l7Protocol": "HTTPS", "request": { "clientIp": "192.0.2.84", "clientPort": 42380, "connectionId": "0x3706B3154FAE37181163A", "destinationIP": "192.0.2.90", "destinationPort": 443, "domain": "clickstream-killswitch.hd-personalization-prod.gcp.example.com.", "headers": [ { "name": "Accept", "value": "*/*" }, { "name": "Accept-Encoding", "value": "gzip, deflate, br" }, { "name": "Accept-Language", "value": "en-US,en;q=0.9" }, { "name": "Connection", "value": "keep-alive" }, { "name": "content-type", "value": "application/json" }, { "name": "Host", "value": "clickstream-killswitch.hd-personalization-prod.gcp.example.com" }, { "name": "Origin", "value": "https://www.example.com" }, { "name": "Referer", "value": "https://www.example.com/" }, { "name": "User-Agent", "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36" } ], "method": "GET", "queryStrings": [], "startTime": 1590474718273, "uri": "/clickstream-killswitch/v1/detail", "uuid": "a1d7f692-c932-466a-82f6-e4e85bba7864" }, "response": { "endTime": 1590474718348, "hash": "", "headers": [ { "name": "Access-Control-Allow-Origin", "value": "https://www.example.com" }, { "name": "Content-Length", "value": "1329" }, { "name": "Content-Type", "value": "application/json;charset=UTF-8" }, { "name": "Date", "value": "Tue, 26 May 2020 06:31:57 GMT" }, { "name": "Vary", "value": "Origin, Access-Control-Request-Method, Access-Control-Request-Headers" }, { "name": "Via", "value": "1.1 google" } ] }, "userIdentity": { "encryptedUserID": "", "encryptedUserName": "", "groups": [] } }, { "event": { "actionId": "4", "actionName": "Block - Error Page", "blockDescription": "The URL hosts malware.", "categoryId": "31", "categoryName": "Chat Site", "clientRequestId": "c37a4c4e-a7cd-400f-820d-b82762c52975-15904746699129224-48707", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacncstage.com", "internalIP": "192.0.2.114", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.184", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "deepScanned": false, "deepscanReportPath": "", "detectionTime": "2020-05-26T06:31:46Z", "detectionType": "inline", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "httpUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36 EtpClient:3.0.0", "httpVersion": "1.1", "internalClientIP": "192.0.2.218", "listId": "-1", "listIdentifiers": [ { "categoryId": 31, "categoryName": "Chat Site", "confidenceId": 0, "confidenceName": "Unknown", "listId": -1, "listName": "unknown", "threatId": 0, "threatName": "Unclassified" } ], "listName": "unknown", "matchedGroups": [], "onrampType": "etp_client", "policyId": "38307", "policyName": "E2E-CML-stage", "reason": "Acceptable use policy", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "trigger": "null" }, "id": "3", "isEvent": true, "l7Protocol": "HTTPS", "request": { "clientIp": "192.0.2.11", "clientPort": 41176, "connectionId": "0x3706B3154FAE084111637", "destinationIP": "2001:db8:c08f:942:b49c:17a9:4f76:73ed", "destinationPort": 443, "domain": "c.go-mpulse.net.", "headers": [ { "name": "Accept", "value": "*/*" }, { "name": "Accept-Encoding", "value": "gzip, deflate, br" }, { "name": "Accept-Language", "value": "en-US,en;q=0.9" }, { "name": "Connection", "value": "keep-alive" }, { "name": "Host", "value": "c.go-mpulse.net" }, { "name": "Origin", "value": "https://www.akamai.com" }, { "name": "User-Agent", "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36" } ], "method": "GET", "queryStrings": [ { "name": "key", "value": "FDSGP-LEB9B-T8Y2A-5V5ED-9WX2T" }, { "name": "d", "value": "www.akamai.com" }, { "name": "t", "value": "5301582" }, { "name": "v", "value": "1.667.0" }, { "name": "if", "value": "" }, { "name": "sl", "value": "0" }, { "name": "si", "value": "876aebf5-a115-47de-973b-9ac2ba2cdd1c-qaqswv" }, { "name": "r", "value": "" }, { "name": "bcn", "value": "%2F%2F173e2548.akstat.io%2F" }, { "name": "acao", "value": "" }, { "name": "ak.ai", "value": "593889" } ], "startTime": 1590474706144, "uri": "/api/config.json", "uuid": "8e86b32f-9a83-4162-a008-3e2c58b09f87" }, "response": { "endTime": 1590474706146, "hash": "", "headers": [] }, "userIdentity": { "encryptedUserID": "", "encryptedUserName": "", "groups": [] } }, { "event": { "actionId": "5", "actionName": "Allow", "blockDescription": "The URL hosts malware.", "categoryId": "73", "categoryName": "73", "clientRequestId": "c37a4c4e-a7cd-400f-820d-b82762c52975-15904746509095241-48705", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2020-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacncstage.com", "internalIP": "192.0.2.210", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.155", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "deepScanned": false, "deepscanReportPath": "", "detectionTime": "2020-05-26T06:31:28Z", "detectionType": "N/A", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "BOS-WPX5E", "httpUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36 EtpClient:3.0.0", "httpVersion": "1.1", "internalClientIP": "192.0.2.168", "listId": "-1", "listIdentifiers": [ { "categoryId": 73, "categoryName": "73", "confidenceId": 0, "confidenceName": "Unknown", "listId": -1, "listName": "unknown", "threatId": 0, "threatName": "Unclassified" } ], "listName": "unknown", "matchedGroups": [], "onrampType": "etp_client", "policyId": "0", "policyName": "0", "reason": "Acceptable use policy", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "E2E WIN 174.232 site", "trigger": "null" }, "id": "4", "isEvent": false, "l7Protocol": "HTTPS", "request": { "clientIp": "192.0.2.243", "clientPort": 43149, "connectionId": "0x3706B3124FADC2CF9570", "destinationIP": "192.0.2.248", "destinationPort": 443, "domain": "d.la1-c2-ia4.salesforceliveagent.com.", "headers": [ { "name": "Accept", "value": "*/*" }, { "name": "Accept-Encoding", "value": "gzip, deflate, br" }, { "name": "Accept-Language", "value": "en-US,en;q=0.9" }, { "name": "Connection", "value": "keep-alive" }, { "name": "Host", "value": "d.la1-c2-ia4.salesforceliveagent.com" }, { "name": "User-Agent", "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36" } ], "method": "GET", "queryStrings": [ { "name": "sid", "value": "409d47de-bf85-433c-9c88-79add325835a" }, { "name": "r", "value": "906" }, { "name": "Availability.prefix", "value": "Visitor" }, { "name": "Availability.ids", "value": "[5730f000000HhB2,5730f000000HhAJ,5730f000000HhAY]" }, { "name": "callback", "value": "liveagent._.handlePing" }, { "name": "deployment_id", "value": "5720f0000009HUh" }, { "name": "org_id", "value": "00DA0000000Hu5a" }, { "name": "version", "value": "43" } ], "startTime": 1590474688053, "uri": "/chat/rest/Visitor/Availability.jsonp", "uuid": "7b33eedd-8b7d-463b-80d9-996b74a0a9ee" }, "response": { "endTime": 1590474688139, "hash": "", "headers": [ { "name": "Access-Control-Allow-Origin", "value": "*" }, { "name": "Cache-Control", "value": "no-cache" }, { "name": "Connection", "value": "close" }, { "name": "Content-Encoding", "value": "gzip" }, { "name": "Content-Type", "value": "text/javascript" }, { "name": "Expires", "value": "-1" }, { "name": "Pragma", "value": "no-cache" }, { "name": "X-Content-Type-Options", "value": "nosniff" } ] }, "userIdentity": { "encryptedUserID": "", "encryptedUserName": "", "groups": [] } } ], "pageInfo": { "pageNumber": 1, "pageSize": 5, "totalRecords": 44583 } }, "schema": { "additionalProperties": false, "description": "Proxy traffic transaction events for the given time period.", "properties": { "dataRows": { "description": "Proxy traffic transaction event details and a list of matching events.", "items": { "additionalProperties": false, "description": "Proxy traffic transaction event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "event": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "id": { "description": "Unique ID of the network connections.", "minLength": 1, "type": "string" }, "isEvent": { "description": "Whether the traffic creates an event.", "type": "boolean" }, "l7Protocol": { "description": "The layer 7 protocol used to make the DNS query or web request. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "request": { "additionalProperties": false, "description": "The details about the web request.", "properties": { "clientIp": { "description": "The IP address of the source NAT branch or machine.", "type": "string" }, "clientPort": { "description": "The TCP port used by the client machine to connect the destination.", "minimum": 0, "type": "integer" }, "connectionId": { "description": "The unique identifier of the TCP connection created.", "minLength": 1, "type": "string" }, "destinationIP": { "description": "The IP address of the target machine to send the request.", "type": "string" }, "destinationPort": { "description": "The TCP port used to connect the destination machine.", "minimum": 0, "type": "integer" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "endTime": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "headers": { "description": "The details about the HTTP request headers.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP request header.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP request header.", "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "minItems": 1, "type": "array" }, "method": { "description": "The HTTP action used to interact with the destination.", "minLength": 1, "type": "string" }, "queryStrings": { "description": "The details about the query parameters sent as part of the web request.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the query parameter.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the query parameter.", "minLength": 0, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "minItems": 0, "type": "array" }, "startTime": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" }, "uri": { "description": "The path part of the URL.", "minLength": 1, "type": "string" }, "uuid": { "description": "A unique ID for the request.", "type": "string" } }, "required": [ "startTime", "connectionId", "domain", "uri" ], "type": "object", "x-akamai": { "file-path": "schemas/request.yaml" } }, "response": { "additionalProperties": false, "description": "The details about the response to the web request.", "properties": { "endTime": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "hash": { "description": "The hashed value of the response.", "type": "string" }, "headers": { "description": "The details about the HTTP response headers.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP response header.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP response header.", "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "minItems": 0, "type": "array" }, "responseCode": { "description": "The response's HTTP status code.", "type": "string" }, "startTime": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "headers" ], "type": "object", "x-akamai": { "file-path": "schemas/response.yaml" } }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" }, "userIdentity": { "additionalProperties": false, "description": "Detailed user information.", "properties": { "decryptedUserId": { "description": "The user's ID in decrypted form.", "minLength": 0, "type": "string" }, "decryptedUserName": { "description": "The user's name in decrypted form.", "minLength": 0, "type": "string" }, "encryptedUserID": { "description": "The user's ID in encrypted form.", "minLength": 0, "type": "string" }, "encryptedUserName": { "description": "The user's name in encrypted form.", "minLength": 0, "type": "string" }, "groups": { "description": "A list of groups the user belongs to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "encryptedUserID", "encryptedUserName", "groups" ], "type": "object", "x-akamai": { "file-path": "schemas/user-identity.yaml" } } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-traffic-transactions-details.yaml" } }, "minItems": 0, "type": "array" }, "pageInfo": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } } }, "required": [ "dataRows", "pageInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-transaction-events-details-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report proxy network traffic transaction details", "tags": [ "Proxy traffic transactions" ] }, "parameters": [ { "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/proxy-traffic-details.yaml", "path-info": "/configs/{configId}/proxy-traffic/transactions/details" } }, "/configs/{configId}/proxy-traffic/transactions/time-series": { "get": { "description": "Lists proxy traffic transaction totals, aggregated by hour.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-traffic-transactions-time-series" }, "operationId": "get-traffic-transactions-time-series", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "site", "policy", "destinationIP", "encryptedInternalClientIP", "encryptedUserName", "action", "applicationId", "asName", "clientPort", "clientRequestId", "destinationIp", "destinationPort", "deviceId", "deviceOwnerId", "devicePostureRisk", "dlpDictionaryId", "dlpFileHash", "fileType", "country", "group", "httpRequestMethod", "encryptedInternalClientName", "matchedGroups", "onrampType", "operationId", "dlpPatternId", "reason", "responseCode", "riskId", "clientIp", "sublocationId", "encryptedUserId" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-proxy-traffic-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter Http traffic events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "applicationId": { "additionalProperties": false, "description": "Filter by AVC application.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter data by category IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientPort": { "additionalProperties": false, "description": "Filter by Client port number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "country": { "additionalProperties": false, "description": "Filter report data by geographical regions.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserId": { "additionalProperties": false, "description": "Filter report data by userId, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "group": { "additionalProperties": false, "description": "Filter report data by user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isEvent": { "additionalProperties": false, "description": "Filter report data if its part of the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "matchedGroups": { "additionalProperties": false, "description": "Filter report data by matched user groups.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "operationId": { "additionalProperties": false, "description": "Filter data based on operation.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "responseCode": { "additionalProperties": false, "description": "Filter report data by response code.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "riskId": { "additionalProperties": false, "description": "Filter report data by risk values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-proxy-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-proxy-traffic-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "TIMESTAMP" }, { "id": "GET", "name": "GET" }, { "id": "POST", "name": "POST" }, { "id": "OTHERS", "name": "OTHERS" } ], "rows": [ [ "2018-04-03T09:00:00Z", 30, 20, 20 ], [ "2018-04-03T10:00:00Z", 40, 4, 3 ], [ "2018-04-03T11:00:00Z", 4, 1, 9 ], [ "2018-04-03T12:00:00Z", 10, 0, 2 ], [ "2018-04-03T13:00:00Z", 8, 1, 4 ], [ "2018-04-03T14:00:00Z", 0, 0, 0 ], [ "2018-04-03T15:00:00Z", 0, 0, 0 ], [ "2018-04-03T16:00:00Z", 0, 0, 0 ], [ "2018-04-03T17:00:00Z", 0, 0, 0 ], [ "2018-04-03T18:00:00Z", 10, 12, 14 ], [ "2018-04-03T19:00:00Z", 10, 15, 70 ], [ "2018-04-03T20:00:00Z", 0, 0, 0 ], [ "2018-04-03T21:00:00Z", 0, 0, 0 ], [ "2018-04-03T22:00:00Z", 0, 0, 0 ], [ "2018-04-03T23:00:00Z", 0, 0, 0 ], [ "2018-04-04T00:00:00Z", 0, 0, 0 ], [ "2018-04-04T01:00:00Z", 0, 0, 0 ], [ "2018-04-04T02:00:00Z", 0, 0, 0 ], [ "2018-04-04T03:00:00Z", 0, 0, 0 ], [ "2018-04-04T04:00:00Z", 0, 0, 0 ], [ "2018-04-04T05:00:00Z", 0, 0, 0 ], [ "2018-04-04T06:00:00Z", 0, 0, 0 ], [ "2018-04-04T07:00:00Z", 0, 0, 0 ], [ "2018-04-04T08:00:00Z", 0, 0, 0 ], [ "2018-04-04T09:00:00Z", 0, 0, 0 ], [ "2018-04-04T10:00:00Z", 0, 0, 0 ], [ "2018-04-04T11:00:00Z", 0, 0, 0 ], [ "2018-04-04T12:00:00Z", 0, 0, 0 ], [ "2018-04-04T13:00:00Z", 0, 0, 0 ], [ "2018-04-04T14:00:00Z", 0, 0, 0 ], [ "2018-04-04T15:00:00Z", 0, 0, 0 ], [ "2018-04-04T16:00:00Z", 0, 0, 0 ], [ "2018-04-04T17:00:00Z", 0, 0, 0 ], [ "2018-04-04T18:00:00Z", 0, 0, 0 ], [ "2018-04-04T19:00:00Z", 0, 0, 0 ], [ "2018-04-04T20:00:00Z", 0, 0, 0 ], [ "2018-04-04T21:00:00Z", 0, 0, 0 ], [ "2018-04-04T22:00:00Z", 0, 0, 0 ], [ "2018-04-04T23:00:00Z", 0, 0, 0 ], [ "2018-04-05T00:00:00Z", 0, 0, 0 ], [ "2018-04-05T01:00:00Z", 0, 0, 0 ], [ "2018-04-05T02:00:00Z", 0, 0, 0 ], [ "2018-04-05T03:00:00Z", 0, 0, 0 ], [ "2018-04-05T04:00:00Z", 0, 0, 0 ], [ "2018-04-05T05:00:00Z", 0, 0, 0 ], [ "2018-04-05T06:00:00Z", 0, 0, 0 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report proxy traffic transactions time series", "tags": [ "Proxy traffic transactions" ] }, "parameters": [ { "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/proxy-traffic-time-series.yaml", "path-info": "/configs/{configId}/proxy-traffic/transactions/time-series" } }, "/configs/{configId}/schedules": { "post": { "description": "Creates a new report schedule for a given SIA configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-config-schedule" }, "operationId": "post-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", "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": { "201": { "content": { "application/json": { "example": [ { "createdBy": "jsmith", "creationDate": "2017-06-22T11:12:55Z", "dayOfWeek": "MONDAY", "emails": [ "user1@akamai.com", "user2@akamai.com" ], "filters": { "isAlert": { "in": [ "true" ] } }, "modifiedBy": "jsmith", "modifiedDate": "2017-06-28T11:12:55Z", "recurrence": "WEEKLY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 100, "status": "ENABLED", "userTimeZone": "+05:30" }, { "createdBy": "jkowalski", "creationDate": "2017-06-23T11:12:55Z", "dayOfWeek": null, "emails": [ "user1@akamai.com" ], "modifiedBy": "tyamada", "modifiedDate": "2017-06-23T11:12:55Z", "recurrence": "DAILY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 110, "status": "ENABLED", "userTimeZone": "+05:30" } ], "schema": { "description": "SIA report scheduling parameters.", "items": { "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" } }, "type": "array", "x-akamai": { "file-path": "schemas/report-schedules.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Create a report schedule", "tags": [ "Report schedules" ] }, "get": { "description": "Lists all configured report schedules for a given configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-config-schedules" }, "operationId": "get-config-schedules", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "createdBy": "jsmith", "creationDate": "2017-06-22T11:12:55Z", "dayOfWeek": "MONDAY", "emails": [ "user1@akamai.com", "user2@akamai.com" ], "filters": { "isAlert": { "in": [ "true" ] } }, "modifiedBy": "jsmith", "modifiedDate": "2017-06-28T11:12:55Z", "recurrence": "WEEKLY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 100, "status": "ENABLED", "userTimeZone": "+05:30" }, { "createdBy": "jkowalski", "creationDate": "2017-06-23T11:12:55Z", "dayOfWeek": null, "emails": [ "user1@akamai.com" ], "modifiedBy": "tyamada", "modifiedDate": "2017-06-23T11:12:55Z", "recurrence": "DAILY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 110, "status": "ENABLED", "userTimeZone": "+05:30" } ], "schema": { "description": "SIA report scheduling parameters.", "items": { "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" } }, "type": "array", "x-akamai": { "file-path": "schemas/report-schedules.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "List report schedules", "tags": [ "Report schedules" ] }, "parameters": [ { "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/schedules.yaml", "path-info": "/configs/{configId}/schedules" } }, "/configs/{configId}/schedules/{scheduleId}": { "get": { "description": "Lists 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/get-config-schedule" }, "operationId": "get-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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdBy": "alfulani", "creationDate": "2017-06-22T11:12:55Z", "criterias": { "siteIds": [] }, "daily": true, "dayOfWeek": "MONDAY", "emails": [ "user1@akamai.com", "user2@akamai.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": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Get a report schedule", "tags": [ "Report schedules" ] }, "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@akamai.com", "user2@akamai.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": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" ] }, "delete": { "description": "Removes 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/delete-config-schedule" }, "operationId": "delete-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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "createdBy": "jsmith", "creationDate": "2017-06-22T11:12:55Z", "dayOfWeek": "MONDAY", "emails": [ "user1@akamai.com", "user2@akamai.com" ], "filters": { "isAlert": { "in": [ "true" ] } }, "modifiedBy": "jsmith", "modifiedDate": "2017-06-28T11:12:55Z", "recurrence": "WEEKLY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 100, "status": "ENABLED", "userTimeZone": "+05:30" }, { "createdBy": "jkowalski", "creationDate": "2017-06-23T11:12:55Z", "dayOfWeek": null, "emails": [ "user1@akamai.com" ], "modifiedBy": "tyamada", "modifiedDate": "2017-06-23T11:12:55Z", "recurrence": "DAILY", "reportTemplate": "THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "scheduleId": 110, "status": "ENABLED", "userTimeZone": "+05:30" } ], "schema": { "description": "SIA report scheduling parameters.", "items": { "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" } }, "type": "array", "x-akamai": { "file-path": "schemas/report-schedules.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Remove 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}" } }, "/configs/{configId}/schedules/{scheduleId}/disable": { "post": { "description": "Disables 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/post-config-schedule-disable" }, "operationId": "post-config-schedule-disable", "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" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Disable 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/disable.yaml", "path-info": "/configs/{configId}/schedules/{scheduleId}/disable" } }, "/configs/{configId}/schedules/{scheduleId}/enable": { "post": { "description": "Enables 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/post-config-schedule-enable" }, "operationId": "post-config-schedule-enable", "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" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Enable 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/enable.yaml", "path-info": "/configs/{configId}/schedules/{scheduleId}/enable" } }, "/configs/{configId}/sinkhole-events/aggregate": { "get": { "description": "Lists the count of Security Connector events, grouped by the chosen query aggregation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-sinkhole-events" }, "operationId": "get-sinkhole-events", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "encryptedSourceIp", "encryptedMachineName", "destinationPort", "hostname", "sourcePort", "sinkholeIP", "sinkholeId", "requestId", "status" ], "example": "status", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-sc-query.yaml" } }, { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter sinkhole events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dropFlag": { "additionalProperties": false, "description": "Filter report data by checking the drop flag.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hasCorrelation": { "additionalProperties": false, "description": "Filter report data by checking if correlated event exists.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hfRedirectType": { "additionalProperties": false, "description": "Filter report data by hf redirect types.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyMode": { "additionalProperties": false, "description": "Filter report data by proxy mode.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "redirectType": { "additionalProperties": false, "description": "Filter report data by redirect types.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "requestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sinkholeId": { "additionalProperties": false, "description": "Filter report data by sinkhole Id.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sinkholeIp": { "additionalProperties": false, "description": "Filter report data by sinkhole IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "status": { "additionalProperties": false, "description": "Filter report data by status values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-sc-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-sc-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregations": [ { "id": "192.0.2.228", "name": "192.0.2.176", "total": 14 } ], "dimension": { "id": "sourceIP", "name": "internalIP", "total": 1 } }, "schema": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "aggregations": { "description": "An aggregated list of events or traffic for the given time period.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The total count of sinkhole events for the identifier for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" }, "minItems": 0, "type": "array" }, "dimension": { "additionalProperties": false, "description": "Indicates the dimension value to aggregate by.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the identifier.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-aggregate.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report security connector event totals", "tags": [ "Security Connector event reports" ] }, "parameters": [ { "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/sinkhole-events-aggregate.yaml", "path-info": "/configs/{configId}/sinkhole-events/aggregate" } }, "/configs/{configId}/sinkhole-events/details": { "post": { "description": "Lists Security Connector events for a given time period.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-sinkhole-event-details" }, "operationId": "post-sinkhole-event-details", "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": { "endTimeSec": 1589965237, "filters": {}, "orderBy": "DESC", "pageNumber": 1, "pageSize": 5, "startTimeSec": 1587459637 }, "schema": { "additionalProperties": false, "description": "Request parameters for a detailed report of events.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter sinkhole events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dropFlag": { "additionalProperties": false, "description": "Filter report data by checking the drop flag.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hasCorrelation": { "additionalProperties": false, "description": "Filter report data by checking if correlated event exists.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hfRedirectType": { "additionalProperties": false, "description": "Filter report data by hf redirect types.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyMode": { "additionalProperties": false, "description": "Filter report data by proxy mode.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "redirectType": { "additionalProperties": false, "description": "Filter report data by redirect types.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "requestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sinkholeId": { "additionalProperties": false, "description": "Filter report data by sinkhole Id.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sinkholeIp": { "additionalProperties": false, "description": "Filter report data by sinkhole IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "status": { "additionalProperties": false, "description": "Filter report data by status values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-sc-events.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec", "endTimeSec" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "configId": 1100, "decryptedMachineName": "N/A", "decryptedSourceIP": "192.0.2.141", "destinationPort": 443, "encryptedMachineName": "ZMwPWdbcJT/cBpscakcE262I/w==", "encryptedSourceIP": "dlRYs2/etXv09H9yh3DTnejiLXazdMoWjDP7aaWS", "eventId": "1633424825021#564D8828-42DF-EEA6-6215-FC31763BB807#628631d3ffdf4734a952931244b5e03e", "eventTime": "2021-10-05T09:07:05Z", "hitCount": 1, "hostname": "www.yahoo.com", "internalIP": "N/A", "l4Protocol": "TCP", "l7Protocol": "HTTPS", "machineNames": [ "N/A" ], "redirectType": "HTTP-Explicit", "sinkholeIP": "192.0.2.81", "sinkholeId": "564D8828-42DF-EEA6-6215-FC31763BB807", "sinkholeName": "564D8828-42DF-EEA6-6215-FC31763BB807", "sourcePort": 39006, "url": "N/A", "userAgent": "curl/7.68.0" } ], "schema": { "description": "Security connector report details and a list of matching events.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/sinkhole-events-details-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report security connector event details", "tags": [ "Security Connector event reports" ] }, "parameters": [ { "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/sinkhole-events-details.yaml", "path-info": "/configs/{configId}/sinkhole-events/details" } }, "/configs/{configId}/sinkhole-events/time-series": { "get": { "description": "Lists Security Connector event totals, aggregated by hour.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-sinkhole-events-time-series" }, "operationId": "get-sinkhole-events-time-series", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "encryptedSourceIp", "encryptedMachineName", "destinationPort", "hostname", "sourcePort", "sinkholeIP", "sinkholeId", "requestId", "status" ], "example": "status", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-sc-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter sinkhole events report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dropFlag": { "additionalProperties": false, "description": "Filter report data by checking the drop flag.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hasCorrelation": { "additionalProperties": false, "description": "Filter report data by checking if correlated event exists.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hfRedirectType": { "additionalProperties": false, "description": "Filter report data by hf redirect types.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyMode": { "additionalProperties": false, "description": "Filter report data by proxy mode.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "redirectType": { "additionalProperties": false, "description": "Filter report data by redirect types.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "requestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sinkholeId": { "additionalProperties": false, "description": "Filter report data by sinkhole Id.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sinkholeIp": { "additionalProperties": false, "description": "Filter report data by sinkhole IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "status": { "additionalProperties": false, "description": "Filter report data by status values.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-sc-events.yaml" } }, "x-akamai": { "file-path": "parameters/filters-sc-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "TIMESTAMP" }, { "id": "192.0.2.11", "name": "192.0.2.85" }, { "id": "192.0.2.99", "name": "192.0.2.196" }, { "id": "192.0.2.213", "name": "192.0.2.252" }, { "id": "192.0.2.152", "name": "192.0.2.144" }, { "id": "OTHERS", "name": "OTHERS" } ], "rows": [ [ "2018-02-28T18:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-02-28T20:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-02-28T22:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T00:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T02:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T04:00:00Z", 0, 2, 0, 0, 0 ], [ "2018-03-01T06:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T08:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T10:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T12:00:00Z", 0, 0, 0, 0, 0 ], [ "2018-03-01T14:00:00Z", 104, 0, 0, 0, 0 ], [ "2018-03-01T16:00:00Z", 300, 0, 0, 2, 0 ], [ "2018-03-01T18:00:00Z", 5398, 0, 0, 0, 0 ], [ "2018-03-01T20:00:00Z", 0, 0, 0, 0, 0 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report security connector event time series", "tags": [ "Security Connector event reports" ] }, "parameters": [ { "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/sinkhole-events-time-series.yaml", "path-info": "/configs/{configId}/sinkhole-events/time-series" } }, "/configs/{configId}/threat-events/aggregate": { "get": { "description": "Lists the count of threat events, grouped by the chosen query aggregation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-threat-events" }, "operationId": "get-threat-events", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "destinationIP", "site", "list", "policy", "action", "category", "confidence", "clientIP", "transportType", "dohAttribution", "sublocationId", "devicePostureRisk", "detectionType", "deviceId", "onrampType", "encryptedInternalClientIP", "encryptedInternalClientName", "encryptedUserName", "deviceOwnerId", "dlpDictionaryId", "dlpPatternId", "dlpFileHash", "fileType", "applicationId", "riskId", "operationId", "threatId", "severityId", "httpRequestMethod", "uri", "proxyDestinationPort", "reason", "l7Protocol", "blockDescription" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-threat-query.yaml" } }, { "description": "The number of records to fetch for the aggregation.", "in": "query", "name": "cardinality", "required": false, "schema": { "example": 2500, "type": "integer" }, "x-akamai": { "file-path": "parameters/cardinality-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter threat report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-threats.yaml" } }, "x-akamai": { "file-path": "parameters/filters-query-threat.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregations": [ { "id": "564", "name": "BOS-HQ-Corp", "total": 26 }, { "id": "1220", "name": "BOS-15S-Corp", "total": 10 }, { "id": "-1", "name": "Roaming", "total": 7 }, { "id": "841", "name": "DUB-1DL-Corp+Guest", "total": 7 }, { "id": "840", "name": "BOS-HQ-Guest", "total": 2 } ], "dimension": { "id": "site", "name": "site", "total": 5 } }, "schema": { "additionalProperties": false, "description": "Response with details.", "properties": { "aggregations": { "description": "An aggregated list of events or traffic for the given time period.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the aggregation.", "minLength": 1, "type": "string" }, "total": { "description": "The total count of threat events for the identifier for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" }, "minItems": 1, "type": "array" }, "dimension": { "additionalProperties": false, "description": "Indicates the dimension value to aggregate by.", "properties": { "id": { "description": "A unique identifier for the object.", "minLength": 1, "type": "string" }, "name": { "description": "A descriptive name for the dimension.", "minLength": 1, "type": "string" }, "total": { "description": "The unique dimension count for the given time period.", "minimum": 0, "type": "integer" } }, "required": [ "name", "id", "total" ], "type": "object" } }, "required": [ "aggregations", "dimension" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-aggregate-site.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report threat event totals", "tags": [ "Threat events" ] }, "parameters": [ { "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/threat-events-aggregate.yaml", "path-info": "/configs/{configId}/threat-events/aggregate" } }, "/configs/{configId}/threat-events/details": { "post": { "description": "Provides all threat events records with detailed information.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/post-threat-event-details" }, "operationId": "post-threat-event-details", "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": { "endTimeSec": 1589965237, "filters": {}, "orderBy": "DESC", "pageNumber": 1, "pageSize": 5, "startTimeSec": 1587459637 }, "schema": { "additionalProperties": true, "description": "Request parameters for a detailed report of events.", "properties": { "endTimeSec": { "description": "The end time for report data, in epoch seconds.", "minimum": 0, "type": "integer" }, "filters": { "additionalProperties": false, "description": "Options to filter threat report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-threats.yaml" } }, "orderBy": { "description": "The order of event data, either `ASC` or `DESC`. Defaults to `DESC`.", "enum": [ "ASC", "DESC" ], "type": "string" }, "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "startTimeSec": { "description": "The start time for report data, in epoch seconds.", "minimum": 1, "type": "integer" } }, "required": [ "startTimeSec" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "dataRows": [ { "configId": "1041", "event": { "actionId": "6", "actionName": "Classify", "categoryId": "24", "categoryName": "24", "clientRequestId": "00019749", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2023-05-22T02:16:34Z", "hitCount": 1, "hostname": "lax4.company.com", "internalIP": "192.0.2.57", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.114", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2023-05-26T06:34:53Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "24", "listName": "24", "onRamp": "Yes", "onrampType": "etp-client", "policyEvaluationSource": "dns", "policyId": "38307", "policyName": "E2E-CML-stage", "reason": "Akamai Intelligence (DNS)", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "LAX-LAB2", "threatId": 2000, "threatName": "AUP", "trigger": "domain" }, "id": "0", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.61", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "LAX-USER4", "dnsIp": "192.0.2.51", "domain": "la4.company.com.", "queryType": "A", "resolved": [ { "asn": "14340", "asname": "N/A", "response": "192.0.2.207", "type": "A" }, { "asn": "14340", "asname": "N/A", "response": "192.0.2.106", "type": "A" }, { "asn": "14340", "asname": "N/A", "response": "192.0.2.214", "type": "A" } ], "time": "2023-05-26T06:34:53Z", "uuid": "1a2b3c4d-1590474893-46281-35384" } }, { "configId": "1041", "event": { "actionId": "6", "actionName": "Classify", "categoryId": "24", "categoryName": "24", "clientRequestId": "00019748", "confidenceId": "0", "confidenceName": "Unknown", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2023-05-22T02:16:34Z", "hitCount": 1, "hostname": "labs.company.com", "internalIP": "192.0.2.25", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.13", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2023-05-26T06:34:52Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "24", "listName": "24", "onRamp": "Yes", "onrampType": "SIA-client", "policyEvaluationSource": "dns", "policyId": "38307", "policyName": "labs", "reason": "Akamai Intelligence (DNS)", "severityId": 0, "severityLevel": "Unclassified", "siteId": "51284", "siteName": "LAX LAB site", "threatId": 2000, "threatName": "AUP", "trigger": "domain" }, "id": "1", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.193", "deviceId": "c37a4c4e-a7cd-400f-820d-b82762c52975", "deviceName": "LAX-LAB5", "dnsIp": "192.0.2.175", "domain": "teams.microsoft.com.", "queryType": "A", "resolved": [ { "asn": "8068", "asname": "N/A", "response": "192.0.2.141", "type": "A" } ], "time": "2023-05-26T06:34:52Z", "uuid": "3h9g0235-1590474892-14345-62675" } }, { "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "categoryId": "1", "categoryName": "Malware", "clientRequestId": "", "confidenceId": "2", "confidenceName": "Known", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976-ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2023-05-22T02:16:34Z", "hitCount": 1, "hostname": "lab2.company.com", "internalIP": "192.0.2.59", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.141", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2023-05-26T06:34:51Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "1", "listName": "Malware", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "reason": "Akamai Intelligence (DNS)", "severityId": 2, "severityLevel": "High", "siteId": "-1", "siteName": "Unidentified IPs", "threatId": 5070, "threatName": "Known Malware", "trigger": "domain" }, "id": "2", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.88", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.3", "domain": "1590449691.akamaisiamalwarestage.com.", "queryType": "AAAA", "resolved": [ { "asn": "N/A", "asname": "N/A", "response": "N/A", "type": "N/A" } ], "time": "2023-05-26T06:34:51Z", "uuid": "kefng73-1590474891-6340-2976" } }, { "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "categoryId": "1", "categoryName": "Malware", "clientRequestId": "", "confidenceId": "2", "confidenceName": "Known", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2023-05-22T02:16:34Z", "hitCount": 1, "hostname": "akamaisiacncstage.com", "internalIP": "192.0.2.93", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.168", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS_SINKHOLE", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2023-05-26T06:34:51Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "1", "listName": "Malware", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "reason": "Akamai Intelligence (DNS)", "severityId": 2, "severityLevel": "High", "siteId": "-1", "siteName": "Unidentified IPs", "threatId": 5070, "threatName": "Known Malware", "trigger": "domain" }, "id": "3", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.28", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.108", "domain": "1590449691.akamaisiamalwarestage.com.", "queryType": "A", "resolved": [ { "asn": "14618", "asname": "aws", "response": "192.0.2.163", "type": "A" } ], "time": "2023-05-26T06:34:51Z", "uuid": "198.18.193.241-198.18.179.134-1590474891-42367-7406" } }, { "configId": "1041", "event": { "actionId": "1", "actionName": "Monitor", "categoryId": "5", "categoryName": "DNS Exfiltration", "clientRequestId": "", "confidenceId": "1", "confidenceName": "Suspected", "correlatedSinkholeEvents": [ { "configId": 1041, "destinationPort": 80, "eventId": "1590113794976#ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11#28301", "eventTime": "2023-05-22T02:16:34Z", "hitCount": 1, "hostname": "lax-lab3.company.com", "internalIP": "192.0.2.138", "l4Protocol": "TCP", "l7Protocol": "HTTP", "machineNames": [ "N/A" ], "sinkholeIP": "192.0.2.253", "sinkholeId": "ac4bde1e-7d3d-4ff5-9cf8-772df0b1ce11", "sinkholeName": "SIA_DNS", "sourcePort": 48022, "url": "/", "userAgent": "curl/7.47.0" } ], "description": "None", "detectionTime": "2023-05-26T06:34:51Z", "detectionType": "inline", "internalClientIP": "N/A", "listId": "4", "listName": "DNS Exfiltration", "onRamp": "No", "onrampType": "", "policyEvaluationSource": "dns", "policyId": "2240", "policyName": "Default", "reason": "Akamai Intelligence (DNS)", "severityId": 4, "severityLevel": "Low", "siteId": "-1", "siteName": "Unidentified IPs", "threatId": 5135, "threatName": "Suspected DNS tunneling", "trigger": "domain" }, "id": "4", "l7Protocol": "DNS", "query": { "clientIp": "192.0.2.170", "deviceId": "N/A", "deviceName": "Not Available", "dnsIp": "192.0.2.117", "domain": "1590449691.akamaisiamalwarestage.com.e2e-sia.org.", "queryType": "AAAA", "resolved": [ { "asn": "N/A", "asname": "N/A", "response": "N/A", "type": "N/A" } ], "time": "2023-05-26T06:34:51Z", "uuid": "198.18.193.241-198.18.179.134-1590474891-5081-49572" } } ], "pageInfo": { "pageNumber": 1, "pageSize": 5, "totalRecords": 97913 } }, "schema": { "additionalProperties": true, "description": "A detailed list of threat events for the given time period.", "properties": { "dataRows": { "description": "Threat event report details and a list of matching events.", "items": { "additionalProperties": false, "description": "Threat event report details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minLength": 1, "type": "string" }, "event": { "additionalProperties": false, "description": "Details about DNS query or web request events.", "properties": { "actionId": { "description": "A unique identifier for the action taken.", "type": "string" }, "actionName": { "description": "A descriptive name for the action identifier.", "minLength": 1, "type": "string" }, "alexaRanking": { "description": "The ranking for the event. A value of -1 indicates no ranking data.", "type": "integer" }, "applicationId": { "description": "A unique identifier for the application.", "minimum": 0, "type": "integer" }, "applicationName": { "description": "A descriptive name for the application.", "minLength": 1, "type": "string" }, "aupCategories": { "description": "AUP categories for the event.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id.yaml" } }, "minItems": 0, "type": "array" }, "blockDescription": { "description": "A short description of the event.", "minLength": 1, "type": "string" }, "catalogId": { "description": "A unique identifier for the catalog.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "A descriptive name for the category identifier.", "minLength": 1, "type": "string" }, "cidr": { "description": "The IP address CIDR block for the event.", "type": "string" }, "clientAgents": { "description": "Client agent that initiated this traffic.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "clientRequestId": { "description": "A unique identifier for the request client.", "minLength": 0, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ "0", "1", "2" ], "type": "string" }, "confidenceName": { "description": "A descriptive name for the confidence level identifier.", "minLength": 1, "type": "string" }, "configId": { "description": "Unique identifier of the configuration for the event.", "type": "integer" }, "correlatedSinkholeEvents": { "description": "Sinkhole event details if there are any co-related events from sinkhole.", "items": { "additionalProperties": false, "description": "Sinkhole event details and a list of matching events.", "properties": { "configId": { "description": "The contract ID for the request.", "minimum": 0, "type": "integer" }, "correlated": { "description": "Whether a related sinkhole event exists.", "type": "boolean" }, "correlatedDnsEvent": { "description": "Nested instances of the same site object.", "type": "object", "x-akamai": { "file-path": "schemas/threat-event-details-nested.yaml" } }, "decryptedMachineName": { "description": "Decrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "decryptedSourceIP": { "description": "IP of the source machine in decrypted form for the event.", "type": "string" }, "decryptedSourceIp": { "description": "Source IP address in decrypted format of the machine assigned with the request.", "type": "string" }, "description": { "description": "Describes the connector event.", "type": "string" }, "destinationIp": { "description": "IP of the destination machine.", "type": "string" }, "destinationPort": { "description": "Destination TCP/UDP Port.", "minimum": 0, "type": "integer" }, "dropFlag": { "description": "Indicates if traffic was dropped by HTTP Forwarder. Either `true` or `false`. Set to `false` if the transaction is successful.", "type": "boolean" }, "encryptedMachineName": { "description": "Encrypted name of the machine assigned to the request.", "minLength": 1, "type": "string" }, "encryptedSourceIP": { "description": "IP of the source machine in encrypted form for the event.", "type": "string" }, "encryptedSourceIp": { "description": "Source IP address in encrypted format of the machine assigned with the request.", "type": "string" }, "eventId": { "description": "Unique ID of the event captured by the security connector.", "minLength": 1, "type": "string" }, "eventTime": { "description": "ISO 8601 timestamp marking the event detection time.", "format": "date-time", "type": "string" }, "hfRedirectType": { "description": "The redirect type for the event.", "type": "string" }, "hitCount": { "description": "Number of repeated traffic requests made to security connector from a host, within a time frame.", "minimum": 0, "type": "integer" }, "hostname": { "description": "Hostname header/SNI host of the destination host.", "type": "string" }, "internalIP": { "description": "Affected or compromised machine IP.", "type": "string" }, "l4Protocol": { "description": "The L4 protocol.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "Application layer protocol used to communicate with the security connector. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "machineNames": { "description": "Hostname of the infected machine.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "proxyMode": { "description": "The proxy type for HTTP forwarder. Possible values include `HTTP-Explicit` and `HTTP-Transparent`.", "enum": [ "HTTP-Explicit", "HTTP-Transparent" ], "type": "string" }, "redirectType": { "description": "Indicates how a request was sent to the security connector. For example: `HTTP-Explicit`.", "minLength": 1, "type": "string" }, "requestId": { "description": "Unique identifier of the request for the event.", "type": "string" }, "sinkholeIP": { "description": "IP of the security connector.", "type": "string" }, "sinkholeId": { "description": "Unique ID of the security connector.", "minLength": 1, "type": "string" }, "sinkholeName": { "description": "The unique security connector name.", "minLength": 1, "type": "string" }, "sourceIp": { "description": "IP address of the machine where the event originated.", "type": "string" }, "sourcePort": { "description": "Source TCP/UDP Port.", "minimum": 0, "type": "integer" }, "status": { "description": "Indicates why traffic was dropped by HTTP Forwarder and any error that occurred.", "type": "string" }, "statusCode": { "description": "Response code for requests. Only applies to requests directed to HTTP Forwarder.", "type": "string" }, "url": { "description": "URL when applicable.", "minLength": 1, "type": "string" }, "userAgent": { "description": "User-agent string for HTTP-based traffic with details about the end user's browser and system.", "minLength": 1, "type": "string" } }, "required": [ "sinkholeId", "sinkholeName", "configId", "hostname", "l4Protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-events-details.yaml" } }, "minItems": 0, "type": "array" }, "decryptedInternalClientIp": { "description": "The decrypted IP address of the client machine.", "type": "string" }, "decryptedInternalClientName": { "description": "The decrypted name of the client machine.", "minLength": 1, "type": "string" }, "deepScanReportDetail": { "description": "Details of the deepscan report for the event.", "type": "string" }, "deepScanned": { "description": "Whether the event generated a deepscan report using static and dynamic malware analysis.", "type": "boolean" }, "deepscanReportPath": { "description": "The location of a deepscan report.", "minLength": 0, "type": "string" }, "description": { "description": "Describes the event.", "type": "string" }, "detectionTime": { "description": "The event detected time in ISO 8601 format.", "format": "date-time", "type": "string" }, "detectionType": { "description": "Event detected during online or while offline batch processing. Either `inline` or `N/A`.", "enum": [ "inline", "N/A" ], "type": "string" }, "deviceId": { "description": "A unique identifier for the device for an event.", "minLength": 1, "type": "string" }, "deviceName": { "description": "The name of the device for an event.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier of the device owner for the event.", "type": "string" }, "devicePostureRisk": { "description": "Device posture risk level for the event. Either `low` or `medium` based on risk tiers defined in [Enterprise Application Access](https://techdocs.akamai.com/etp-reporting/reference/https://techdocs.akamai.com/eaa/docs/define-device-risk-tiers)", "enum": [ "low", "medium" ], "type": "string" }, "dlp": { "description": "Details about DLP scan.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "dohAttribution": { "description": "Unique identifier of DNS over HTTP attribution for the event.", "type": "string" }, "encryptedInternalClientIp": { "description": "The encrypted IP address of the client machine.", "type": "string" }, "encryptedInternalClientName": { "description": "The encrypted name of the client machine.", "minLength": 1, "type": "string" }, "eventType": { "description": "Indicates the type of event, either `aup` or `avc`.", "enum": [ "aup", "avc" ], "type": "string" }, "files": { "description": "File information detected during scan if any.", "items": { "additionalProperties": false, "description": "DLP file scan details.", "properties": { "dictionaryId": { "description": "Unique ID of the dictionary matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "fileHash": { "description": "SHA-256 file hash of the scanned file.", "minLength": 1, "type": "string" }, "fileName": { "description": "Name of the scanned file.", "minLength": 1, "type": "string" }, "fileSize": { "description": "File size of the scanned file in bytes.", "minimum": 1, "type": "integer" }, "fileType": { "description": "MIME file extension of the scanned file.", "minLength": 1, "type": "string" }, "isUpload": { "description": "Includes this data in the upload flow.", "type": "boolean" }, "patternId": { "description": "Lists IDs of the patterns matched during scan.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "scanStatus": { "description": "__Read-only__ Scan status of this record. Values include `Scan Error: Scan Timeout`, `Scan Error`, `Scan Complete: Monitor`, `Scan Complete: Block`, `Scan Complete`, `Unscannable: Encrypted File`, `Unscannable: Super-compressed File`, `Unscannable: Regex Scan Error` or `Scan Error`.", "readOnly": true, "type": "string" } }, "required": [ "fileName", "fileHash", "fileSize", "fileType", "scanStatus" ], "type": "object", "x-akamai": { "file-path": "schemas/file-detail.yaml" } }, "minItems": 0, "type": "array" }, "httpUserAgent": { "description": "The HTTP user agent for an event.", "minLength": 1, "type": "string" }, "httpVersion": { "description": "The version of HTTP protocol used.", "minLength": 1, "type": "string" }, "internalClientIP": { "description": "The IP address of the internal client device used for web traffic.", "type": "string" }, "kid": { "description": "Identifier for a specific JSON web key.", "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minLength": 1, "type": "string" }, "listIdentifiers": { "description": "The scanning results from various classifiers. Only available for web requests.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 0, "type": "integer" }, "categoryName": { "description": "A descriptive name for the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "A unique identifier about the event confidence level. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "A descriptive name for the confidence level.", "minLength": 1, "type": "string" }, "listId": { "description": "A unique identifier for the list.", "minimum": -1, "type": "integer" }, "listName": { "description": "A descriptive name for the list.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier about the threat.", "minimum": 0, "type": "integer" }, "threatName": { "description": "A descriptive name for the threat.", "minLength": 1, "type": "string" } }, "required": [ "listId", "listName", "categoryId", "threatId", "categoryName", "confidenceId", "confidenceName", "threatName" ], "type": "object" }, "minItems": 0, "type": "array" }, "listName": { "description": "A descriptive name for the list identifier.", "minLength": 1, "type": "string" }, "machineId": { "description": "Unique identifier of the machine for the event.", "type": "string" }, "machineName": { "description": "Name of the machine for the event.", "type": "string" }, "matchedGroups": { "description": "Matched groups for the authenticated user, for traffic authenticated against the IDP.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "observedAupCategories": { "description": "Observed AUP categories for the event.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "onRamp": { "description": "Indicates an enabled proxy onramp. Either `Yes` or `No`.", "enum": [ "Yes", "No" ], "type": "string" }, "onrampType": { "description": "The event's onramp type. Either `dns`, `web`, `onramp_dns`, `etp_client`, `etp-client`, `SIA-client`, `etp_offnet_client`, `explicit_policy`, `N/A`, or ``.", "enum": [ "dns", "web", "onramp_dns", "etp_client", "etp-client", "SIA-client", "etp_offnet_client", "explicit_policy", "N/A", "" ], "nullable": true, "type": "string" }, "operationId": { "description": "Operation ID for the accessed domain or URL.", "minLength": 1, "type": "string" }, "operationName": { "description": "Operation name for the accessed domain or URL.", "minLength": 1, "type": "string" }, "policyEvaluationSource": { "description": "Source of the policy evaluation.", "minLength": 1, "type": "string" }, "policyId": { "description": "A unique identifier for the policy.", "minLength": 1, "type": "string" }, "policyName": { "description": "The descriptive name of the matching policy.", "minLength": 1, "type": "string" }, "reason": { "description": "The reason for the traffic block.", "minLength": 1, "type": "string" }, "riskId": { "description": "Risk identifier for the traffic.", "minLength": 1, "type": "string" }, "riskName": { "description": "Identified risk for the traffic.", "minLength": 1, "type": "string" }, "scId": { "description": "Unique identifier of security connector for the event.", "type": "string" }, "scName": { "description": "Name of security connector for the event.", "type": "string" }, "securityCategoryId": { "description": "Unique identifier of the security category for the event.", "type": "string" }, "securityCategoryName": { "description": "Name of the security category for the event.", "type": "string" }, "severityId": { "description": "Indicates the severity of the threat. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minimum": 0, "type": "integer" }, "severityLevel": { "description": "A description of the severity level.", "minLength": 1, "type": "string" }, "siteId": { "description": "A unique identifier for the site.", "minLength": 1, "type": "string" }, "siteName": { "description": "The descriptive name of the source location or branch.", "minLength": 1, "type": "string" }, "status": { "description": "Status of the event discovered.", "type": "string" }, "sublocationId": { "description": "Sublocation identifier where the traffic originated.", "minLength": 1, "type": "string" }, "sublocationName": { "description": "Sublocation name where the traffic originated.", "minLength": 1, "type": "string" }, "threatId": { "description": "A unique identifier for a threat event.", "minimum": 0, "type": "integer" }, "threatName": { "description": "The descriptive name for the threat event.", "minLength": 1, "type": "string" }, "transportType": { "description": "Transport or layer 4 protocol for the event. In this case, whether TCP or the UDP was used. If these protocols are not used, no information is shown in this field.", "nullable": true, "type": "string" }, "trigger": { "description": "Event triggered due to domain or IP policy settings.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName", "policyId", "policyName", "trigger", "confidenceName", "actionId", "actionName" ], "type": "object", "x-akamai": { "file-path": "schemas/events.yaml" } }, "id": { "description": "A unique identifier for the column object.", "minLength": 1, "type": "string" }, "l7Protocol": { "description": "The layer 7 protocol used to make the DNS query or web request. Either `DNS`, `HTTP`, or `HTTPS`.", "enum": [ "DNS", "HTTP", "HTTPS" ], "type": "string" }, "query": { "additionalProperties": false, "description": "Requested DNS query information.", "properties": { "clientIp": { "description": "The requesting client's IP address.", "type": "string" }, "deviceId": { "description": "ID of the device.", "minLength": 1, "type": "string" }, "deviceName": { "description": "Name of device used.", "minLength": 1, "type": "string" }, "deviceOwnerId": { "description": "Unique identifier for the device owner.", "type": "string" }, "dnsIp": { "description": "The DNS resolver IP address.", "type": "string" }, "domain": { "description": "The requested domain address.", "minLength": 1, "type": "string" }, "queryType": { "description": "The DNS query type, such as `A` or `CNAME`.", "minLength": 1, "type": "string" }, "resolved": { "description": "The details about the requested DNS query resolution.", "items": { "additionalProperties": false, "properties": { "asn": { "description": "Autonomous system number used for resolution.", "minLength": 1, "type": "string" }, "asname": { "description": "Autonomous system name used for resolution.", "minLength": 1, "type": "string" }, "response": { "description": "Resolved domain or IP address.", "minLength": 1, "type": "string" }, "type": { "description": "DNS resolution type. For example: `A` or `CNAME`.", "minLength": 1, "type": "string" } }, "required": [ "asn", "response", "type" ], "type": "object" }, "minItems": 0, "type": "array" }, "time": { "description": "Time of DNS request in ISO 8601 format.", "format": "date-time", "type": "string" }, "uuid": { "description": "UUID value.", "minLength": 1, "type": "string" } }, "required": [ "time", "clientIp", "dnsIp", "domain", "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/query.yaml" } } }, "required": [ "id", "configId", "l7Protocol", "query", "event" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details.yaml" } }, "minItems": 1, "type": "array" }, "pageInfo": { "additionalProperties": false, "description": "Provides pagination information for a report.", "properties": { "pageNumber": { "description": "The requested number of pages.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The number of records in a given page.", "minimum": 0, "type": "integer" }, "totalRecords": { "description": "The total number of records for the specified criteria.", "minimum": 0, "type": "integer" } }, "required": [ "totalRecords", "pageNumber", "pageSize" ], "type": "object", "x-akamai": { "file-path": "schemas/page-info.yaml" } } }, "required": [ "dataRows", "pageInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-events-details-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report threat event details", "tags": [ "Threat events" ] }, "parameters": [ { "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/threat-events-details.yaml", "path-info": "/configs/{configId}/threat-events/details" } }, "/configs/{configId}/threat-events/time-series": { "get": { "description": "Lists threat event totals, aggregated by hour.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-threat-event-time-series" }, "operationId": "get-threat-event-time-series", "parameters": [ { "description": "__Enum__ Optionally filter by a dimension of data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for a complete list.", "in": "query", "name": "dimension", "required": true, "schema": { "enum": [ "domain", "destinationIP", "site", "list", "policy", "action", "category", "confidence", "clientIP", "transportType", "dohAttribution", "sublocationId", "devicePostureRisk", "detectionType", "deviceId", "onrampType", "encryptedInternalClientIP", "encryptedInternalClientName", "encryptedUserName", "deviceOwnerId", "dlpDictionaryId", "dlpPatternId", "dlpFileHash", "fileType", "applicationId", "riskId", "operationId", "threatId", "severityId", "httpRequestMethod", "uri", "proxyDestinationPort", "reason", "l7Protocol", "blockDescription" ], "example": "domain", "type": "string" }, "x-akamai": { "file-path": "parameters/dimension-threat-query.yaml" } }, { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "Filters report data using the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) JSON object. You supply this object as the value after you define the filter parameters.", "in": "query", "name": "filters", "required": true, "schema": { "additionalProperties": false, "description": "Options to filter threat report data. Refer to [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) for complete details.", "example": { "category": { "in": [ 5, 7 ] }, "isAlert": { "nin": [ "false" ] } }, "minProperties": 0, "properties": { "action": { "additionalProperties": false, "description": "Filter report data by action IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "asName": { "additionalProperties": false, "description": "Filter by BGP Autonomous System number.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "blockDescription": { "additionalProperties": false, "description": "Filter report data bydescription.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "category": { "additionalProperties": false, "description": "Filter report data bycategory IDs.", "minProperties": 1, "properties": { "in": { "description": "Numerical filter parameters to include in the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Numerical filter parameters to exclude from the report.", "items": { "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-integer.yaml" } }, "clientIP": { "additionalProperties": false, "description": "Filter report data by client or source IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "clientRequestId": { "additionalProperties": false, "description": "Filter report data by client request IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "confidence": { "additionalProperties": false, "description": "Filter report data byconfidence IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "destinationIP": { "additionalProperties": false, "description": "Filter report data by destination IP.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "detectionType": { "additionalProperties": true, "description": "Filter report data by detection type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `inline`, `lookback`, `offline-dynamic`, or `offline`.", "items": { "enum": [ "inline", "lookback", "offline-dynamic", "offline" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-detection-type.yaml" } }, "deviceId": { "additionalProperties": false, "description": "Filter report data by device ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "deviceOwnerId": { "additionalProperties": false, "description": "Filter report data by device owner ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "devicePostureRisk": { "additionalProperties": false, "description": "Filter report data by device posture risk level.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `low` or `medium`.", "items": { "enum": [ "low", "medium" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-dp-risk.yaml" } }, "dlpDictionaryId": { "additionalProperties": false, "description": "Filter report data by dictionary IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpFileHash": { "additionalProperties": false, "description": "Filter report data by file hashes.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dlpPatternId": { "additionalProperties": false, "description": "Filter report data by DLP pattern ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "dohAttribution": { "additionalProperties": false, "description": "Filter report data by the ID of a device with DNS over HTTPS (DoH) enabled.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "domain": { "additionalProperties": false, "description": "Filter report data by domain.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientIP": { "additionalProperties": false, "description": "Filter report data by internal client IP. Provide the client IP in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedInternalClientName": { "additionalProperties": false, "description": "Filter report data by internal client name. Provide the client name in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedMachineName": { "additionalProperties": false, "description": "Filter report data by machine name reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "encryptedUserName": { "additionalProperties": false, "description": "Filter report data by username, in plain text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "fileType": { "additionalProperties": false, "description": "Filter report data by file type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "hasSinkholeCorrelation": { "additionalProperties": false, "description": "Filter data based on whether the record has security connector-related records.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "type": "boolean" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-boolean.yaml" } }, "hostname": { "additionalProperties": false, "description": "Filter report data by hostname.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "httpRequestMethod": { "additionalProperties": false, "description": "Filter report data by HTTP Request Method.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `PUT`, `POST`, `PATCH`, `OPTIONS`, `HEAD`, `GET`, `DELETE`, or `CONNECT`.", "items": { "enum": [ "PUT", "POST", "PATCH", "OPTIONS", "HEAD", "GET", "DELETE", "CONNECT" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-http-methods.yaml" } }, "internalIP": { "additionalProperties": false, "description": "Filter report data by internal IP reported by security connector.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "isAlert": { "additionalProperties": false, "description": "Filter by whether an alert fired for the event.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "l7Protocol": { "additionalProperties": false, "description": "Filter report data by Layer 7 protocol.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `DNS`, `HTTP`, or `HTTP(s)`.", "items": { "enum": [ "DNS", "HTTP", "HTTP(s)" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-l7protocol.yaml" } }, "list": { "additionalProperties": false, "description": "Filter report data by list IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "onRamp": { "additionalProperties": false, "description": "Filter data based on onramp status. Either `Yes` or `No`.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Either `Yes` or `No`.", "items": { "enum": [ "No", "Yes" ], "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp.yaml" } }, "onRampType": { "additionalProperties": false, "description": "Filter data based on onramp type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Onramp types](https://techdocs.akamai.com/etp-reporting/reference/onramp-types) for a complete list.", "items": { "enum": [ "dns", "etp_client", "etp_offnet_client", "explicit_proxy_http", "explicit_proxy_tls", "http_forwarder", "ipsec_tunnel", "N/A", "onramp_dns", "tpaas" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-onramp-type.yaml" } }, "policy": { "additionalProperties": false, "description": "Filter report data by policy IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "proxyDestinationPort": { "additionalProperties": false, "description": "Filter report data by destination port numbers.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "reason": { "additionalProperties": false, "description": "Filter report data by reason text.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "severityId": { "additionalProperties": false, "description": "Filter report data by severity level. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "items": { "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria-severity.yaml" } }, "sinkholeIP": { "additionalProperties": false, "description": "Filter report data by sinkhole IP address.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "site": { "additionalProperties": false, "description": "Filter report data by site IDs.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sourcePort": { "additionalProperties": false, "description": "Filter report data by source port of traffic.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "sublocationId": { "additionalProperties": false, "description": "Filter report data by sublocation ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "threatId": { "additionalProperties": false, "description": "Filter report data by threat ID.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "transportType": { "additionalProperties": false, "description": "Filter report data by transport type.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } }, "uri": { "additionalProperties": false, "description": "Filter report data by URI.", "minProperties": 1, "properties": { "in": { "description": "Strings containing filter parameters to include in the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "nin": { "description": "Strings containing filter parameters to exclude from the report.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-criteria.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/filters-threats.yaml" } }, "x-akamai": { "file-path": "parameters/filters-query-threat.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "columns": [ { "id": "TIMESTAMP", "name": "TIMESTAMP" }, { "id": "1", "name": "Malware" }, { "id": "3", "name": "C&C" }, { "id": "2441", "name": "DeadStream" }, { "id": "OTHERS", "name": "OTHERS" } ], "rows": [ [ "2023-03-22T10:00:00Z", 0, 3, 0, 0 ], [ "2023-03-22T12:00:00Z", 2, 0, 0, 0 ], [ "2023-03-22T14:00:00Z", 15, 0, 0, 0 ] ] }, "schema": { "additionalProperties": false, "description": "High-level event details including timestamped records with associated event metrics.", "properties": { "columns": { "description": "Configures the time series data columns.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Identifier of column data.", "minLength": 1, "type": "string" }, "name": { "description": "Name of column data.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "rows": { "description": "An array of arrays containing a timestamp followed by event counts.", "items": { "items": { "oneOf": [ { "description": "ISO 8601 timestamp within the requested time frame.", "format": "date-time", "title": "timestamp string", "type": "string" }, { "description": "A count of events matching the timestamp.", "title": "event count", "type": "integer" } ] }, "type": "array" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/common-time-series-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Report threat event time series", "tags": [ "Threat events" ] }, "parameters": [ { "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/threat-events-time-series.yaml", "path-info": "/configs/{configId}/threat-events/time-series" } }, "/configs/{configId}/threats/threat-meta": { "get": { "description": "Returns the threat metadata.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-threat-metadata" }, "operationId": "get-threat-metadata", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "id": "7410", "name": "SideCopy" }, { "id": "7420", "name": "Lazarus Group" } ], "schema": { "description": "Response with details.", "items": { "additionalProperties": false, "description": "Response with details.", "properties": { "id": { "description": "Unique identifier for the response.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/response-id-name.yaml" } }, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/threat-meta-response.yaml" } } } }, "description": "Successful response containing threat metadata." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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": "Get threat metadata report", "tags": [ "Threats" ] }, "parameters": [ { "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/threat-meta.yaml", "path-info": "/configs/{configId}/threats/threat-meta" } }, "/ioc/changes": { "get": { "description": "Lists historical change information for a given record and record type. Omit `startTimeSec` and `endTimeSec` from the request URL to return all available historical information.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-ioc-changes" }, "operationId": "get-ioc-changes", "parameters": [ { "description": "The start time for report data, in epoch seconds.", "in": "query", "name": "startTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/start-time-sec-query.yaml" } }, { "description": "The end time for report data, in epoch seconds.", "in": "query", "name": "endTimeSec", "required": true, "schema": { "example": 1333631700, "type": "integer" }, "x-akamai": { "file-path": "parameters/end-time-sec-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "date": "2017-03-07T00:00:00Z", "description": "First tracked", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2017-03-07T00:00:00Z", "description": "Severity upgraded from Unknown to Suspected Malware", "key": "CONFIDENCE", "listId": "1", "listName": "Malware", "newValue": "Suspected", "oldValue": "Unknown", "recordType": "DOMAIN", "state": "CHANGED" } ], "schema": { "description": "Details of IOC changes for the given domain.", "items": { "additionalProperties": false, "properties": { "date": { "description": "ISO 8601 timestamp marking the record generation.", "type": "string" }, "description": { "description": "Describes the record.", "type": "string" }, "key": { "description": "The IOC context key. Either `REGISTRAR_NAME`, `REGISTRANT_NAME`, `REGISTRANT_ORG`, `CONTACT_EMAIL`, `REGISTRANT_EMAIL`, `REGISTRANT_ADDRESS`, `REGISTRANT_CITY`, `REGISTRANT_STATE`, `REGISTRANT_COUNTRY`, `REGISTRANT_TELEPHONE`, `WHO_IS_SERVER`, `CREATED_ON`, `EXPIRES_ON`, `LAST_UPDATED_ON`, `NAME_SERVER_NAMES`, `NAME_SERVER_IPS`, `CONFIDENCE`, `DESCRIPTION`, `URLS`, `THREAT_ID`, `CATEGORIES`, `AVC_APP_ID`, `AVC_CAT_ID`, `AVC_RISK_ID`, `AVC_OPERATIONS`, `AVC_TAGS`, `AVC_PROXY`, or `AVC_CURATION`.", "enum": [ "REGISTRAR_NAME", "REGISTRANT_NAME", "REGISTRANT_ORG", "CONTACT_EMAIL", "REGISTRANT_EMAIL", "REGISTRANT_ADDRESS", "REGISTRANT_CITY", "REGISTRANT_STATE", "REGISTRANT_COUNTRY", "REGISTRANT_TELEPHONE", "WHO_IS_SERVER", "CREATED_ON", "EXPIRES_ON", "LAST_UPDATED_ON", "NAME_SERVER_NAMES", "NAME_SERVER_IPS", "CONFIDENCE", "DESCRIPTION", "URLS", "THREAT_ID", "CATEGORIES", "AVC_APP_ID", "AVC_CAT_ID", "AVC_RISK_ID", "AVC_OPERATIONS", "AVC_TAGS", "AVC_PROXY", "AVC_CURATION" ], "type": "string" }, "listId": { "description": "The record's unique list identifier.", "type": "string" }, "listName": { "description": "The record's list name.", "type": "string" }, "newDetails": { "description": "The new record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "The category's unique identifier.", "minLength": 0, "type": "string" }, "name": { "description": "The AUP category name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "newValue": { "description": "The record's current categorization name.", "type": "string" }, "oldDetails": { "description": "The old record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minimum": 0, "type": "integer" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "oldValue": { "description": "The record's previous categorization name.", "type": "string" }, "order": { "description": "The record's categorization order.", "type": "string" }, "path": { "description": "The record path.", "type": "string" }, "recordType": { "description": "The record type. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "state": { "description": "The record status. Either `ADDED`, `REMOVED`, `CHANGED`, or `READDED`.", "enum": [ "ADDED", "REMOVED", "CHANGED", "READDED" ], "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/ioc-record-changes.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } } }, "summary": "Get IOC change report", "tags": [ "IOC reports" ] }, "x-akamai": { "file-path": "paths/changes.yaml", "path-info": "/ioc/changes" } }, "/ioc/details": { "get": { "description": "Lists the IOC details for a given domain or IP.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details" }, "operationId": "get-ioc-details", "parameters": [ { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "description": "Whether to include the `iocChanges` array in the response. Defaults to `true`.", "in": "query", "name": "includeChanges", "required": false, "schema": { "default": true, "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-changes-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "iocChanges": [ { "date": "2020-03-31T00:00:00Z", "description": "First tracked", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2020-04-18T00:00:00Z", "description": "No longer tracked", "recordType": "DOMAIN", "state": "REMOVED" } ], "iocInformation": { "badUrls": [ { "badUrls": null, "categoryId": 1, "categoryName": "Malware" } ], "record": "facebook.com", "recordType": "DOMAIN" } }, "schema": { "additionalProperties": false, "description": "IOC changes.", "properties": { "iocChanges": { "description": "IOC changes.", "items": { "additionalProperties": false, "properties": { "date": { "description": "ISO 8601 timestamp marking the record generation.", "type": "string" }, "description": { "description": "Describes the record.", "type": "string" }, "key": { "description": "The IOC context key. Either `REGISTRAR_NAME`, `REGISTRANT_NAME`, `REGISTRANT_ORG`, `CONTACT_EMAIL`, `REGISTRANT_EMAIL`, `REGISTRANT_ADDRESS`, `REGISTRANT_CITY`, `REGISTRANT_STATE`, `REGISTRANT_COUNTRY`, `REGISTRANT_TELEPHONE`, `WHO_IS_SERVER`, `CREATED_ON`, `EXPIRES_ON`, `LAST_UPDATED_ON`, `NAME_SERVER_NAMES`, `NAME_SERVER_IPS`, `CONFIDENCE`, `DESCRIPTION`, `URLS`, `THREAT_ID`, `CATEGORIES`, `AVC_APP_ID`, `AVC_CAT_ID`, `AVC_RISK_ID`, `AVC_OPERATIONS`, `AVC_TAGS`, `AVC_PROXY`, or `AVC_CURATION`.", "enum": [ "REGISTRAR_NAME", "REGISTRANT_NAME", "REGISTRANT_ORG", "CONTACT_EMAIL", "REGISTRANT_EMAIL", "REGISTRANT_ADDRESS", "REGISTRANT_CITY", "REGISTRANT_STATE", "REGISTRANT_COUNTRY", "REGISTRANT_TELEPHONE", "WHO_IS_SERVER", "CREATED_ON", "EXPIRES_ON", "LAST_UPDATED_ON", "NAME_SERVER_NAMES", "NAME_SERVER_IPS", "CONFIDENCE", "DESCRIPTION", "URLS", "THREAT_ID", "CATEGORIES", "AVC_APP_ID", "AVC_CAT_ID", "AVC_RISK_ID", "AVC_OPERATIONS", "AVC_TAGS", "AVC_PROXY", "AVC_CURATION" ], "type": "string" }, "listId": { "description": "The record's unique list identifier.", "type": "string" }, "listName": { "description": "The record's list name.", "type": "string" }, "newDetails": { "description": "The new record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "The category's unique identifier.", "minLength": 0, "type": "string" }, "name": { "description": "The AUP category name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "newValue": { "description": "The record's current categorization name.", "type": "string" }, "oldDetails": { "description": "The old record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minimum": 0, "type": "integer" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "oldValue": { "description": "The record's previous categorization name.", "type": "string" }, "order": { "description": "The record's categorization order.", "type": "string" }, "path": { "description": "The record path.", "type": "string" }, "recordType": { "description": "The record type. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "state": { "description": "The record status. Either `ADDED`, `REMOVED`, `CHANGED`, or `READDED`.", "enum": [ "ADDED", "REMOVED", "CHANGED", "READDED" ], "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/ioc-record-changes.yaml" } }, "iocInformation": { "additionalProperties": false, "description": "Detailed IOC information.", "properties": { "aupCategories": { "description": "IOC information about AUP categorization.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "avcInformation": { "description": "IOC information about AVC categorization.", "items": { "additionalProperties": false, "description": "Details of AVC info related to IOC.", "properties": { "appDescription": { "description": "Description of the AVC app.", "minLength": 1, "type": "string" }, "appId": { "description": "Unique identifier for the application's AVC category.", "minLength": 1, "type": "string" }, "appName": { "description": "The AVC app name.", "minLength": 1, "type": "string" }, "categoryDescription": { "description": "The category description.", "minLength": 1, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "The category name.", "minLength": 1, "type": "string" }, "deprecated": { "description": "Deprecates the AVC app.", "type": "boolean" }, "operationIds": { "description": "List of operation IDs.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "operations": { "description": "List of operations for the IOC AVC event.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for AVC operation.", "minLength": 0, "type": "string" }, "name": { "description": "Name of the AVC operation.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "proxy": { "description": "Enables the proxy.", "type": "boolean" }, "riskDescription": { "description": "The risk category description.", "minLength": 1, "type": "string" }, "riskId": { "description": "A unique identifier for the risk category.", "minLength": 1, "type": "string" }, "riskName": { "description": "The risk category name.", "minLength": 1, "type": "string" }, "uri": { "description": "URI for the AVC category.", "minLength": 1, "type": "string" } }, "required": [ "uri", "appId", "appName", "appDescription", "categoryId", "categoryName", "categoryDescription", "riskId", "riskName", "riskDescription", "proxy", "operations", "operationIds" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-avc-info.yaml" } }, "minItems": 0, "type": "array" }, "badUrls": { "description": "List of bad URLs.", "items": { "additionalProperties": false, "properties": { "badUrls": { "description": "Bad URLs logged as IOCs.", "nullable": true, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "type": "integer" }, "categoryName": { "description": "The name of the IOC category.", "type": "string" } }, "type": "object" }, "minItems": 0, "type": "array" }, "categories": { "description": "Category of the IOC threat.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryInfo": { "description": "Category information for a domain or IP.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 1, "type": "integer" }, "categoryName": { "description": "The name of the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "The name of the confidence level. Either `Suspected` or `Known`.", "minLength": 1, "type": "string" } }, "required": [ "categoryId", "categoryName", "confidenceId", "confidenceName" ], "type": "object" }, "minItems": 0, "type": "array" }, "createDate": { "description": "The registration date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "description": { "description": "A description of the record.", "minLength": 1, "type": "string" }, "expiryDate": { "description": "The expiration date of the domain registration in ISO 8601 format.", "format": "date", "type": "string" }, "knownBadUrls": { "description": "List of known bad URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastModifiedDate": { "description": "The last modified date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "nameServerIPs": { "description": "A list of name server IP addresses for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "nameServerNames": { "description": "A list of name servers for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "record": { "description": "The name of the record.", "minLength": 1, "type": "string" }, "recordType": { "description": "Specifies the type of record. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "registrantAddress": { "description": "The address of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCity": { "description": "The city of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCountry": { "description": "The country of the domain registrant.", "minLength": 1, "type": "string" }, "registrantEmails": { "description": "A list of email addresses for the domain registrant.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "registrantName": { "description": "The name of the domain registrant.", "minLength": 1, "type": "string" }, "registrantOrganization": { "description": "The organization of the domain registrant.", "minLength": 1, "type": "string" }, "registrantState": { "description": "The state of country of the domain registrant.", "minLength": 1, "type": "string" }, "registrarName": { "description": "The name of the domain registrar.", "minLength": 1, "type": "string" }, "suspectedUrls": { "description": "The list of suspected URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "threatInformation": { "description": "List of all IOC threat information.", "items": { "additionalProperties": false, "description": "Threat information properties.", "properties": { "aliases": { "description": "Aliases for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryId": { "description": "Category of the threat.", "minimum": 0, "type": "integer" }, "confidenceId": { "description": "Confidence level for the threat. Use `1` for a suspected item and `2` for a known item. `0` is the default, and indicates an unknown confidence level for the list item.", "enum": [ 0, 1, 2 ], "type": "integer" }, "description": { "description": "Description of the threat.", "minLength": 0, "type": "string" }, "externalLinks": { "description": "External links for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "familyName": { "description": "Threat family name.", "minLength": 0, "type": "string" }, "granularity": { "description": "Granularity of the threat.", "minLength": 0, "type": "string" }, "listId": { "description": "List identifier of the threat.", "minimum": 0, "type": "integer" }, "severityId": { "description": "Threat severity level. Either `0` - Unclassified, `1` - Critical, `2` - High, `3` - Medium, or `4` - Low. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "severityLevel": { "description": "Severity level of the threat. Either `Unclassified`, `Critical`, `High`, `Medium`, or `Low`. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ "Unclassified", "Critical", "High", "Medium", "Low" ], "minLength": 1, "type": "string" }, "threatId": { "description": "Threat identifier.", "minimum": 0, "type": "integer" }, "threatName": { "description": "Threat name.", "example": "Malware", "minLength": 0, "type": "string" } }, "required": [ "severityLevel", "severityId" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-info-details.yaml" } }, "minItems": 0, "type": "array" }, "whoisServer": { "description": "The name of server of the domain registrant.", "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/ioc-information.yaml" } } }, "required": [ "iocChanges", "iocInformation" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-details.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } } }, "summary": "Get IOC details report", "tags": [ "IOC detail reports" ] }, "x-akamai": { "file-path": "paths/ioc-details.yaml", "path-info": "/ioc/details" } }, "/ioc/details/aup": { "get": { "description": "Lists the AUP details for a given domain or IP.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details-aup" }, "operationId": "get-ioc-details-aup", "parameters": [ { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "iocChanges": [ { "date": "2021-05-19T00:00:00Z", "description": "Access Control Category virtual community added", "key": "CATEGORIES", "newDetails": [ { "id": "14", "name": "Virtual Community" } ], "newValue": "Virtual Community", "order": "1", "recordType": "DOMAIN", "state": "ADDED" } ], "iocInformation": { "aupCategories": [ { "id": "14", "name": "Virtual Community" } ], "avcInformation": [], "record": "facebook.com", "recordType": "DOMAIN" } }, "schema": { "additionalProperties": false, "description": "IOC changes.", "properties": { "iocChanges": { "description": "IOC changes.", "items": { "additionalProperties": false, "properties": { "date": { "description": "ISO 8601 timestamp marking the record generation.", "type": "string" }, "description": { "description": "Describes the record.", "type": "string" }, "key": { "description": "The IOC context key. Either `REGISTRAR_NAME`, `REGISTRANT_NAME`, `REGISTRANT_ORG`, `CONTACT_EMAIL`, `REGISTRANT_EMAIL`, `REGISTRANT_ADDRESS`, `REGISTRANT_CITY`, `REGISTRANT_STATE`, `REGISTRANT_COUNTRY`, `REGISTRANT_TELEPHONE`, `WHO_IS_SERVER`, `CREATED_ON`, `EXPIRES_ON`, `LAST_UPDATED_ON`, `NAME_SERVER_NAMES`, `NAME_SERVER_IPS`, `CONFIDENCE`, `DESCRIPTION`, `URLS`, `THREAT_ID`, `CATEGORIES`, `AVC_APP_ID`, `AVC_CAT_ID`, `AVC_RISK_ID`, `AVC_OPERATIONS`, `AVC_TAGS`, `AVC_PROXY`, or `AVC_CURATION`.", "enum": [ "REGISTRAR_NAME", "REGISTRANT_NAME", "REGISTRANT_ORG", "CONTACT_EMAIL", "REGISTRANT_EMAIL", "REGISTRANT_ADDRESS", "REGISTRANT_CITY", "REGISTRANT_STATE", "REGISTRANT_COUNTRY", "REGISTRANT_TELEPHONE", "WHO_IS_SERVER", "CREATED_ON", "EXPIRES_ON", "LAST_UPDATED_ON", "NAME_SERVER_NAMES", "NAME_SERVER_IPS", "CONFIDENCE", "DESCRIPTION", "URLS", "THREAT_ID", "CATEGORIES", "AVC_APP_ID", "AVC_CAT_ID", "AVC_RISK_ID", "AVC_OPERATIONS", "AVC_TAGS", "AVC_PROXY", "AVC_CURATION" ], "type": "string" }, "listId": { "description": "The record's unique list identifier.", "type": "string" }, "listName": { "description": "The record's list name.", "type": "string" }, "newDetails": { "description": "The new record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "The category's unique identifier.", "minLength": 0, "type": "string" }, "name": { "description": "The AUP category name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "newValue": { "description": "The record's current categorization name.", "type": "string" }, "oldDetails": { "description": "The old record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minimum": 0, "type": "integer" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "oldValue": { "description": "The record's previous categorization name.", "type": "string" }, "order": { "description": "The record's categorization order.", "type": "string" }, "path": { "description": "The record path.", "type": "string" }, "recordType": { "description": "The record type. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "state": { "description": "The record status. Either `ADDED`, `REMOVED`, `CHANGED`, or `READDED`.", "enum": [ "ADDED", "REMOVED", "CHANGED", "READDED" ], "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/ioc-record-changes.yaml" } }, "iocInformation": { "additionalProperties": false, "description": "Detailed IOC information.", "properties": { "aupCategories": { "description": "IOC information about AUP categorization.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "avcInformation": { "description": "IOC information about AVC categorization.", "items": { "additionalProperties": false, "description": "Details of AVC info related to IOC.", "properties": { "appDescription": { "description": "Description of the AVC app.", "minLength": 1, "type": "string" }, "appId": { "description": "Unique identifier for the application's AVC category.", "minLength": 1, "type": "string" }, "appName": { "description": "The AVC app name.", "minLength": 1, "type": "string" }, "categoryDescription": { "description": "The category description.", "minLength": 1, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "The category name.", "minLength": 1, "type": "string" }, "deprecated": { "description": "Deprecates the AVC app.", "type": "boolean" }, "operationIds": { "description": "List of operation IDs.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "operations": { "description": "List of operations for the IOC AVC event.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for AVC operation.", "minLength": 0, "type": "string" }, "name": { "description": "Name of the AVC operation.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "proxy": { "description": "Enables the proxy.", "type": "boolean" }, "riskDescription": { "description": "The risk category description.", "minLength": 1, "type": "string" }, "riskId": { "description": "A unique identifier for the risk category.", "minLength": 1, "type": "string" }, "riskName": { "description": "The risk category name.", "minLength": 1, "type": "string" }, "uri": { "description": "URI for the AVC category.", "minLength": 1, "type": "string" } }, "required": [ "uri", "appId", "appName", "appDescription", "categoryId", "categoryName", "categoryDescription", "riskId", "riskName", "riskDescription", "proxy", "operations", "operationIds" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-avc-info.yaml" } }, "minItems": 0, "type": "array" }, "badUrls": { "description": "List of bad URLs.", "items": { "additionalProperties": false, "properties": { "badUrls": { "description": "Bad URLs logged as IOCs.", "nullable": true, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "type": "integer" }, "categoryName": { "description": "The name of the IOC category.", "type": "string" } }, "type": "object" }, "minItems": 0, "type": "array" }, "categories": { "description": "Category of the IOC threat.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryInfo": { "description": "Category information for a domain or IP.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 1, "type": "integer" }, "categoryName": { "description": "The name of the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "The name of the confidence level. Either `Suspected` or `Known`.", "minLength": 1, "type": "string" } }, "required": [ "categoryId", "categoryName", "confidenceId", "confidenceName" ], "type": "object" }, "minItems": 0, "type": "array" }, "createDate": { "description": "The registration date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "description": { "description": "A description of the record.", "minLength": 1, "type": "string" }, "expiryDate": { "description": "The expiration date of the domain registration in ISO 8601 format.", "format": "date", "type": "string" }, "knownBadUrls": { "description": "List of known bad URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastModifiedDate": { "description": "The last modified date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "nameServerIPs": { "description": "A list of name server IP addresses for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "nameServerNames": { "description": "A list of name servers for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "record": { "description": "The name of the record.", "minLength": 1, "type": "string" }, "recordType": { "description": "Specifies the type of record. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "registrantAddress": { "description": "The address of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCity": { "description": "The city of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCountry": { "description": "The country of the domain registrant.", "minLength": 1, "type": "string" }, "registrantEmails": { "description": "A list of email addresses for the domain registrant.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "registrantName": { "description": "The name of the domain registrant.", "minLength": 1, "type": "string" }, "registrantOrganization": { "description": "The organization of the domain registrant.", "minLength": 1, "type": "string" }, "registrantState": { "description": "The state of country of the domain registrant.", "minLength": 1, "type": "string" }, "registrarName": { "description": "The name of the domain registrar.", "minLength": 1, "type": "string" }, "suspectedUrls": { "description": "The list of suspected URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "threatInformation": { "description": "List of all IOC threat information.", "items": { "additionalProperties": false, "description": "Threat information properties.", "properties": { "aliases": { "description": "Aliases for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryId": { "description": "Category of the threat.", "minimum": 0, "type": "integer" }, "confidenceId": { "description": "Confidence level for the threat. Use `1` for a suspected item and `2` for a known item. `0` is the default, and indicates an unknown confidence level for the list item.", "enum": [ 0, 1, 2 ], "type": "integer" }, "description": { "description": "Description of the threat.", "minLength": 0, "type": "string" }, "externalLinks": { "description": "External links for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "familyName": { "description": "Threat family name.", "minLength": 0, "type": "string" }, "granularity": { "description": "Granularity of the threat.", "minLength": 0, "type": "string" }, "listId": { "description": "List identifier of the threat.", "minimum": 0, "type": "integer" }, "severityId": { "description": "Threat severity level. Either `0` - Unclassified, `1` - Critical, `2` - High, `3` - Medium, or `4` - Low. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "severityLevel": { "description": "Severity level of the threat. Either `Unclassified`, `Critical`, `High`, `Medium`, or `Low`. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ "Unclassified", "Critical", "High", "Medium", "Low" ], "minLength": 1, "type": "string" }, "threatId": { "description": "Threat identifier.", "minimum": 0, "type": "integer" }, "threatName": { "description": "Threat name.", "example": "Malware", "minLength": 0, "type": "string" } }, "required": [ "severityLevel", "severityId" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-info-details.yaml" } }, "minItems": 0, "type": "array" }, "whoisServer": { "description": "The name of server of the domain registrant.", "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/ioc-information.yaml" } } }, "required": [ "iocChanges", "iocInformation" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-details.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } } }, "summary": "Get IOC AUP detail report", "tags": [ "IOC detail reports" ] }, "x-akamai": { "file-path": "paths/aup.yaml", "path-info": "/ioc/details/aup" } }, "/ioc/details/avc": { "get": { "description": "Lists the AVC details for a given domain or IP.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details-avc" }, "operationId": "get-ioc-details-avc", "parameters": [ { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "iocChanges": [ { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "1", "path": "facebook.com", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "2", "path": "facebook.com", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations none added to facebook.com", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "99", "name": "None" } ], "newValue": "None", "order": "4", "path": "facebook.com", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com", "key": "AVC_PROXY", "newValue": "true", "order": "5", "path": "facebook.com", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk very high added to facebook.com", "key": "AVC_RISK_ID", "newDetails": [ { "id": "4", "name": "Very High" } ], "newValue": "Very High", "order": "6", "path": "facebook.com", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/**/search", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "7", "path": "facebook.com/**/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/**/search", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "8", "path": "facebook.com/**/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations searching added to facebook.com/**/search", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "14", "name": "Searching" } ], "newValue": "Searching", "order": "10", "path": "facebook.com/**/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/**/search", "key": "AVC_PROXY", "newValue": "true", "order": "11", "path": "facebook.com/**/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk medium added to facebook.com/**/search", "key": "AVC_RISK_ID", "newDetails": [ { "id": "2", "name": "Medium" } ], "newValue": "Medium", "order": "12", "path": "facebook.com/**/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/*/searches", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "13", "path": "facebook.com/*/searches", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/*/searches", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "14", "path": "facebook.com/*/searches", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations searching added to facebook.com/*/searches", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "14", "name": "Searching" } ], "newValue": "Searching", "order": "16", "path": "facebook.com/*/searches", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/*/searches", "key": "AVC_PROXY", "newValue": "true", "order": "17", "path": "facebook.com/*/searches", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk medium added to facebook.com/*/searches", "key": "AVC_RISK_ID", "newDetails": [ { "id": "2", "name": "Medium" } ], "newValue": "Medium", "order": "18", "path": "facebook.com/*/searches", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/ajax", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "19", "path": "facebook.com/ajax", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/ajax", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "20", "path": "facebook.com/ajax", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations none added to facebook.com/ajax", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "99", "name": "None" } ], "newValue": "None", "order": "22", "path": "facebook.com/ajax", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/ajax", "key": "AVC_PROXY", "newValue": "true", "order": "23", "path": "facebook.com/ajax", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk very high added to facebook.com/ajax", "key": "AVC_RISK_ID", "newDetails": [ { "id": "4", "name": "Very High" } ], "newValue": "Very High", "order": "24", "path": "facebook.com/ajax", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/ajax/mercury/upload", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "25", "path": "facebook.com/ajax/mercury/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/ajax/mercury/upload", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "26", "path": "facebook.com/ajax/mercury/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations uploading added to facebook.com/ajax/mercury/upload", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "1", "name": "Uploading" } ], "newValue": "Uploading", "order": "28", "path": "facebook.com/ajax/mercury/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/ajax/mercury/upload", "key": "AVC_PROXY", "newValue": "true", "order": "29", "path": "facebook.com/ajax/mercury/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk very high added to facebook.com/ajax/mercury/upload", "key": "AVC_RISK_ID", "newDetails": [ { "id": "4", "name": "Very High" } ], "newValue": "Very High", "order": "30", "path": "facebook.com/ajax/mercury/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/ajax/video/upload", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "31", "path": "facebook.com/ajax/video/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/ajax/video/upload", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "32", "path": "facebook.com/ajax/video/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations uploading added to facebook.com/ajax/video/upload", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "1", "name": "Uploading" } ], "newValue": "Uploading", "order": "34", "path": "facebook.com/ajax/video/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/ajax/video/upload", "key": "AVC_PROXY", "newValue": "true", "order": "35", "path": "facebook.com/ajax/video/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk very high added to facebook.com/ajax/video/upload", "key": "AVC_RISK_ID", "newDetails": [ { "id": "4", "name": "Very High" } ], "newValue": "Very High", "order": "36", "path": "facebook.com/ajax/video/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/api/graphql", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "37", "path": "facebook.com/api/graphql", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/api/graphql", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "38", "path": "facebook.com/api/graphql", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations none added to facebook.com/api/graphql", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "99", "name": "None" } ], "newValue": "None", "order": "40", "path": "facebook.com/api/graphql", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/api/graphql", "key": "AVC_PROXY", "newValue": "true", "order": "41", "path": "facebook.com/api/graphql", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk very high added to facebook.com/api/graphql", "key": "AVC_RISK_ID", "newDetails": [ { "id": "4", "name": "Very High" } ], "newValue": "Very High", "order": "42", "path": "facebook.com/api/graphql", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/chat", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "43", "path": "facebook.com/chat", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/chat", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "44", "path": "facebook.com/chat", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations chatting added to facebook.com/chat", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "7", "name": "Chatting" } ], "newValue": "Chatting", "order": "46", "path": "facebook.com/chat", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/chat", "key": "AVC_PROXY", "newValue": "true", "order": "47", "path": "facebook.com/chat", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk high added to facebook.com/chat", "key": "AVC_RISK_ID", "newDetails": [ { "id": "3", "name": "High" } ], "newValue": "High", "order": "48", "path": "facebook.com/chat", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/jobsearch", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "49", "path": "facebook.com/jobsearch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/jobsearch", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "50", "path": "facebook.com/jobsearch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations searching added to facebook.com/jobsearch", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "14", "name": "Searching" } ], "newValue": "Searching", "order": "52", "path": "facebook.com/jobsearch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/jobsearch", "key": "AVC_PROXY", "newValue": "true", "order": "53", "path": "facebook.com/jobsearch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk medium added to facebook.com/jobsearch", "key": "AVC_RISK_ID", "newDetails": [ { "id": "2", "name": "Medium" } ], "newValue": "Medium", "order": "54", "path": "facebook.com/jobsearch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/login", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "55", "path": "facebook.com/login", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/login", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "56", "path": "facebook.com/login", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations login/authentication added to facebook.com/login", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "15", "name": "Login/Authentication" } ], "newValue": "Login/Authentication", "order": "58", "path": "facebook.com/login", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/login", "key": "AVC_PROXY", "newValue": "true", "order": "59", "path": "facebook.com/login", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk low added to facebook.com/login", "key": "AVC_RISK_ID", "newDetails": [ { "id": "1", "name": "Low" } ], "newValue": "Low", "order": "60", "path": "facebook.com/login", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/login/", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "61", "path": "facebook.com/login/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/login/", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "62", "path": "facebook.com/login/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations login/authentication added to facebook.com/login/", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "15", "name": "Login/Authentication" } ], "newValue": "Login/Authentication", "order": "64", "path": "facebook.com/login/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/login/", "key": "AVC_PROXY", "newValue": "true", "order": "65", "path": "facebook.com/login/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk low added to facebook.com/login/", "key": "AVC_RISK_ID", "newDetails": [ { "id": "1", "name": "Low" } ], "newValue": "Low", "order": "66", "path": "facebook.com/login/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/profile/picture/upload", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "67", "path": "facebook.com/profile/picture/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/profile/picture/upload", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "68", "path": "facebook.com/profile/picture/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations uploading added to facebook.com/profile/picture/upload", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "1", "name": "Uploading" } ], "newValue": "Uploading", "order": "70", "path": "facebook.com/profile/picture/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/profile/picture/upload", "key": "AVC_PROXY", "newValue": "true", "order": "71", "path": "facebook.com/profile/picture/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk very high added to facebook.com/profile/picture/upload", "key": "AVC_RISK_ID", "newDetails": [ { "id": "4", "name": "Very High" } ], "newValue": "Very High", "order": "72", "path": "facebook.com/profile/picture/upload", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/search", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "73", "path": "facebook.com/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/search", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "74", "path": "facebook.com/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations searching added to facebook.com/search", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "14", "name": "Searching" } ], "newValue": "Searching", "order": "76", "path": "facebook.com/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/search", "key": "AVC_PROXY", "newValue": "true", "order": "77", "path": "facebook.com/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk medium added to facebook.com/search", "key": "AVC_RISK_ID", "newDetails": [ { "id": "2", "name": "Medium" } ], "newValue": "Medium", "order": "78", "path": "facebook.com/search", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/video/unified_cvc/", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "79", "path": "facebook.com/video/unified_cvc/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/video/unified_cvc/", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "80", "path": "facebook.com/video/unified_cvc/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations viewing contents added to facebook.com/video/unified_cvc/", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "6", "name": "Viewing Contents" } ], "newValue": "Viewing Contents", "order": "82", "path": "facebook.com/video/unified_cvc/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/video/unified_cvc/", "key": "AVC_PROXY", "newValue": "true", "order": "83", "path": "facebook.com/video/unified_cvc/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk low added to facebook.com/video/unified_cvc/", "key": "AVC_RISK_ID", "newDetails": [ { "id": "1", "name": "Low" } ], "newValue": "Low", "order": "84", "path": "facebook.com/video/unified_cvc/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/videocall", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "85", "path": "facebook.com/videocall", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/videocall", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "86", "path": "facebook.com/videocall", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations calling added to facebook.com/videocall", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "13", "name": "Calling" } ], "newValue": "Calling", "order": "88", "path": "facebook.com/videocall", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/videocall", "key": "AVC_PROXY", "newValue": "true", "order": "89", "path": "facebook.com/videocall", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk high added to facebook.com/videocall", "key": "AVC_RISK_ID", "newDetails": [ { "id": "3", "name": "High" } ], "newValue": "High", "order": "90", "path": "facebook.com/videocall", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/videocall/", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "91", "path": "facebook.com/videocall/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/videocall/", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "92", "path": "facebook.com/videocall/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations calling added to facebook.com/videocall/", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "13", "name": "Calling" } ], "newValue": "Calling", "order": "94", "path": "facebook.com/videocall/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/videocall/", "key": "AVC_PROXY", "newValue": "true", "order": "95", "path": "facebook.com/videocall/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk high added to facebook.com/videocall/", "key": "AVC_RISK_ID", "newDetails": [ { "id": "3", "name": "High" } ], "newValue": "High", "order": "96", "path": "facebook.com/videocall/", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application facebook added to facebook.com/watch", "key": "AVC_APP_ID", "newDetails": [ { "id": "115", "name": "Facebook" } ], "newValue": "Facebook", "order": "97", "path": "facebook.com/watch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Category hacking added to facebook.com/watch", "key": "AVC_CAT_ID", "newDetails": [ { "id": "33", "name": "Hacking" } ], "newValue": "Hacking", "order": "98", "path": "facebook.com/watch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Operations viewing contents added to facebook.com/watch", "key": "AVC_OPERATIONS", "newDetails": [ { "id": "6", "name": "Viewing Contents" } ], "newValue": "Viewing Contents", "order": "100", "path": "facebook.com/watch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Proxy true added to facebook.com/watch", "key": "AVC_PROXY", "newValue": "true", "order": "101", "path": "facebook.com/watch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-23T00:00:00Z", "description": "Application Risk low added to facebook.com/watch", "key": "AVC_RISK_ID", "newDetails": [ { "id": "1", "name": "Low" } ], "newValue": "Low", "order": "102", "path": "facebook.com/watch", "recordType": "DOMAIN", "state": "ADDED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "103", "path": "facebook.com", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/**/search", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "104", "path": "facebook.com/**/search", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/*/searches", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "105", "path": "facebook.com/*/searches", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/ajax", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "106", "path": "facebook.com/ajax", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/ajax/mercury/upload", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "107", "path": "facebook.com/ajax/mercury/upload", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/ajax/video/upload", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "108", "path": "facebook.com/ajax/video/upload", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/api/graphql", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "109", "path": "facebook.com/api/graphql", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/chat", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "110", "path": "facebook.com/chat", "recordType": "DOMAIN", "state": "CHANGED" }, { "date": "2021-08-30T00:00:00Z", "description": "from true to false Application Proxy changed from true to false for facebook.com/jobsearch", "key": "AVC_PROXY", "newValue": "false", "oldValue": "true", "order": "111", "path": "facebook.com/jobsearch", "recordType": "DOMAIN", "state": "CHANGED" } ], "iocInformation": { "avcInformation": [ { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 13 ], "operations": [ { "id": "13", "name": "Calling" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "3", "riskName": "Very High", "uri": "facebook.com/videocall/" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 13 ], "operations": [ { "id": "13", "name": "Calling" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "3", "riskName": "Very High", "uri": "facebook.com/videocall" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 99 ], "operations": [ { "id": "99", "name": "None" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "4", "riskName": "Very High", "uri": "facebook.com/api/graphql" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 99 ], "operations": [ { "id": "99", "name": "None" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "4", "riskName": "Very High", "uri": "facebook.com/ajax" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 15 ], "operations": [ { "id": "15", "name": "Login/Authentication" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "1", "riskName": "Very High", "uri": "facebook.com/login" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 14 ], "operations": [ { "id": "14", "name": "Searching" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "2", "riskName": "Very High", "uri": "facebook.com/*/searches" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 14 ], "operations": [ { "id": "14", "name": "Searching" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "2", "riskName": "Very High", "uri": "facebook.com/jobsearch" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 14 ], "operations": [ { "id": "14", "name": "Searching" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "2", "riskName": "Very High", "uri": "facebook.com/**/search" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 14 ], "operations": [ { "id": "14", "name": "Searching" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "2", "riskName": "Very High", "uri": "facebook.com/search" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 15 ], "operations": [ { "id": "15", "name": "Login/Authentication" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "1", "riskName": "Very High", "uri": "facebook.com/login/" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 1 ], "operations": [ { "id": "1", "name": "Uploading" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "4", "riskName": "Very High", "uri": "facebook.com/ajax/mercury/upload" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 6 ], "operations": [ { "id": "6", "name": "Viewing Contents" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "1", "riskName": "Very High", "uri": "facebook.com/watch" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 99 ], "operations": [ { "id": "99", "name": "None" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "4", "riskName": "Very High", "uri": "facebook.com" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 6 ], "operations": [ { "id": "6", "name": "Viewing Contents" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "1", "riskName": "Very High", "uri": "facebook.com/video/unified_cvc/" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 1 ], "operations": [ { "id": "1", "name": "Uploading" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "4", "riskName": "Very High", "uri": "facebook.com/profile/picture/upload" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 7 ], "operations": [ { "id": "7", "name": "Chatting" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "3", "riskName": "Very High", "uri": "facebook.com/chat" }, { "appDescription": "Facebook is the world's largest social networking service operated by Facebook, Inc.", "appId": "115", "appName": "Facebook", "categoryDescription": "Websites that promote social networking and have online communities where users interact and communicate with one another. ", "categoryId": "33", "categoryName": "Virtual Community", "deprecated": false, "operationIds": [ 1 ], "operations": [ { "id": "1", "name": "Uploading" } ], "proxy": false, "riskDescription": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "riskId": "4", "riskName": "Very High", "uri": "facebook.com/ajax/video/upload" } ], "record": "facebook.com", "recordType": "DOMAIN" } }, "schema": { "additionalProperties": false, "description": "IOC changes.", "properties": { "iocChanges": { "description": "IOC changes.", "items": { "additionalProperties": false, "properties": { "date": { "description": "ISO 8601 timestamp marking the record generation.", "type": "string" }, "description": { "description": "Describes the record.", "type": "string" }, "key": { "description": "The IOC context key. Either `REGISTRAR_NAME`, `REGISTRANT_NAME`, `REGISTRANT_ORG`, `CONTACT_EMAIL`, `REGISTRANT_EMAIL`, `REGISTRANT_ADDRESS`, `REGISTRANT_CITY`, `REGISTRANT_STATE`, `REGISTRANT_COUNTRY`, `REGISTRANT_TELEPHONE`, `WHO_IS_SERVER`, `CREATED_ON`, `EXPIRES_ON`, `LAST_UPDATED_ON`, `NAME_SERVER_NAMES`, `NAME_SERVER_IPS`, `CONFIDENCE`, `DESCRIPTION`, `URLS`, `THREAT_ID`, `CATEGORIES`, `AVC_APP_ID`, `AVC_CAT_ID`, `AVC_RISK_ID`, `AVC_OPERATIONS`, `AVC_TAGS`, `AVC_PROXY`, or `AVC_CURATION`.", "enum": [ "REGISTRAR_NAME", "REGISTRANT_NAME", "REGISTRANT_ORG", "CONTACT_EMAIL", "REGISTRANT_EMAIL", "REGISTRANT_ADDRESS", "REGISTRANT_CITY", "REGISTRANT_STATE", "REGISTRANT_COUNTRY", "REGISTRANT_TELEPHONE", "WHO_IS_SERVER", "CREATED_ON", "EXPIRES_ON", "LAST_UPDATED_ON", "NAME_SERVER_NAMES", "NAME_SERVER_IPS", "CONFIDENCE", "DESCRIPTION", "URLS", "THREAT_ID", "CATEGORIES", "AVC_APP_ID", "AVC_CAT_ID", "AVC_RISK_ID", "AVC_OPERATIONS", "AVC_TAGS", "AVC_PROXY", "AVC_CURATION" ], "type": "string" }, "listId": { "description": "The record's unique list identifier.", "type": "string" }, "listName": { "description": "The record's list name.", "type": "string" }, "newDetails": { "description": "The new record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "The category's unique identifier.", "minLength": 0, "type": "string" }, "name": { "description": "The AUP category name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "newValue": { "description": "The record's current categorization name.", "type": "string" }, "oldDetails": { "description": "The old record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minimum": 0, "type": "integer" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "oldValue": { "description": "The record's previous categorization name.", "type": "string" }, "order": { "description": "The record's categorization order.", "type": "string" }, "path": { "description": "The record path.", "type": "string" }, "recordType": { "description": "The record type. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "state": { "description": "The record status. Either `ADDED`, `REMOVED`, `CHANGED`, or `READDED`.", "enum": [ "ADDED", "REMOVED", "CHANGED", "READDED" ], "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/ioc-record-changes.yaml" } }, "iocInformation": { "additionalProperties": false, "description": "Detailed IOC information.", "properties": { "aupCategories": { "description": "IOC information about AUP categorization.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "avcInformation": { "description": "IOC information about AVC categorization.", "items": { "additionalProperties": false, "description": "Details of AVC info related to IOC.", "properties": { "appDescription": { "description": "Description of the AVC app.", "minLength": 1, "type": "string" }, "appId": { "description": "Unique identifier for the application's AVC category.", "minLength": 1, "type": "string" }, "appName": { "description": "The AVC app name.", "minLength": 1, "type": "string" }, "categoryDescription": { "description": "The category description.", "minLength": 1, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "The category name.", "minLength": 1, "type": "string" }, "deprecated": { "description": "Deprecates the AVC app.", "type": "boolean" }, "operationIds": { "description": "List of operation IDs.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "operations": { "description": "List of operations for the IOC AVC event.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for AVC operation.", "minLength": 0, "type": "string" }, "name": { "description": "Name of the AVC operation.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "proxy": { "description": "Enables the proxy.", "type": "boolean" }, "riskDescription": { "description": "The risk category description.", "minLength": 1, "type": "string" }, "riskId": { "description": "A unique identifier for the risk category.", "minLength": 1, "type": "string" }, "riskName": { "description": "The risk category name.", "minLength": 1, "type": "string" }, "uri": { "description": "URI for the AVC category.", "minLength": 1, "type": "string" } }, "required": [ "uri", "appId", "appName", "appDescription", "categoryId", "categoryName", "categoryDescription", "riskId", "riskName", "riskDescription", "proxy", "operations", "operationIds" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-avc-info.yaml" } }, "minItems": 0, "type": "array" }, "badUrls": { "description": "List of bad URLs.", "items": { "additionalProperties": false, "properties": { "badUrls": { "description": "Bad URLs logged as IOCs.", "nullable": true, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "type": "integer" }, "categoryName": { "description": "The name of the IOC category.", "type": "string" } }, "type": "object" }, "minItems": 0, "type": "array" }, "categories": { "description": "Category of the IOC threat.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryInfo": { "description": "Category information for a domain or IP.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 1, "type": "integer" }, "categoryName": { "description": "The name of the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "The name of the confidence level. Either `Suspected` or `Known`.", "minLength": 1, "type": "string" } }, "required": [ "categoryId", "categoryName", "confidenceId", "confidenceName" ], "type": "object" }, "minItems": 0, "type": "array" }, "createDate": { "description": "The registration date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "description": { "description": "A description of the record.", "minLength": 1, "type": "string" }, "expiryDate": { "description": "The expiration date of the domain registration in ISO 8601 format.", "format": "date", "type": "string" }, "knownBadUrls": { "description": "List of known bad URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastModifiedDate": { "description": "The last modified date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "nameServerIPs": { "description": "A list of name server IP addresses for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "nameServerNames": { "description": "A list of name servers for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "record": { "description": "The name of the record.", "minLength": 1, "type": "string" }, "recordType": { "description": "Specifies the type of record. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "registrantAddress": { "description": "The address of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCity": { "description": "The city of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCountry": { "description": "The country of the domain registrant.", "minLength": 1, "type": "string" }, "registrantEmails": { "description": "A list of email addresses for the domain registrant.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "registrantName": { "description": "The name of the domain registrant.", "minLength": 1, "type": "string" }, "registrantOrganization": { "description": "The organization of the domain registrant.", "minLength": 1, "type": "string" }, "registrantState": { "description": "The state of country of the domain registrant.", "minLength": 1, "type": "string" }, "registrarName": { "description": "The name of the domain registrar.", "minLength": 1, "type": "string" }, "suspectedUrls": { "description": "The list of suspected URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "threatInformation": { "description": "List of all IOC threat information.", "items": { "additionalProperties": false, "description": "Threat information properties.", "properties": { "aliases": { "description": "Aliases for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryId": { "description": "Category of the threat.", "minimum": 0, "type": "integer" }, "confidenceId": { "description": "Confidence level for the threat. Use `1` for a suspected item and `2` for a known item. `0` is the default, and indicates an unknown confidence level for the list item.", "enum": [ 0, 1, 2 ], "type": "integer" }, "description": { "description": "Description of the threat.", "minLength": 0, "type": "string" }, "externalLinks": { "description": "External links for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "familyName": { "description": "Threat family name.", "minLength": 0, "type": "string" }, "granularity": { "description": "Granularity of the threat.", "minLength": 0, "type": "string" }, "listId": { "description": "List identifier of the threat.", "minimum": 0, "type": "integer" }, "severityId": { "description": "Threat severity level. Either `0` - Unclassified, `1` - Critical, `2` - High, `3` - Medium, or `4` - Low. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "severityLevel": { "description": "Severity level of the threat. Either `Unclassified`, `Critical`, `High`, `Medium`, or `Low`. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ "Unclassified", "Critical", "High", "Medium", "Low" ], "minLength": 1, "type": "string" }, "threatId": { "description": "Threat identifier.", "minimum": 0, "type": "integer" }, "threatName": { "description": "Threat name.", "example": "Malware", "minLength": 0, "type": "string" } }, "required": [ "severityLevel", "severityId" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-info-details.yaml" } }, "minItems": 0, "type": "array" }, "whoisServer": { "description": "The name of server of the domain registrant.", "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/ioc-information.yaml" } } }, "required": [ "iocChanges", "iocInformation" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-details.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } } }, "summary": "Get IOC AVC details report", "tags": [ "IOC reports" ] }, "x-akamai": { "file-path": "paths/avc.yaml", "path-info": "/ioc/details/avc" } }, "/ioc/details/cidr": { "get": { "description": "Lists the CIDR details for a given domain or IP.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-ioc-details-cidr" }, "operationId": "get-ioc-details-cidr", "parameters": [ { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "iocChanges": [ { "date": "2023-05-02T16:17:07Z", "description": "", "key": "CONFIDENCE", "listId": "1", "listName": "Malware", "newValue": "Known", "oldValue": "Unknown", "recordType": "IP", "state": "ADDED" }, { "date": "2023-05-02T16:17:07Z", "description": "", "key": "THREAT_ID", "listId": "1", "listName": "Malware", "newValue": "5070", "recordType": "IP", "state": "ADDED" } ], "iocInformation": { "categories": [ "Malware" ], "categoryInfo": [ { "categoryId": 1, "categoryName": "Malware", "confidenceId": 2, "confidenceName": "Known" } ], "description": "This ip is used as malware", "record": "192.0.2.10/24", "recordType": "IP", "threatInformation": [ { "severityId": 2, "severityLevel": "High", "threatId": 5070, "threatName": "Known Malware" } ] } }, "schema": { "additionalProperties": false, "description": "IOC changes.", "properties": { "iocChanges": { "description": "IOC changes.", "items": { "additionalProperties": false, "properties": { "date": { "description": "ISO 8601 timestamp marking the record generation.", "type": "string" }, "description": { "description": "Describes the record.", "type": "string" }, "key": { "description": "The IOC context key. Either `REGISTRAR_NAME`, `REGISTRANT_NAME`, `REGISTRANT_ORG`, `CONTACT_EMAIL`, `REGISTRANT_EMAIL`, `REGISTRANT_ADDRESS`, `REGISTRANT_CITY`, `REGISTRANT_STATE`, `REGISTRANT_COUNTRY`, `REGISTRANT_TELEPHONE`, `WHO_IS_SERVER`, `CREATED_ON`, `EXPIRES_ON`, `LAST_UPDATED_ON`, `NAME_SERVER_NAMES`, `NAME_SERVER_IPS`, `CONFIDENCE`, `DESCRIPTION`, `URLS`, `THREAT_ID`, `CATEGORIES`, `AVC_APP_ID`, `AVC_CAT_ID`, `AVC_RISK_ID`, `AVC_OPERATIONS`, `AVC_TAGS`, `AVC_PROXY`, or `AVC_CURATION`.", "enum": [ "REGISTRAR_NAME", "REGISTRANT_NAME", "REGISTRANT_ORG", "CONTACT_EMAIL", "REGISTRANT_EMAIL", "REGISTRANT_ADDRESS", "REGISTRANT_CITY", "REGISTRANT_STATE", "REGISTRANT_COUNTRY", "REGISTRANT_TELEPHONE", "WHO_IS_SERVER", "CREATED_ON", "EXPIRES_ON", "LAST_UPDATED_ON", "NAME_SERVER_NAMES", "NAME_SERVER_IPS", "CONFIDENCE", "DESCRIPTION", "URLS", "THREAT_ID", "CATEGORIES", "AVC_APP_ID", "AVC_CAT_ID", "AVC_RISK_ID", "AVC_OPERATIONS", "AVC_TAGS", "AVC_PROXY", "AVC_CURATION" ], "type": "string" }, "listId": { "description": "The record's unique list identifier.", "type": "string" }, "listName": { "description": "The record's list name.", "type": "string" }, "newDetails": { "description": "The new record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "The category's unique identifier.", "minLength": 0, "type": "string" }, "name": { "description": "The AUP category name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "newValue": { "description": "The record's current categorization name.", "type": "string" }, "oldDetails": { "description": "The old record categorization details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minimum": 0, "type": "integer" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "oldValue": { "description": "The record's previous categorization name.", "type": "string" }, "order": { "description": "The record's categorization order.", "type": "string" }, "path": { "description": "The record path.", "type": "string" }, "recordType": { "description": "The record type. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "state": { "description": "The record status. Either `ADDED`, `REMOVED`, `CHANGED`, or `READDED`.", "enum": [ "ADDED", "REMOVED", "CHANGED", "READDED" ], "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/ioc-record-changes.yaml" } }, "iocInformation": { "additionalProperties": false, "description": "Detailed IOC information.", "properties": { "aupCategories": { "description": "IOC information about AUP categorization.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for the category.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the AUP category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "avcInformation": { "description": "IOC information about AVC categorization.", "items": { "additionalProperties": false, "description": "Details of AVC info related to IOC.", "properties": { "appDescription": { "description": "Description of the AVC app.", "minLength": 1, "type": "string" }, "appId": { "description": "Unique identifier for the application's AVC category.", "minLength": 1, "type": "string" }, "appName": { "description": "The AVC app name.", "minLength": 1, "type": "string" }, "categoryDescription": { "description": "The category description.", "minLength": 1, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "minLength": 1, "type": "string" }, "categoryName": { "description": "The category name.", "minLength": 1, "type": "string" }, "deprecated": { "description": "Deprecates the AVC app.", "type": "boolean" }, "operationIds": { "description": "List of operation IDs.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "operations": { "description": "List of operations for the IOC AVC event.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier for AVC operation.", "minLength": 0, "type": "string" }, "name": { "description": "Name of the AVC operation.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "proxy": { "description": "Enables the proxy.", "type": "boolean" }, "riskDescription": { "description": "The risk category description.", "minLength": 1, "type": "string" }, "riskId": { "description": "A unique identifier for the risk category.", "minLength": 1, "type": "string" }, "riskName": { "description": "The risk category name.", "minLength": 1, "type": "string" }, "uri": { "description": "URI for the AVC category.", "minLength": 1, "type": "string" } }, "required": [ "uri", "appId", "appName", "appDescription", "categoryId", "categoryName", "categoryDescription", "riskId", "riskName", "riskDescription", "proxy", "operations", "operationIds" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-avc-info.yaml" } }, "minItems": 0, "type": "array" }, "badUrls": { "description": "List of bad URLs.", "items": { "additionalProperties": false, "properties": { "badUrls": { "description": "Bad URLs logged as IOCs.", "nullable": true, "type": "string" }, "categoryId": { "description": "A unique identifier for the category.", "type": "integer" }, "categoryName": { "description": "The name of the IOC category.", "type": "string" } }, "type": "object" }, "minItems": 0, "type": "array" }, "categories": { "description": "Category of the IOC threat.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryInfo": { "description": "Category information for a domain or IP.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "A unique identifier for the category.", "minimum": 1, "type": "integer" }, "categoryName": { "description": "The name of the category.", "minLength": 1, "type": "string" }, "confidenceId": { "description": "The confidence level of the list entry. Either `0` for unknown, `1` for suspected, or `2` for known.", "enum": [ 0, 1, 2 ], "type": "integer" }, "confidenceName": { "description": "The name of the confidence level. Either `Suspected` or `Known`.", "minLength": 1, "type": "string" } }, "required": [ "categoryId", "categoryName", "confidenceId", "confidenceName" ], "type": "object" }, "minItems": 0, "type": "array" }, "createDate": { "description": "The registration date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "description": { "description": "A description of the record.", "minLength": 1, "type": "string" }, "expiryDate": { "description": "The expiration date of the domain registration in ISO 8601 format.", "format": "date", "type": "string" }, "knownBadUrls": { "description": "List of known bad URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastModifiedDate": { "description": "The last modified date of the domain in ISO 8601 format.", "format": "date", "type": "string" }, "nameServerIPs": { "description": "A list of name server IP addresses for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "nameServerNames": { "description": "A list of name servers for a domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "record": { "description": "The name of the record.", "minLength": 1, "type": "string" }, "recordType": { "description": "Specifies the type of record. Either `DOMAIN` or `IP`.", "enum": [ "DOMAIN", "IP" ], "type": "string" }, "registrantAddress": { "description": "The address of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCity": { "description": "The city of the domain registrant.", "minLength": 1, "type": "string" }, "registrantCountry": { "description": "The country of the domain registrant.", "minLength": 1, "type": "string" }, "registrantEmails": { "description": "A list of email addresses for the domain registrant.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "registrantName": { "description": "The name of the domain registrant.", "minLength": 1, "type": "string" }, "registrantOrganization": { "description": "The organization of the domain registrant.", "minLength": 1, "type": "string" }, "registrantState": { "description": "The state of country of the domain registrant.", "minLength": 1, "type": "string" }, "registrarName": { "description": "The name of the domain registrar.", "minLength": 1, "type": "string" }, "suspectedUrls": { "description": "The list of suspected URLs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "threatInformation": { "description": "List of all IOC threat information.", "items": { "additionalProperties": false, "description": "Threat information properties.", "properties": { "aliases": { "description": "Aliases for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "categoryId": { "description": "Category of the threat.", "minimum": 0, "type": "integer" }, "confidenceId": { "description": "Confidence level for the threat. Use `1` for a suspected item and `2` for a known item. `0` is the default, and indicates an unknown confidence level for the list item.", "enum": [ 0, 1, 2 ], "type": "integer" }, "description": { "description": "Description of the threat.", "minLength": 0, "type": "string" }, "externalLinks": { "description": "External links for the domain.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "familyName": { "description": "Threat family name.", "minLength": 0, "type": "string" }, "granularity": { "description": "Granularity of the threat.", "minLength": 0, "type": "string" }, "listId": { "description": "List identifier of the threat.", "minimum": 0, "type": "integer" }, "severityId": { "description": "Threat severity level. Either `0` - Unclassified, `1` - Critical, `2` - High, `3` - Medium, or `4` - Low. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ 0, 1, 2, 3, 4 ], "minimum": 0, "type": "integer" }, "severityLevel": { "description": "Severity level of the threat. Either `Unclassified`, `Critical`, `High`, `Medium`, or `Low`. Refer to [Severity levels](https://techdocs.akamai.com/etp/docs/indicator-search#severity-levels) for more details.", "enum": [ "Unclassified", "Critical", "High", "Medium", "Low" ], "minLength": 1, "type": "string" }, "threatId": { "description": "Threat identifier.", "minimum": 0, "type": "integer" }, "threatName": { "description": "Threat name.", "example": "Malware", "minLength": 0, "type": "string" } }, "required": [ "severityLevel", "severityId" ], "type": "object", "x-akamai": { "file-path": "schemas/threat-info-details.yaml" } }, "minItems": 0, "type": "array" }, "whoisServer": { "description": "The name of server of the domain registrant.", "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/ioc-information.yaml" } } }, "required": [ "iocChanges", "iocInformation" ], "type": "object", "x-akamai": { "file-path": "schemas/ioc-details.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } } }, "summary": "Get IOC CIDR details report", "tags": [ "IOC reports" ] }, "x-akamai": { "file-path": "paths/cidr.yaml", "path-info": "/ioc/details/cidr" } }, "/ioc/domain-tree": { "get": { "description": "Lists the blocklisted domains and IPs matching a given record. Returns an empty list if no domains match.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-ioc-domain-tree" }, "operationId": "get-ioc-domain-tree", "parameters": [ { "description": "__Enum__ Specifies the record type, either `DOMAIN` or `IP`.", "in": "query", "name": "recordType", "required": true, "schema": { "enum": [ "DOMAIN", "IP" ], "example": "DOMAIN", "type": "string" }, "x-akamai": { "file-path": "parameters/record-type-query.yaml" } }, { "description": "The target record from which to get blocklisted domains.", "in": "query", "name": "record", "required": true, "schema": { "example": "facebook.com", "type": "string" }, "x-akamai": { "file-path": "parameters/record-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "aup": [ "facebook.com" ] }, { "avc": [ "facebook.com" ] }, { "blacklist": [ "facebook.com" ] }, { "cidr": [ "192.0.2.17" ] } ], "schema": { "description": "Contains IOC domain tree details.", "items": { "additionalProperties": false, "properties": { "aup": { "description": "Matching domains found in AUP categorization.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "avc": { "description": "Matching domains found in AVC categorization.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "blacklist": { "description": "Matching domains found in Akamai blocklist.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "cidr": { "description": "Matching CIDRs found in Akamai discovered CIDR blocks.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "whois": { "description": "Matching domains in Akamai discovered whois servers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/ioc-domain-tree.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "examples": { "invalid-format": { "summary": "Invalid request format", "value": { "$ref": "../examples/invalid-request-error-400.json" } }, "invalid-start-time": { "summary": "Invalid startTime", "value": { "$ref": "../examples/start-time-invalid-error-400.json" } } }, "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" } } }, "summary": "Get IOC domain tree report", "tags": [ "IOC reports" ] }, "x-akamai": { "file-path": "paths/domain-tree.yaml", "path-info": "/ioc/domain-tree" } }, "/threat-intel/domains/latest/check": { "get": { "description": "Checks for new threat intelligence dataset. If new data is available, returns a short-lived pre-signed URL.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Reporting API", "url": "https://techdocs.akamai.com/etp-reporting/reference/get-threat-intel" }, "operationId": "get-threat-intel", "parameters": [ { "description": "The last threat intelligence file generation time in Unix epoch seconds. If data hasn't update since then, the API responds with a 304 status code. ", "in": "header", "name": "If-Modified-Since", "required": false, "schema": { "example": 1749551200, "type": "integer" }, "x-akamai": { "file-path": "headers/if-modified-since.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "expiresInSeconds": 120, "preSignedUrl": "https://threat-intel.akaetp.net/latest.csv.gz?auth-token=exp=1752605144~acl=%2f*~hmac=43f3071ada18c3c8c95895dad1be98ad87767e88ac5b976ce24ee576f3aa5988" }, "schema": { "additionalProperties": false, "description": "A threat intelligence feed.", "properties": { "expiresInSeconds": { "description": "Number of seconds until the URL expires.", "type": "integer" }, "preSignedUrl": { "description": "Temporary URL to download the latest threat intelligence data.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/threat-intel-response.yaml" } } } }, "description": "New update available - Returns a short-lived URL to download the file.", "headers": { "ETag": { "description": "Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-reporting/reference/concurrency-control) for details.", "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/x-etag.yaml" } }, "Last-Modified": { "description": "File generation time in Unix epoch seconds. Use in subsequent API calls as the request header \"If-Modified-Since\" header.", "required": false, "schema": { "example": 1749551200, "type": "integer" }, "x-akamai": { "file-path": "headers/last-modified-header.yaml" } }, "Retry-After": { "description": "The number of seconds after which new threat intelligence data is expected.", "required": false, "schema": { "example": 3600, "type": "integer" }, "x-akamai": { "file-path": "headers/retry-after-seconds-header.yaml" } } } }, "304": { "content": {}, "description": "[Not Modified](https://techdocs.akamai.com/etp-reporting/reference/304). No new threat intelligence update available since last request by client." }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the this API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-reporting/reference/401). See [Get started](https://techdocs.akamai.com/etp-reporting/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.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" } }, "429": { "content": {}, "description": "[Too Many Requests](https://techdocs.akamai.com/etp-reporting/reference/429). Rate limit exceeded.", "headers": { "X-Rate-Limit-Retry-After-Seconds": { "description": "The number of seconds after which new threat intelligence data is expected.", "required": false, "schema": { "example": 3600, "type": "integer" }, "x-akamai": { "file-path": "headers/retry-after-seconds-header.yaml" } } }, "x-akamai": { "file-path": "errors/rate-limit-exceeded-429.yaml" } } }, "summary": "Get latest domain threat intelligence", "tags": [ "Threat intelligence" ] }, "x-akamai": { "file-path": "paths/threat-intel-feed.yaml", "path-info": "/threat-intel/domains/latest" } } }, "servers": [ { "url": "https://{hostname}/etp-report/v3" } ], "tags": [ { "description": "Generate reports on detected and blocked threat events based on your custom SIA security lists.", "name": "Threat events" }, { "description": "Generate reports about Acceptable User Policy (AUP) events or get information about existing AUP events.", "name": "AUP events" }, { "description": "Generate reports on threats detected when accessing a malicious domain.", "name": "DNS activity reports" }, { "description": "Generate Security Connector reports. Security Connector events provide details on malicious or suspicious traffic that SIA routes to a sinkhole device.", "name": "Security Connector event reports" }, { "description": "Generate reports on all network traffic directed to SIA, including suspicious traffic or traffic that bypasses the SIA Proxy.", "name": "Network traffic connections" }, { "description": "Generate reports about proxy network traffic connections.", "name": "Proxy traffic transactions" }, { "description": "Get information about identity provider (IdP) access logs.", "name": "IDP access logs" }, { "description": "Generate reports for Indicators of Compromise (IOC) records. IOCs are artifacts observed on a network or in an operating system that indicate a computer intrusion with high confidence.", "name": "IOC reports" }, { "description": "Generate reports on the types of Indicators of Compromise (IOC) configured for your SIA implementation. IOCs are artifacts observed on a network or in an operating system that indicate a computer intrusion with high confidence.", "name": "IOC detail reports" }, { "description": "Generate reports of deepscan data for a configuration's offline network.", "name": "Deepscan reports" }, { "description": "Get reports on metadata threats.", "name": "Threats" }, { "description": "Generate domain-level threat reports or get feedback about a domain.", "name": "Feedback reports" }, { "description": "Set up schedules to generate SIA reports.", "name": "Report schedules" }, { "description": "Provides the latest domain threat intelligence data as a gzipped CSV.", "name": "Threat intelligence" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }