Skip to content


Repository files navigation

DNSimple Elixir Client

Build Status Module Version Hex Docs Total Download License Last Updated

An Elixir client for the DNSimple API v2.


  • Elixir: 1.12+
  • OTP: 22.0+


You will have to add the :dnsimple app to your mix.exs file as a dependency:

def deps do
    {:dnsimple, "~> 3.4.0"}, #...

And then add it to the list of applications that should be started:

def application do
  [applications: [
    :dnsimple, #...


From iex

# Create a client passing the proper settings
iex> client = %Dnsimple.Client{access_token: "TOKEN", base_url: ""}

# Check the login
iex> {:ok, response} = Dnsimple.Identity.whoami(client)
# => %{"account" => %{"created_at" => "2014-05-19T14:20:32.263Z",
# =>   "email" => "", "id" => 1,
# =>   "updated_at" => "2015-04-01T10:07:47.559Z"}, "user" => nil}

From an .exs file

# Start Dnsimple app

# Create a client passing the proper settings
client = %Dnsimple.Client{access_token: "TOKEN", base_url: ""}

# Check the login


Useful links

Sandbox Environment

We highly recommend testing against our sandbox environment before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.

The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the base_url option when you construct the client:

client = %Dnsimple.Client{base_url: "", access_token: "a1b2c3"}

You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will not work in the sandbox environment.


You can configure DNSimple inside of your app's config.exs. For example, if you have a development config, inside dev.exs:

config :dnsimple, base_url: ""
config :dnsimple, access_token: "secret"
config :dnsimple, user_agent: "my-app"

Now you can simply call client = Dnsimple.Client.new_from_env().


The client logs the requests made to the DNSimple API:

iex(2)> Dnsimple.Identity.whoami(client)

09:45:08.229 [debug] [dnsimple] GET
 %Dnsimple.Response{data: %Dnsimple.Whoami{account: %Dnsimple.Account{email: "",
    id: 63, plan_identifier: "dnsimple-professional"}, user: nil},
  http_response: %HTTPoison.Response{...},
  pagination: nil, rate_limit: 2400, rate_limit_remaining: 2398,
  rate_limit_reset: 1482745464}}

The log level used for this is debug. If you want to disable it you will have to configure the logging level of your app (as it's set to debug level by default).

config :logger, level: :info



client = %Dnsimple.Client{base_url: "", access_token: "a1b2c3"}
{:ok, response } = Dnsimple.Identity.whoami(client)

You can get your account_id from the response, if you don't know it.

account_id =

Setting a custom User-Agent header

You customize the User-Agent header for the calls made to the DNSimple API:

client = %Dnsimple.Client{user_agent: "my-app", access_token: "a1b2c3"}

The value you provide will be appended to the default User-Agent the client uses. For example, if you use my-app, the final header value will be dnsimple-elixir/1.0 my-app (note that it will vary depending on the client version).

Creating a domain

You will need:

  • The account_id of the account you want to create the domain for.
  • The registrant_id which is the ID of a contact of the corresponding account.
client = %Dnsimple.Client{base_url: "", access_token: "a1b2c3"}
{:ok, response} = Dnsimple.Domains.create_domain(client, account_id = 1010, %{name: "", registrant: registrant_id = 123})

Creating a record

You will need:

  • The account_id of the account you want to create the domain for.
  • The zone_id (can be the numeric ID or the name eg. "").
client = %Dnsimple.Client{base_url: "", access_token: "a1b2c3"}
{:ok, response} = Dnsimple.Zones.create_zone_record(client, account_id = 1010, zone_id = "", %{
  type: "CNAME",
  name: "provider",
  content: ""


Copyright (c) 2015-2023 DNSimple Corporation. This is Free Software distributed under the MIT license.