Akamai APIs API Documentation

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.

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.

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.

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

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. Localization data - Get localization data

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

Get the collection of application property strings in a specific language.

2. Products - List products

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

Get the list of product IDs and their corresponding display names for products this API supports.

3. Certificates - Get a certificate

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

Get the certificate associated with an enhanced TLS edge hostname.

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

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

Retrieve the full record for a single edge hostname as specified by its DNS zone and record name to view its details such product ID, IP version behavior, China CDN status, or Edge IP Binding status.

5. Edge hostnames - Patch an edge hostname

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

Selectively modify an edge hostname using JSON patch syntax. This API supports the replace patch operation to make simple changes to the TTL and IP version.

6. Edge hostnames - Delete an edge hostname

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

Delete a specific edge hostname. You must have an Admin or Technical role in order to delete an edge hostname. You can delete any hostname that's not currently assigned to an active Property Manager configuration.

7. Edge hostnames - List edge hostnames

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

Lists all edge hostnames available for the logged-in account and context, optionally filtering results along several dimensions.

8. Edge hostnames - Get an edge hostname

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

Get a specific edge hostname's details including its product ID, IP version behavior, and China CDN or Edge IP Binding status.

9. Change requests - List change requests

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

Get the list of pending change requests for the logged-in account and context.

10. Change requests - Get a change request

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

Get a change request status and details specified by the change ID that is provided when you make a change request.

11. Change requests - List change requests per edge hostname

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

Get the list of all change requests that have been made for the specified edge hostname.