Edge Hostnames API

Number of APIs: 11

Use the Edge Hostnames API (HAPI) to manage how requests for your site, app, or content map to Akamai edge servers.

With this API, you can: - Get existing edge hostnames. - Edit edge hostname details such as IP version and TTL. - Delete edge hostnames.

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

You can retrieve data only from existing edge hostnames. To create a new edge hostname aligned with the Property Manager product, IP version, and security settings, use the Property Manager API.

Integration methods

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

1. Change requests - List change requests

GET https://{{host}}/hapi/v1/change-requests

---

2. Change requests - Get a change request

GET https://{{host}}/hapi/v1/change-requests/:changeId

---

3. Edge hostnames - Delete an edge hostname

DELETE https://{{host}}/hapi/v1/dns-zones/:dnsZone/edge-hostnames/:recordName

---

4. Edge hostnames - Get an edge hostname by DNS zone and record name

GET https://{{host}}/hapi/v1/dns-zones/:dnsZone/edge-hostnames/:recordName

---

5. Change requests - List change requests per edge hostname

GET https://{{host}}/hapi/v1/dns-zones/:dnsZone/edge-hostnames/:recordName/change-requests

---

6. Edge hostnames - Get an edge hostname

GET https://{{host}}/hapi/v1/edge-hostnames/:edgeHostnameId

---

7. Localization data - Get localization data

GET https://{{host}}/hapi/v1/i18n/:language

---

8. Products - List products

GET https://{{host}}/hapi/v1/products/display-names

---

9. Certificates - Get a certificate