Secure Internet Access Enterprise Reporting API v3

Number of APIs: 37

Use the Secure Internet Access Enterprise (SIA) Reporting API to access and analyze reports for acceptable user policy (AUP) events, DNS activity, network traffic connections, security connector events, and threat events. This API allows flexible access to reporting features in Akamai Control Center, using your own tools.

To use this API, you should have a working knowledge of SIA and how the configurable objects interact. If you're not familiar with these topics, see the SIA Configuration API for more information.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

1. Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

1. Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

1. Open the downloaded file with a text editor and add [default] as a header above all text.

  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

1. Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

To enable this API, go to the API list in Control Center, choose the API service named ETP Report, and set the access level to READ-WRITE. Refer to Create a quick API client for more details.

Integration methods

You can use this API collection in these integration methods: - API

1. IOC reports - Get IOC AVC details report

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

---

2. IOC detail reports - Get IOC AUP detail report

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

---

3. AUP events - Report AUP event details

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

---

4. 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}}

---

5. Deepscan reports - Get deepscan details report

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

---

6. AUP events - Report AUP event totals

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

---

7. 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}}

---

8.

API Documentation