Onboarding Akamai DNS

Prerequisites

Before configuring Akamai DNS automation in AppViewX, you must create an Akamai API client with the required permissions. AppViewX uses this client to perform DNS-based Domain Control Validation (DCV) or ACME DNS-01 challenge validation, which includes discovering DNS zones and managing DNS records.
Note: During DNS automation, AppViewX retrieves the hosted zones list and validates the existence of zones as a prerequisite before creating DNS records.

Create an API Client

  1. Login to Akamai Control Center.
  2. Navigate to Identity & Access Management > API Clients.
  3. Click Create API Client.
  4. Under API Type, select Advanced.
  5. In the Name field, enter a name for the client, such as AppViewX-DNS. Optionally, enter a description in the Description field.

Configure API Permissions

  1. Under the APIs section, click Select APIs.
  2. Click Change API Restrictions.
  3. Clear the current API selection, then search for and add the following API: DNS - Zone Record Management (READ-WRITE).
  4. Click Save.
    The DNS - Zone Record Management (READ-WRITE) permission enables AppViewX to discover DNS zones, create TXT records for DCV, update existing DNS records, and delete DNS records as needed.
    Note: Akamai uses API-level permissions. A single API permission covers all DNS zone and record operations; no separate permissions are required for individual zones or record types.

Generate Credentials

  1. Click Create API Client.
    The system generates the API credentials.
  2. Copy or download the following credentials and store them securely:
    Credential Description
    Client Token Identifies the API client.
    Client Secret Authenticates the API client.
    Access Token Grants access to the permitted APIs.
    Host The API endpoint URL for your Akamai environment.
    Note: The Client Secret is displayed only once. Ensure you copy and store it before closing this page.

Configuring Akamai

To configure Akamai:
  1. Go to (Menu > CERT+ > ADMINISTRATION > DCV Management > Manage DDI services > Add new vendor.
    The Select vendor page is displayed.
  2. On the Select Vendor page, click Akamai.
  3. On the Vendor Configuration page, under the General section, enter or select the required field information.
    The following table describes the various fields in this section:
    Field Description
    *Name Enter a unique name to identify the vendor account which is being configured.
    Description Enter a description for the purpose of configuring this vendor, if required.
    Data center Select a data center from the options available in the dropdown list.
    *: Mandatory fields
  4. On the Vendor Configuration page, under the Credentials section, enter or select the required field information.
    The following table describes the various fields in this section:
    Field Description
    Auth Type Displays the Akamai EdgeGrid method of authentication selected by default.
    *URL Enter API URL for the vendor with the HTTPS/HTTP protocol.
    Note: The API URL is same as the Hostname URL.
    Example: https://<hostname from credential>
    *Access Token Enter the Access token provided by Akamai.
    *Client Secret Enter the Client secret provided by Akamai.
    *Client Token Enter the Client token provided by Akamai.
    *Contract ID Enter the Akamai contract id for API integration.
    Advanced Configs If you want to enter the more details click the advanced configs radio button.
    Note: Default values are automatically generated for some of these below fields unless values are explicitly entered.
    Fields Description
    *Nonce Random string generated by the client.
    *Timestamp UTC time in such format as specified in the API client authentication section of the Akamai developer portal.
    *Base URL Enter the base URL, without the protocol.
    *Headers to sign Comma-separated list of headers needs to be signed.
    *: Mandatory fields
  5. Enable Config sync for parsing the vendor
  6. On the Vendor Configuration page, under the Configurations section, turn Off the Enable Advance Config toggle.
  7. Click Finish.
    A "Vendor configuration saved successfully" confirmation message is displayed.

Validating the Vendor Configuration

  1. On the Integration Hub page, locate the configured vendor tile.
  2. Confirm that a green check mark (✔) appears on the tile this indicates the vendor is active and reachable.
  3. Click the View status icon on the tile to open the Vendor Status Log: (Vendor Name) dialog.
  4. Verify that the Authentication entry displays a Success status with a recent timestamp.