API Access Token

Table of Contents

If you want to access the DNSimple API v2, you need an access token.

This article covers generating account tokens and user tokens. If you want to create an application that requires access to DNSimple, or let an external application request authorization to private details in a user’s DNSimple account without getting their password, you’ll need an OAuth Token instead.

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. An account token gives you access only to the resources connected to that account.

We recommend using 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

This shows all of your account access tokens and allows you to add new access tokens, or 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 you can remember. After you’ve entered a name, click on to create the token.

Generate Token

Copy the text for the access token – it will only be shown once.

Token Generated

You can now access the API with this token 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