Akamai APIs API Documentation

Secure Internet Access Enterprise Reporting API v3

Number of APIs: 37

GET https://{{host}}/etp-report/v3/configs/:configId/aup-events/aggregate?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists total counts for AUP events, aggregated for the given time period.

2. AUP events - Report AUP event details

POST https://{{host}}/etp-report/v3/configs/:configId/aup-events/details

Provides all threat events record details for a given time period.

3. AUP events - Report AUP event time series

GET https://{{host}}/etp-report/v3/configs/:configId/aup-events/time-series?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists total counts for AUP events, aggregated by hour.

4. Deepscan reports - Get deepscan details report

GET https://{{host}}/etp-report/v3/configs/:configId/deep-scan-reports?startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}

Deepscan results for a configuration's offline network for a given time period. Use the path obtained from /threat-events.

5. DNS activity reports - Report DNS activity totals

GET https://{{host}}/etp-report/v3/configs/:configId/dns-activities/aggregate?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists the count of DNS activities aggregated for the given time period.

6. DNS activity reports - Report DNS activity event details

POST https://{{host}}/etp-report/v3/configs/:configId/dns-activities/details

Lists raw DNS events for a given time period. This operation Lists the first 500 configurable results.

7. DNS activity reports - Report DNS activity time series

GET https://{{host}}/etp-report/v3/configs/:configId/dns-activities/time-series?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists the count of DNS activities, aggregated by hour.

8. Feedback reports - Report a threat

POST https://{{host}}/etp-report/v3/configs/:configId/feedbacks/details

Reports the threat for a domain.

9. Feedback reports - Get feedback event detail report

GET https://{{host}}/etp-report/v3/configs/:configId/feedbacks/details?dimension={{dimension}}&dimensionValue={{dimensionValue}}&feedbackType={{feedbackType}}

Returns feedback information about a domain based on the feedback type.

10. IDP access logs - Report IDP access log details

POST https://{{host}}/etp-report/v3/configs/:configId/access-logs/details

Lists the IDP access logs for a configuration for a given time period.

11. IOC reports - Get IOC time series report

GET https://{{host}}/etp-report/v3/configs/:configId/ioc/time-series?startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&record={{record}}&recordType={{recordType}}

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.

12. IOC reports - Get IOC change report

GET https://{{host}}/etp-report/v3/ioc/changes?startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&record={{record}}&recordType={{recordType}}

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.

13. IOC reports - Get IOC AVC details report

GET https://{{host}}/etp-report/v3/ioc/details/avc?recordType={{recordType}}&record={{record}}

Lists the AVC details for a given domain or IP.

14. IOC reports - Get IOC CIDR details report

GET https://{{host}}/etp-report/v3/ioc/details/cidr?recordType={{recordType}}&record={{record}}

Lists the CIDR details for a given domain or IP.

15. IOC reports - Get IOC domain tree report

GET https://{{host}}/etp-report/v3/ioc/domain-tree?recordType={{recordType}}&record={{record}}

Lists the blocklisted domains and IPs matching a given record. Returns an empty list if no domains match.

16. IOC detail reports - Get IOC details report

GET https://{{host}}/etp-report/v3/ioc/details?recordType={{recordType}}&record={{record}}

Lists the IOC details for a given domain or IP.

17. IOC detail reports - Get IOC AUP detail report

GET https://{{host}}/etp-report/v3/ioc/details/aup?recordType={{recordType}}&record={{record}}

Lists the AUP details for a given domain or IP.

18. Network traffic connections - Report network traffic connections totals

GET https://{{host}}/etp-report/v3/configs/:configId/network-traffic/connections/aggregate?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists the count of network traffic connections totals, grouped by query parameters.

19. Network traffic connections - Report network traffic connections details

POST https://{{host}}/etp-report/v3/configs/:configId/network-traffic/connections/details

Lists network traffic connections for a given time period.

20. Network traffic connections - Report network traffic connections time series

GET https://{{host}}/etp-report/v3/configs/:configId/network-traffic/connections/time-series?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists network traffic connections totals, aggregated by hour.

21. Proxy traffic transactions - Report proxy traffic transactions totals

GET https://{{host}}/etp-report/v3/configs/:configId/proxy-traffic/transactions/aggregate?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists the count of proxy traffic transaction totals, grouped by the chosen query aggregation..

22. Proxy traffic transactions - Report proxy network traffic transaction details

POST https://{{host}}/etp-report/v3/configs/:configId/proxy-traffic/transactions/details

Lists proxy network traffic connections for a given time period.

23. Proxy traffic transactions - Report proxy traffic transactions time series

GET https://{{host}}/etp-report/v3/configs/:configId/proxy-traffic/transactions/time-series?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists proxy traffic transaction totals, aggregated by hour.

24. Report schedules - Create a report schedule

POST https://{{host}}/etp-report/v3/configs/:configId/schedules

Creates a new report schedule for a given SIA configuration.

25. Report schedules - List report schedules

GET https://{{host}}/etp-report/v3/configs/:configId/schedules

Lists all configured report schedules for a given configuration.

26. Report schedules - Get a report schedule

GET https://{{host}}/etp-report/v3/configs/:configId/schedules/:scheduleId

Lists the configuration of a specified report schedule.

27. Report schedules - Update a report schedule

PUT https://{{host}}/etp-report/v3/configs/:configId/schedules/:scheduleId

Updates the configuration of a specified report schedule.

28. Report schedules - Remove a report schedule

DELETE https://{{host}}/etp-report/v3/configs/:configId/schedules/:scheduleId

Removes the configuration of a specified report schedule.

29. Report schedules - Disable a report schedule

POST https://{{host}}/etp-report/v3/configs/:configId/schedules/:scheduleId/disable

Disables the configuration of a specified report schedule.

30. Report schedules - Enable a report schedule

POST https://{{host}}/etp-report/v3/configs/:configId/schedules/:scheduleId/enable

Enables the configuration of a specified report schedule.

31. Security Connector event reports - Report security connector event totals

GET https://{{host}}/etp-report/v3/configs/:configId/sinkhole-events/aggregate?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists the count of Security Connector events, grouped by the chosen query aggregation.

32. Security Connector event reports - Report security connector event details

POST https://{{host}}/etp-report/v3/configs/:configId/sinkhole-events/details

Lists Security Connector events for a given time period.

33. Security Connector event reports - Report security connector event time series

GET https://{{host}}/etp-report/v3/configs/:configId/sinkhole-events/time-series?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists Security Connector event totals, aggregated by hour.

34. Threat events - Report threat event totals

GET https://{{host}}/etp-report/v3/configs/:configId/threat-events/aggregate?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}

Lists the count of threat events, grouped by the chosen query aggregation.

35. Threat events - Report threat event details

POST https://{{host}}/etp-report/v3/configs/:configId/threat-events/details

Provides all threat events records with detailed information.

36. Threat events - Report threat event time series

GET https://{{host}}/etp-report/v3/configs/:configId/threat-events/time-series?dimension={{dimension}}&startTimeSec={{startTimeSec}}&endTimeSec={{endTimeSec}}&filters={{filters}}