How to troubleshoot an API credential from the Auvik collector shell

1. SSH into the Auvik Collector

Log in using the credentials provided during the collector installation (typically auvikuser).

ssh auvikuser@[collector_ip]

Note: If you are using an Ubuntu collector, you will need to enable remote access. For information on how to do that, click here.

2. Test API Access with curl or httpie

Depending on the API you're testing, use curl to manually send a request:

For Basic Auth:

curl -u [username]:[password] https://[api_endpoint]/api/status

For Token-Based Auth (e.g., Bearer Token):

curl -H "Authorization: Bearer [api_token]" https://[api_endpoint]/api/status

For APIs that use headers like API keys:

curl -H "X-API-Key: [api_key]" https://[api_endpoint]/api/status

Replace https://[api_endpoint]/api/status with the correct endpoint for your integration.

Examples:

• Meraki APIs:

curl https://api.meraki.com/api/v1/organizations -L -H 'Authorization: Bearer [MERAKI-API-KEY]'

• Fortinet APIs:

curl -vk https://1.2.3.4:443/api/v2/monitor/system/time?access_token=[api_key]

3. Check DNS and Connectivity

Ensure the collector can resolve and reach the API endpoint:

ping [api_endpoint]
dig [api_endpoint]
curl -I https://[api_endpoint]

4. Inspect API Responses

Look for HTTP response codes:

• 200 OK = success
• 401 Unauthorized or 403 Forbidden = credential issue
• 404 Not Found = incorrect URL
• 500 or 503 = server error (API side)

5. Review Collector Logs for API Errors

Check the collector logs for any error messages related to API polling:

sudo tail -n 100 /var/log/auvik/<log file name>

Look for lines related to API polling failures or credential errors.