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.

Inventory API permission

Symptom

You receive a 403 Forbidden response when calling an Inventory API endpoint, even though the API credentials are valid or the user has administrator access in the Auvik interface.

Cause

The API user’s assigned role does not include the required Inventory API permission. Access to the Auvik interface does not automatically provide access to Inventory API endpoints.

Resolution

Ask an authorized Auvik administrator to:

1. Go to Settings > Users & Roles or Settings > Roles.
2. Open the role assigned to the API user, or create a dedicated API role.
3. Enable the Inventory API permission.
4. Save the role.
5. Confirm that the API user has access to the tenant and sites being queried.

After the role is updated, refresh the API user’s session or regenerate the API credentials if required by the authentication method. Retry the request using a simple read-only Inventory API call.

Common authorization errors

• 403 Forbidden: The API user may be missing the Inventory API permission or access to the requested tenant or site.
• 401 Unauthorized: Verify the username, API key, token validity, and authentication format.
• API access works for some endpoints but not Inventory endpoints: Confirm that the role includes the specific API permission required for the Inventory endpoint.

Fixing 403 Forbidden errors

A 403 Forbidden response means that Auvik received and recognized the API credentials, but the user is not authorized to access the requested resource.

Check the following:

Confirm tenant and site access

Confirm that the API credentials belong to a user who has access to the target tenant and any sites included in the request.

An API user may be authorized for one tenant or site but receive a 403 Forbidden response when requesting data from another.

Confirm API role permissions

Ask an Auvik administrator to verify that the API user’s assigned role includes the API permission required by the endpoint.

Some endpoints require additional tenant or site access. The required permissions depend on the API being used and whether the request is made at the multi-site or site level.

Confirm the API URL and credentials

Verify that:

• The request uses the correct regional Auvik API base URL.
• The tenant or site identifier is correct.
• The API key or token is current and has not been revoked or replaced.
• The request uses the correct authentication format.

If the credential was recently rotated or regenerated, update the integration or script with the current credential. Do not include the credential when sharing troubleshooting details.

Test a basic endpoint

Test a low-scope read-only endpoint, such as listing accessible tenants or sites.

• If the basic request succeeds but the intended endpoint returns 403, the issue is likely endpoint-specific permissions or scope.
• If the basic request also returns 403, verify the API user’s tenant authorization and role permissions.

If access previously worked

Check whether:

• The API user’s role was changed.
• Tenant or site authorization was removed.
• The integration was moved to a different tenant or region.
• The API key or token was rotated or revoked.
• A policy or permission change affected the endpoint.

If the issue continues, contact Auvik Support and provide:

• The API endpoint and HTTP method.
• The tenant or site being queried.
• The HTTP status code.
• The response body and headers, with credentials and other secrets removed.
• The date, time, and timezone of the failed request.
• The last time the request worked, if known.

Best practices

• Use a dedicated service account for API integrations.
• Assign only the API permissions required by the integration.
• Store API credentials securely and rotate them periodically.
• Test with read-only requests before enabling workflows that modify data.

If the issue continues, provide Support with the API endpoint, HTTP method, status code, tenant or site being queried, and the full error response. Do not include the API key or other secrets.

API Error Reference

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