API Access Token

Table of Contents

If you would like to access the DNSimple API v2 you will need an access token.

One option for getting an access token is to use OAuth, however if you want a simple token you can use with your account directly, without needing to perform the OAuth dance, then you can generate an access token through the DNSimple web site.

Account tokens vs User tokens

API v2 offers 2 types of tokens: account tokens and user tokens.

The user token gives you access to any resource associated to any account the user has access to. Conversely, an account token gives you access only to the resources connected to that account.

We recommend to use account tokens, unless your application needs multi-account access via single token.

Getting to the Account Access Token page

To generate an account access token, log into your account and navigate to your account page.

Once you are there click on the link in the left menu.

Access Tokens Link

Here you can see all of your account access tokens, add new access tokens and remove existing access tokens.

Generating an Account Access Token

Click on the link to add a new access token.

New Access Token

When you create a new token you need to give it a name that you will use to remember it. After you’ve entered a name, click on to create the token.

Generate Token

Make sure to copy the text for the access token as it will only be shown once.

Token Generated

With this access token you may now access the API using the HTTP header Authorization: Bearer {TOKEN}, replacing {TOKEN} with the value taken from the page when the token is generated. If you’d like additional information on how to access the API with the newly generated token, please visit the authentication section on the DNSimple Developer site.

Removing an Account Access Token

You can also remove a token at any time by using the button.

Remove Token