Skip to main content

Creating a Read-Only API Client in Akamai

Creating the API Client​

You can add your Akamai CDN in Read-Only mode to IO River and use it for importing your configuration, monitoring, and traffic steering. To add Akamai as a Read-Only CDN provider, you need to create an API client in your Akamai account:

  1. Sign in to your Akamai account.
  2. Navigate to the left sidebar and choose Identity & access.
  3. Under the Users and API Clients tab, click the Create API client button.
  4. Click the Advanced button.
  5. Fill out the new API client form:
    1. Name - Type a name for the client.
    2. Description - Type a description for the client.
    3. APIs - Check the Select APIs option. When the list of permissions appears, click the Clear API selection, and pick the following permissions:
      • Property Manager (PAPI) - READ-ONLY
      • CPS - READ-ONLY
      • Manage Edge Hostnames API - READ-ONLY
      • Datastream Config - READ-ONLY
      • CCU APIs - READ-ONLY
      • Enhanced Content Control Utility (ECCU) - READ-ONLY
      • Reporting API - READ-WRITE (The Reporting API is only used to retrieve statistics, but it requires READ-WRITE permissions.)
      • CPcode and Reporting group - READ-ONLY
    4. Click Submit.
    5. Click Create API client.
  6. Review the created API client and copy its credentials:
    • client_secret
    • host (base URL)
    • access_token
    • client_token

Example​

client_secret = i3YpvJFBiScVG6J6JJPzI9aJk32XmMOYTRDQCNgCFXY=
host = akab-grfave5t2bgnf7gp-thnbutolqvre5evi.luna.akamaiapis.net
access_token = akab-tznh3naf2xyrtepu-6pwdbmjsqy7la4vs
client_token = akab-gbq3efk7iuw3nk6e-2al2mw7xdwlunph

Save the created credentials, and provide them to the IO River support team to add your Akamai CDN in Read-Only mode.

Creating an Akamai Functions Token​

In Akamai, the IO River WAF runs as an Akamai Function, which has a separate authorization framework. Learn more about Akamai Functions.

If you are using IO River WAF, you will need to create an Akamai Function Token, a dedicated token that IO River can use to deploy the WAF engine in Akamai Functions. The token is created using the Akamai Functions CLI, called spin.

  1. Install spin.
  2. Install the Akamai spin plugin.
  3. Login to Akamai Functions.
  4. Create an Akamai Functions token using the following command
spin aka auth token create --name ioriver -e 90
  1. Review the command output
INT ✘  compute-apps  
A personal access token has been created! The token will expire 90 days from now.
Please store this token in a safe place, as it will not be shown again.
Here is your access token: pat_M6FXXXXXXXXXXXXXXXXXXXV4XP

Copy the token pat_M6FXXXXXXXXXXXXXXXXXXXV4XP from the command output, and paste it when you add your Akamai CDN here.