Auvik provides separate API families for Auvik SaaS Management (ASM) and Unified Network Management. The authentication method, entitlement requirements, and available data depend on which API family you are using.
Use the API family that matches the data you need. ASM credentials cannot be used with Unified Network Management endpoints.
ASM and Unified API differences
ASM API
- Provides access to SaaS Management data, such as monitored users, applications, clients, security logs, tags, and licenses.
- Uses the authentication method and credentials documented in the ASM API reference.
- Is available for Auvik SaaS Management data.
Unified Network Management API
- Provides access to Unified data from Auvik Network Management and, where applicable, Auvik SaaS Management.
- Uses Basic authentication with a user-generated Auvik API key and secret.
- Requires an active Auvik Network Management subscription in addition to SaaS Management.
- Requires the API user to have access to the requested tenant and the role permissions required for the endpoint.
ASM monitored users versus Auvik platform users
The ASM API’s monitored-users data refers to users observed or managed through Auvik SaaS Management.
It does not provide a list of Auvik platform users, administrators, roles, or permissions. Those are managed through the Auvik user-management interface.
ASM API authentication
Use the ASM credentials and authentication method provided for your ASM environment.
Example format:
curl
-H "X-API-KEY: <ASM_PUBLIC_KEY>"
-H "X-API-SECRET: <ASM_SECRET>"
-H "Accept: application/json"
"https://<ASM_REGION_API_HOST>/<ASM_ENDPOINT>"
Use the complete secret value exactly as provided. Do not split, decode, or truncate the secret, even if it contains multiple base64-looking segments or ends with characters such as “==”.
Use the endpoint URL shown in the current ASM API reference for your region and environment.
Unified Network Management API authentication
Generate or obtain a Network Management API key and secret for a user with the required tenant access and role permissions.
Authenticate using Basic authentication, with the API key as the username and the API secret as the password:
curl -u "<NM_API_KEY>:<NM_API_SECRET>"
-H "Accept: application/json"
"https://<NM_REGION_API_HOST>/<NM_ENDPOINT>"
Use the regional Unified API base URL that matches the tenant being queried. For the current URL format and available endpoints, see the Auvik API Integration Guide and the relevant API reference article.
Entitlements and credential scope
ASM credentials:
- Work with ASM API endpoints.
- Do not authenticate requests to Unified Network Management endpoints.
Unified Network Management credentials:
- Require an active Network Management subscription.
- Must belong to a user authorized for the tenant being queried.
- Must have the role permissions required for the requested API.
If an integration needs both ASM and Unified Network Management data, create and maintain separate credentials and route each request to the appropriate API family.
Regions and connectivity
- Use the regional API host that matches the tenant.
- Confirm the correct region in the applicable API documentation or Auvik tenant information.
- Ensure outbound HTTPS access is permitted to the required regional API host.
- Confirm that TLS requirements and certificate validation are supported by the client making the request.
Troubleshooting authentication errors
HTTP 401 Unauthorized
Check the following:
- The credentials belong to the correct API family.
- The API key or secret was copied without whitespace or truncation.
- Basic authentication is formatted correctly for Unified API requests.
- The ASM authentication headers are present and spelled correctly.
- The key has not been revoked, rotated, or disabled.
HTTP 403 Forbidden
A 403 response commonly indicates that the credentials are valid but not authorized for the requested API family, tenant, or endpoint.
Check the following:
- The subscription includes the API family being used.
- The API user is authorized for the requested tenant.
- The user’s role includes the required API permissions.
- The request is being sent to the correct regional API host.
- The endpoint belongs to the API family associated with the credentials.
HTTP 404 Not Found
Check that:
- The API host is correct.
- The endpoint path is correct.
- The endpoint is available in the selected API family.
- Tenant, client, or entity identifiers are valid.
Testing a new credential
- Confirm that the credential belongs to the correct API family.
- Send a minimal GET request to a lightweight endpoint documented for that API.
- Confirm that the response is successful and contains the expected data.
- Test the specific endpoint required by the integration.
- Review the response for tenant scope, pagination, and expected fields.
Security best practices
- Use separate credentials for ASM and Unified Network Management.
- Use a dedicated service account for integrations where appropriate.
- Apply the least-privilege role required for the integration.
- Store keys and secrets in a secrets manager.
- Do not include API secrets in source code, tickets, screenshots, or logs.
- Rotate credentials according to your organization’s security policy.
- Monitor failed authentication and authorization attempts.