Quick Overview

The API Access page in zWAN provides essential onboarding credentials required for Edge controller integration. This includes the management portal access URL, API key, and trusted certificate authority (CA) certificate. These credentials are used during the initial onboarding of Edge controllers to securely connect them to the Director.

How to Use This Feature in the UI

1. Navigate to the API Access section within the zWAN Director interface.
2. Review the following critical onboarding elements:
   • Management Portal Access URL – The address Edge devices will use to connect to the Director.
   • Management Portal Access Key (API Key) – A secure token required for onboarding Edge devices.
   • Trusted CA Certificate – The certificate authority used to verify Director authenticity during the onboarding process.
3. Use these values when configuring new Edge controllers to securely register them to your tenant.
4. Regenerating the API Key:
   • If the API key is compromised or rotated, click Regenerate Key.
   • Important: All Edge controllers must be re-onboarded with the new key.

Concepts & Use Cases

• Secure Device Onboarding: Edge controllers use the access key and CA certificate to establish trusted communication with the Director during initial registration.
• Credential Centralization: Administrators can centrally view, copy, and rotate onboarding credentials as needed from one interface.
• Tenant-Specific Tokens: Each tenant’s API key is unique, preventing cross-environment misconfiguration or data leakage.
• Regulatory Compliance: Secure onboarding using certificates aligns with zero-trust and PKI-based security models.

Troubleshooting & FAQs

• What happens if I regenerate the API key?
  All previously onboarded Edge controllers will lose their ability to communicate with the Director. You must re-onboard them using the new access key.
• Can I use the same API key across all Edge controllers?
  Yes, the key is valid for onboarding any number of Edge devices within the same tenant.
• Is the CA certificate required for onboarding?
  Yes. The Edge controller uses the CA to validate the authenticity of the Director during the SSL handshake.
• How do I re-onboard an Edge controller?
  Re-enter the new access key and CA certificate on the Edge controller’s interface, then restart the onboarding workflow.