How do I troubleshoot issues using the Auvik API?

If you're encountering issues while using the Auvik API, this guide walks you through common problems such as credential errors, authorization issues, and missing data. Each section includes symptoms and step-by-step solutions to help you identify and resolve problems quickly.

For complete reference materials, see:

• Auvik API Integration Guide

• Auvik API Reference

Invalid Credentials

Scenario
You receive a 401 Unauthorized error when trying to authenticate with the Auvik API.

Solution
Confirm the username and API key are correctly entered. Authentication must be provided in the Authorization header using this format:

Authorization: Basic base64(username:api_key)

You can verify your credentials by calling the /authentication/verify endpoint. To test it using curl (replace the region subdomain with your Auvik region):

curl -u 'user@example.com:apiKey' 'https://auvikapi.<your-region>.my.auvik.com/authentication/verify'

To find your Auvik region, see: Where is my Auvik region located?

If you're unable to resolve the issue using the steps above, reach out to Auvik Support for further assistance.

Not Authorized

Symptom
You receive a 403 Forbidden response from the API when accessing certain endpoints.

Solution – Troubleshooting Steps

• Confirm that the authenticated API user has been granted an appropriate role (e.g., API permissions with read-only or higher) in the tenant(s) being queried.

• If you're unable to resolve the issue using the steps above, reach out to Auvik Support for further assistance. Be sure to include the full API request(s) you're trying to make, including the endpoint, headers, and request body if applicable.

Missing Data

Symptom
A request completes successfully (200 OK) but returns no or only partial results.

Solution – Troubleshooting Steps

Case A – Pagination Not Handled
The data may span multiple pages. Look at the links object in the response. If you see a next field, that indicates more pages are available and provides the endpoint to call for the next page.

If you're unable to resolve the issue using the steps above, reach out to Auvik Support. Include the full API request(s), including the endpoint, headers, request body, and response body if applicable.

Case B – No Data in the Auvik UI
Data won’t appear in the API if it doesn’t exist in the Auvik UI. For example, there may be no discovered devices, alerts, or configuration backups.

Log in to the Auvik UI for the tenant and navigate to the relevant section to confirm the presence of data. If the UI is also empty, data collection may not have started, or devices may not be discovered.

If you're unable to resolve the issue using the steps above, reach out to Auvik Support. Include the full API request(s), including the endpoint, headers, request body, and response body if applicable.

Rate Limit Exceeded

Symptom
You receive a 429 Too Many Requests error when calling the Auvik API.

Solution – Troubleshooting Steps

• Auvik enforces rate limits to prevent abuse and ensure platform stability.

• When a request exceeds the allowed limit, a 429 error is returned.

• Implement exponential backoff or wait-and-retry logic in your integration to handle these scenarios gracefully.

• If your use case requires higher throughput, review the number of requests your integration is making and determine whether they can be batched or optimized.

Server Error

Symptom
You receive a 500 Internal Server Error when calling the Auvik API.

Solution – Troubleshooting Steps

• A 500 error indicates a problem on the Auvik API server. Retry the request after a short delay.

• If the issue persists, contact Auvik Support. Include the full API request(s), including the endpoint, headers, and request body if applicable.

API Error Reference

More error details can be found in the Auvik API Integration Guide – Errors.