Onboard a new property (legacy)

The basic onboarding flow is common for every brand-new property, regardless of the ‚ÄčAkamai‚Äč product you want to use. Here's how to start serving your content through optimal edge servers.

1 - Authenticate to ‚ÄčAkamai‚Äč and DNS

To make calls through PAPI, you need to authenticate to ‚ÄčAkamai‚Äč using tokens you generate in your API client tool. Make sure you have write access to your primary DNS servers. You'll need to modify DNS records later in this process to onboard the property.

3 - Add the origin layer to your DNS

Get the IP address of your existing origin and create an A record in your DNS.

4 - Get contracts, groups, and products

These identifiers specify what modules and features are available in your configuration.

5 - Create a CP code

CP codes track any web traffic handled by edge servers. Each property’s default rule needs a valid CP code to bill and report for the service.

6 - Create a property

Think of a property as a container for your product configuration. Through properties, you control how your content is delivered.

7 - Set up property hostnames

Map your property to an edge hostname that will take over the client traffic from your origin. If you have Secure By Default enabled in your contract, the easiest way is to specify a setup with a "certificateProvisioningType": "DEFAULT" that secures your HTTPS delivery and automatically creates an edge hostname upon activation.

8 - Get the hostname certificate validation challenge

Note the DNS challenge you receive in the validationCname object.

8 - Add the validation challenge to DNS

Confirm that you control the domain name used in the edge certificate. In your DNS configuration, create a CNAME record and map the hostname part of the challenge to the target part.

9 - Confirm the hostname certificate deployment

Re-run the operation to check the certStatus.

10 - Get the rule tree

Get the baseline of your property's rule tree. What you'll get in the response varies based on your ‚ÄčAkamai‚Äč product.

11 - Edit the rule tree

Provide necessary details for the top-level default rule. At minimum, configure mandatory origin and cpCode behaviors. Optionally, include any number of your own rules to customize the content delivery.

Rule trees are maintained in a special form of JSON that you can best edit and validate in the dedicated VS code or Eclipse IDE plugins.

12 - Validate the rule tree changes

Make sure your JSON file is correct and complete before deploying it on edge servers. You need to resolve returned errors, as they block an activation, but you can activate a property version that yields less severe warnings. For more information, see Rule tree errors and warnings. Both VS code and Eclipse plugins support full rule tree validation.

13 - Update the property's rule tree

Push the updated JSON file to the property configuration.

14 - Activate the property on Staging and Production

With brand new setups, it's enough that you test your configuration on Production. You can activate your property on both networks at the same time.

15 - Confirm activation

Make sure the activation status is ACTIVE.

16 - Check the hostname certificate again

After activation, your certificate should be in the DEPLOYED status.

17 - Test the activated settings

  1. Look up the IP address of your edge hostname and copy it.


    nslookup www.example.com.edgekey.net

    Mac OS, Linux, or Unix:

    dig www.example.com.edgekey.net
  2. Paste the edge hostname IP address to your local hosts file in a text editor.

    Navigate to C:\Windows\System32\drivers\etc\hosts

    Mac OS, Linux, or Unix:
    Navigate to /etc/hosts

  3. Restart your browser to clear your DNS cache and verify that your site is working the way you expect.

18 - Go live

Start serving live traffic through the ‚ÄčAkamai‚Äč Edge Platform. Delete the existing CNAME record and add a new one, setting its value to the ‚ÄčAkamai‚Äč edge hostname.

Remember to remove any entries from your local hosts file you set up for testing. Now you can restart your browser and do a smoke test of your website or application.