Python Shell
Failed to load latest commit information.
examples display countdown timer for effectuating DNS changes Apr 15, 2018
lexicon Merge 1ce2ebc into 38b4728 Jul 15, 2018
tests Merge 1ce2ebc into 38b4728 Jul 15, 2018
.coveralls.yml fix token. Apr 5, 2016
.gitignore added instruction regarding how to create a virtual env when testing.… Mar 19, 2018
CODEOWNERS exoscale: add @brutasse as a code owner Jul 5, 2018 Update Jun 6, 2018
Dockerfile was renamed to dehydrated. Oct 8, 2016
LICENSE Initial commit Feb 2, 2016 added VERSION file not as its better for thrid party tool… Feb 17, 2016 Update Jul 14, 2018 Update May 12, 2018
VERSION (v2.7.0) Automated packaging of release by CapsuleCD Jul 15, 2018
capsule.yml capsulecd should always test basic env in addition to py27 install. Jan 27, 2018
circle.yml dont run tests on py3.3 Jan 22, 2018
logo.svg adding logo from nounproject, and added reference in the license sect… Jul 12, 2018
optional-requirements.txt Added support for subreg API ( (#224) May 12, 2018
requirements.txt Implements new provider: google cloud dns (WIP) Jul 8, 2018
setup.cfg add pip package requirements. Feb 5, 2016 Use Zeep instead of PySimpleSOAP library. Jul 12, 2018
test-requirements.txt bump python-coveralls version, we're getting encoding failures. May 26, 2018 python 3 syntax error when running tests Dec 6, 2017
tox.ini add testenv that ensures lexicon still works even if an optional libr… Jan 27, 2018



Manipulate DNS records on various DNS providers in a standardized/agnostic way.

Circle CI Coverage Status Docker Pulls PyPI PyPI GitHub license


Lexicon provides a way to manipulate DNS records on multiple DNS providers in a standardized way. Lexicon has a CLI but it can also be used as a python library.

Lexicon was designed to be used in automation, specifically letsencrypt.


Only DNS providers who have an API can be supported by lexicon.

The current supported providers are:

Potential providers are as follows. If you would like to contribute one, follow the and then open a pull request.

  • Azure DNS (docs)
  • AHNames (docs)
  • DurableDNS (docs) Can't set TXT records
  • Dyn (docs) 💵 requires paid account
  • Dynu
  • DirectAdmin
  • EntryDNS (docs) 💵 requires paid account
  • FreeDNS (docs)
  • Host Virtual DNS (docs) 💵 requires paid account
  • HostEurope
  • Hurricane Electric DNS
  • Infoblox NIOS
  • ironDNS (docs) 💵 requires paid account
  • INWX (docs)
  • ISPConfig
  • InternetX autoDNS (docs)
  • Knot DNS
  • KingHost
  • Liquidweb (docs) 💵 requires paid account
  • Loopia (docs) 💵 requires paid account
  • Mythic Beasts(docs)
  • NFSN (NearlyFreeSpeech) (docs) 💵 requires paid account
  • RFC2136 (docs)
  • Servercow (docs)
  • TELE3 (docs)
  • UltraDNS (docs) 💵 requires paid account
  • UnoEuro API
  • WorldWideDns (docs) 💵 requires paid account
  • Zerigo (docs) 💵 requires paid account
  • Zoneedit (docs)
  • Zilore (docs)
  • Any others I missed


To use lexicon as a CLI application, do the following:

pip install dns-lexicon

Some providers (like Route53 and TransIP) require additional dependencies. You can install provider specific dependencies separately:

pip install dns-lexicon[route53]

You can also install the latest version from the repository directly.

pip install git+

and with Route 53 provider dependencies:

pip install git+[route53]


$ lexicon -h
  usage: lexicon [-h] [--version] [--delegated DELEGATED]

  Create, Update, Delete, List DNS entries

  positional arguments:
                          specify the DNS provider to use
      cloudflare          cloudflare provider
      cloudxns            cloudxns provider
      digitalocean        digitalocean provider
      rage4               rage4 provider
      route53             route53 provider
      vultr               vultr provider
      yandex              yandex provider
      zonomi              zonomi provider

  optional arguments:
    -h, --help            show this help message and exit
    --version             show the current version of lexicon
    --delegated DELEGATED
                          specify the delegated domain

  $ lexicon cloudflare -h
  usage: lexicon cloudflare [-h] [--name NAME] [--content CONTENT] [--ttl TTL]
                            [--priority PRIORITY] [--identifier IDENTIFIER]
                            [--auth-username AUTH_USERNAME]
                            [--auth-token AUTH_TOKEN]
                            {create,list,update,delete} domain

  positional arguments:
                          specify the action to take
    domain                specify the domain, supports subdomains as well
                          specify the entry type

  optional arguments:
    -h, --help            show this help message and exit
    --name NAME           specify the record name
    --content CONTENT     specify the record content
    --ttl TTL             specify the record time-to-live
    --priority PRIORITY   specify the record priority
    --identifier IDENTIFIER
                          specify the record for update or delete actions
    --auth-username AUTH_USERNAME
                          specify email address used to authenticate
    --auth-token AUTH_TOKEN
                          specify token used authenticate

Using the lexicon CLI is pretty simple:

# setup provider environmental variables:
export LEXICON_CLOUDFLARE_TOKEN="cloudflare-api-token"

# list all TXT records on cloudflare
lexicon cloudflare list TXT

# create a new TXT record on cloudflare
lexicon cloudflare create TXT --name="" --content="challenge token"

# delete a  TXT record on cloudflare
lexicon cloudflare delete TXT --name="" --content="challenge token"
lexicon cloudflare delete TXT --identifier="cloudflare record id"


Most supported DNS services provide an API token, however each service implements authentication differently. Lexicon attempts to standardize authentication around the following CLI flags:

  • --auth-username - For DNS services that require it, this is usually the account id or email address
  • --auth-password - For DNS services that do not provide an API token, this is usually the account password
  • --auth-token - This is the most common auth method, the API token provided by the DNS service

You can see all the --auth-* flags for a specific service by reading the DNS service specific help: lexicon cloudflare -h

Environmental Variables

Instead of providing Authentication information via the CLI, you can also specify them via Environmental Variables. Every DNS service and auth flag maps to an Environmental Variable as follows: LEXICON_{DNS Provider Name}_{Auth Type}

So instead of specifying --auth-username and --auth-token flags when calling lexicon cloudflare ..., you could instead set the LEXICON_CLOUDFLARE_USERNAME and LEXICON_CLOUDFLARE_TOKEN environmental variables.

Letsencrypt Instructions

Lexicon has an example dehydrated hook file that you can use for any supported provider. All you need to do is set the PROVIDER env variable.

PROVIDER=cloudflare dehydrated --cron --hook --challenge dns-01

Lexicon can also be used with Certbot and the included Certbot hook file (requires configuration).

TroubleShooting & Useful Tools

There is an included example Dockerfile that can be used to automatically generate certificates for your website.

ToDo list

  • Create and Register a lexicon pip package.
  • Write documentation on supported environmental variables.
  • Wire up automated release packaging on PRs.
  • Check for additional dns hosts with apis (from fog, dnsperf, libcloud)
  • Get a list of Letsencrypt clients, and create hook files for them (letsencrypt clients)

Contributing Changes.

If the DNS provider you use is not already available, please consider contributing by opening a pull request and following the