Akamai: Secure Internet Access Enterprise Reporting API
Access and analyze reports for acceptable user policy (AUP) events, DNS activity, network traffic connections, security connector events, and threat events.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Access and analyze reports for acceptable user policy (AUP) events, DNS activity, network traffic connections, security connector events, and threat events.
Endpoints 38
Threat events
- GETReport threat event totals
/configs/:configId/threat-events/aggregate?dimension=domain&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists the count of threat events, grouped by the chosen query aggregation. - POSTReport threat event details
/configs/:configId/threat-events/details?accountSwitchKey=1-5C0YLB:1-8BYUXProvides all threat events records with detailed information. - GETReport threat event time series
/configs/:configId/threat-events/time-series?dimension=domain&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists threat event totals, aggregated by hour.
AUP events
- GETReport AUP event totals
/configs/:configId/aup-events/aggregate?dimension=domain&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists total counts for AUP events, aggregated for the given time period. - POSTReport AUP event details
/configs/:configId/aup-events/details?accountSwitchKey=1-5C0YLB:1-8BYUXProvides all threat events record details for a given time period. - GETReport AUP event time series
/configs/:configId/aup-events/time-series?dimension=domain&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists total counts for AUP events, aggregated by hour.
DNS activity reports
- GETReport DNS activity totals
/configs/:configId/dns-activities/aggregate?dimension=domain&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists the count of DNS activities aggregated for the given time period. - POSTReport DNS activity event details
/configs/:configId/dns-activities/details?accountSwitchKey=1-5C0YLB:1-8BYUXLists raw DNS events for a given time period. This operation Lists the first 500 configurable results. - GETReport DNS activity time series
/configs/:configId/dns-activities/time-series?dimension=domain&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists the count of DNS activities, aggregated by hour.
Security Connector event reports
- GETReport security connector event totals
/configs/:configId/sinkhole-events/aggregate?dimension=status&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists the count of Security Connector events, grouped by the chosen query aggregation. - POSTReport security connector event details
/configs/:configId/sinkhole-events/details?accountSwitchKey=1-5C0YLB:1-8BYUXLists Security Connector events for a given time period. - GETReport security connector event time series
/configs/:configId/sinkhole-events/time-series?dimension=status&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists Security Connector event totals, aggregated by hour.
Network traffic connections
- GETReport network traffic connections totals
/configs/:configId/network-traffic/connections/aggregate?dimension=domain&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists the count of network traffic connections totals, grouped by query parameters. - POSTReport network traffic connections details
/configs/:configId/network-traffic/connections/details?accountSwitchKey=1-5C0YLB:1-8BYUXLists network traffic connections for a given time period. - GETReport network traffic connections time series
/configs/:configId/network-traffic/connections/time-series?dimension=domain&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists network traffic connections totals, aggregated by hour.
Proxy traffic transactions
- GETReport proxy traffic transactions totals
/configs/:configId/proxy-traffic/transactions/aggregate?dimension=domain&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists the count of proxy traffic transaction totals, grouped by the chosen query aggregation.. - POSTReport proxy network traffic transaction details
/configs/:configId/proxy-traffic/transactions/details?accountSwitchKey=1-5C0YLB:1-8BYUXLists proxy network traffic connections for a given time period. - GETReport proxy traffic transactions time series
/configs/:configId/proxy-traffic/transactions/time-series?dimension=domain&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXLists proxy traffic transaction totals, aggregated by hour.
IDP access logs
- POSTReport IDP access log details
/configs/:configId/access-logs/details?accountSwitchKey=1-5C0YLB:1-8BYUXLists the IDP access logs for a configuration for a given time period.
IOC reports
- GETGet IOC time series report
/configs/:configId/ioc/time-series?startTimeSec=1333631700&endTimeSec=1333631700&record=facebook.com&recordType=DOMAIN&accountSwitchKey=1-5C0YLB:1-8BYUXLists 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… - GETGet IOC change report
/ioc/changes?startTimeSec=1333631700&endTimeSec=1333631700&record=facebook.com&recordType=DOMAIN&accountSwitchKey=1-5C0YLB:1-8BYUXLists historical change information for a given record and record type. Omit startTimeSec and endTimeSec from the request URL to return all available… - GETGet IOC AVC details report
/ioc/details/avc?recordType=DOMAIN&record=facebook.com&accountSwitchKey=1-5C0YLB:1-8BYUXLists the AVC details for a given domain or IP. - GETGet IOC CIDR details report
/ioc/details/cidr?recordType=DOMAIN&record=facebook.com&accountSwitchKey=1-5C0YLB:1-8BYUXLists the CIDR details for a given domain or IP. - GETGet IOC domain tree report
/ioc/domain-tree?recordType=DOMAIN&record=facebook.com&accountSwitchKey=1-5C0YLB:1-8BYUXLists the blocklisted domains and IPs matching a given record. Returns an empty list if no domains match.
IOC detail reports
- GETGet IOC details report
/ioc/details?recordType=DOMAIN&record=facebook.com&includeChanges=false&accountSwitchKey=1-5C0YLB:1-8BYUXLists the IOC details for a given domain or IP. - GETGet IOC AUP detail report
/ioc/details/aup?recordType=DOMAIN&record=facebook.com&accountSwitchKey=1-5C0YLB:1-8BYUXLists the AUP details for a given domain or IP.
Deepscan reports
- GETGet deepscan details report
/configs/:configId/deep-scan-reports?startTimeSec=1333631700&endTimeSec=1333631700&filters={"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"]}}&accountSwitchKey=1-5C0YLB:1-8BYUXDeepscan results for a configuration's offline network for a given time period. Use the path obtained from /threat-events.
Threats
- GETGet threat metadata report
/configs/:configId/threats/threat-meta?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the threat metadata.
Feedback reports
- GETGet feedback event detail report
/configs/:configId/feedbacks/details?dimension=CATEGORY&dimensionValue=0uk.net&feedbackType=not_categorized&accountSwitchKey=1-5C0YLB:1-8BYUXReturns feedback information about a domain based on the feedback type. - POSTReport a threat
/configs/:configId/feedbacks/details?accountSwitchKey=1-5C0YLB:1-8BYUXReports the threat for a domain.
Report schedules
- GETList report schedules
/configs/:configId/schedules?accountSwitchKey=1-5C0YLB:1-8BYUXLists all configured report schedules for a given configuration. - POSTCreate a report schedule
/configs/:configId/schedules?accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new report schedule for a given SIA configuration. - GETGet a report schedule
/configs/:configId/schedules/:scheduleId?accountSwitchKey=1-5C0YLB:1-8BYUXLists the configuration of a specified report schedule. - PUTUpdate a report schedule
/configs/:configId/schedules/:scheduleId?accountSwitchKey=1-5C0YLB:1-8BYUXUpdates the configuration of a specified report schedule. - DELETERemove a report schedule
/configs/:configId/schedules/:scheduleId?accountSwitchKey=1-5C0YLB:1-8BYUXRemoves the configuration of a specified report schedule. - POSTDisable a report schedule
/configs/:configId/schedules/:scheduleId/disable?accountSwitchKey=1-5C0YLB:1-8BYUXDisables the configuration of a specified report schedule. - POSTEnable a report schedule
/configs/:configId/schedules/:scheduleId/enable?accountSwitchKey=1-5C0YLB:1-8BYUXEnables the configuration of a specified report schedule.
Threat intelligence
- GETGet latest domain threat intelligence
/threat-intel/domains/latest/check?accountSwitchKey=1-5C0YLB:1-8BYUXChecks for new threat intelligence dataset. If new data is available, returns a short-lived pre-signed URL.
API details
- Base URL
https://{hostname}/etp-report/v3- Authentication
- None declared in the description
- Operations
- 38 operations on 34 pathsGET 25POST 11PUT 1DELETE 1
- Main resources
- Report schedules 7IOC reports 5AUP events 3DNS activity reports 3Network traffic connections 3Proxy traffic transactions 3Security Connector event reports 3Threat events 3Feedback reports 2IOC detail reports 2
- Response formats
application/problem+jsonapplication/jsonapplication/pdftext/csv- Description format
- OpenAPI 3.0.0, API version
v3 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: Secure Internet Access Enterprise Reporting API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Secure Internet Access Enterprise Reporting API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Report threat event totals” (GET /configs/:configId/threat-events/aggregate?dimension=domain&cardinality=2500&startTimeSec=1333631700&endTimeSec=1333631700&filters={"category":{"in":[5,7]},"isAlert":{"nin":["false"]}}&accountSwitchKey=1-5C0YLB:1-8BYUX), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: Secure Internet Access Enterprise Reporting API?
Access and analyze reports for acceptable user policy (AUP) events, DNS activity, network traffic connections, security connector events, and threat events. It is listed under Developer tools and has 38 endpoints.
Who publishes the Akamai: Secure Internet Access Enterprise Reporting API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: Secure Internet Access Enterprise Reporting API?
Requests go to https://{hostname}/etp-report/v3. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: Secure Internet Access Enterprise Reporting API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: Secure Internet Access Enterprise Reporting API have?
38 operations on 34 paths (25 GET, 11 POST, 1 PUT, 1 DELETE). The largest groups are Report schedules, IOC reports, AUP events, DNS activity reports.
Is forking the Akamai: Secure Internet Access Enterprise Reporting API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.