Back to Lego

Akamai EdgeDNS

docs/content/dns/zz_gen_edgedns.md

4.35.23.8 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/edgedns/edgedns.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS

<!--more-->
  • Code: edgedns
  • Since: v3.9.0

Here is an example bash command using the Akamai EdgeDNS provider:

bash
AKAMAI_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG= \
AKAMAI_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \
lego --dns edgedns -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
AKAMAI_ACCESS_TOKENAccess token, managed by the Akamai EdgeGrid client
AKAMAI_CLIENT_SECRETClient secret, managed by the Akamai EdgeGrid client
AKAMAI_CLIENT_TOKENClient token, managed by the Akamai EdgeGrid client
AKAMAI_EDGERCPath to the .edgerc file, managed by the Akamai EdgeGrid client
AKAMAI_EDGERC_SECTIONConfiguration section, managed by the Akamai EdgeGrid client
AKAMAI_HOSTAPI host, managed by the Akamai EdgeGrid client

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
AKAMAI_ACCOUNT_SWITCH_KEYTarget account ID when the DNS zone and credentials belong to different accounts
AKAMAI_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 15)
AKAMAI_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 180)
AKAMAI_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 120)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Akamai's credentials are automatically detected in the following locations and prioritized in the following order:

  1. Section-specific environment variables (where {SECTION} is specified using AKAMAI_EDGERC_SECTION):
  • AKAMAI_{SECTION}_HOST
  • AKAMAI_{SECTION}_ACCESS_TOKEN
  • AKAMAI_{SECTION}_CLIENT_TOKEN
  • AKAMAI_{SECTION}_CLIENT_SECRET
  1. If AKAMAI_EDGERC_SECTION is not defined or is set to default, environment variables:
  • AKAMAI_HOST
  • AKAMAI_ACCESS_TOKEN
  • AKAMAI_CLIENT_TOKEN
  • AKAMAI_CLIENT_SECRET
  1. .edgerc file located at AKAMAI_EDGERC
  • defaults to ~/.edgerc, sections can be specified using AKAMAI_EDGERC_SECTION
  1. Default environment variables:
  • AKAMAI_HOST
  • AKAMAI_ACCESS_TOKEN
  • AKAMAI_CLIENT_TOKEN
  • AKAMAI_CLIENT_SECRET

See also:

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/edgedns/edgedns.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->