Obtaining an axe-linter SaaS API Key

Link to Obtaining an axe-linter SaaS API Key copied to clipboard

This document describes how to obtain an API key to use with axe-linter SaaS. If you are using the on-premises version of axe-linter, you don't need to follow these instructions because the on-premises server doesn't require authentication for access.


The axe-linter SaaS offering needs an API key to authorize your use of the linter-source REST endpoint by adding an Authorization HTTP header to your request. For example, the following shows an example authorization header with a sample API key:

Authorization: cc57ffb2-aa21-4cc2-a11a-0257779b9909

The key is not valid, but is included so you can see what an API key looks like.

Steps for Obtaining an API Key

In order to obtain an API key for axe-linter SaaS, you need to have an active trial or license. If you do not have one already, visit the trial request page to get started.

Once you have access, you can obtain an API key by visiting API Keys. After you log in, you will see a screen similar to the following:

Screen shot of axe.deque.com settings page. This is where you can manage your axe-linter SaaS and other API keys. .

Click on the ADD NEW API KEY button, and you will see the following:

Screen shot of interface for obtaining a new API key. .

Make sure you select axe Linter under Product, give the key a name under Project name, and click on SAVE.

Finally, Manage API Keys will be displayed, as shown below.

Screen shot of the Manage API Keys web page showing the newly created API key.

Click on the button indicated by the arrow to copy your new API key to the clipboard. You'll see a message at the top of the screen that indicates that the API key was successfully copied as shown in the above screen shot.

Next Steps

You can now use your API key to access axe-linter SaaS.

See Getting Started Developing with axe-linter Server for a getting started guide to using the REST APIs provided by the axe-linter Server.

If you'd like to read the reference guide to the REST interface provided by the axe-linter Server, see the axe-linter Server REST API Reference