Axe Monitor API

Introduction

The Axe Monitor API offers users a streamlined way to interact with accessibility test result data and manage scans outside the Axe Monitor user interface. Using RESTful web services, the API provides access to endpoints for various use cases:

• Get Axe Monitor Results
• Create Scans
• Run Scans
• Edit Scans

Additional endpoints return necessary information when creating or editing scans:

• Get IDs by API
• Get Current Settings

Licensed Axe Monitor users can use the API with outside applications, provided that usage complies with the Subscription License Agreement. Only Axe Monitor admins can create, edit or run scans via the API.

Getting Started

1. Create an API key via axe Account.

   • On the API Keys page in xe Account, Select the "Add New API Key" button.
   • A modal will appear. Select Axe Monitor from the product dropdown, name your API key, and select the Save button.
   • Under the Actions column, copy the API key to your clipboard.

2. Enter the API base URL: Using your preferred API platform, such as Postman or SwaggerUI, or your working directory, access the axe Monitor API. Replace “yourcompany” with the subdomain for your axe Monitor instance.

https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}

3. Add Headers: To access the API, you need to authenticate using the API key from axe Account.

X-API-Key: <your_api_key>

Optional Header Parameters

Example CURL Request

curl -X 'GET' \
  'https://{base_url}/monitor-public-api/v1/scans/1/runs/1/issues?sortBy=testPageTitle&order=desc' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <your_api_key>'

General Errors

These errors can occur on any request. Specific additional errors can occur for specific endpoints and are documented with each endpoint.