Nebula API Key Management in Zyxel Networks: New Features and Enhancements

Zyxel_Claudia

In the latest release, version 18.20, Zyxel Networks has introduced significant updates to the Nebula API Key Management system, simplifying access and enhancing security for users. This article covers the new functionality, how it improves upon previous processes, and offers a step-by-step guide to using the updated API key management features.

Overview of Nebula API Key Management

The Nebula API allows Zyxel customers to integrate Nebula's network management capabilities into their own software platforms. This integration provides access to critical network device information and the ability to generate reports directly from within Nebula.

API Key Management Process Before Release 18.20: In previous versions, acquiring an API key was a complex process that required customers to submit a formal request to Zyxel's headquarters. Once approved by the product management team, a unique API key was generated and sent to the customer. However, if the key was ever compromised, or if there was a need for a new one, customers had to repeat this process by raising another ticket for approval. This method added time to the key issuance process and created dependency on Zyxel's internal approval flow.

API Key Management Process in Release 18.20

With the release of Nebula 18.20, Zyxel has greatly streamlined the API key management process, making it user-friendly, faster, and more secure. The new process allows customers to manage their own API keys through the Nebula Control Center, without needing to go through headquarters. Now, users can generate and regenerate API keys directly, giving them greater control and flexibility.

Key Features of the New API Key Management System:

1. Self-Service Key Generation: Users can now generate their own API keys from their personal accounts. This eliminates the need for a manual request and approval process, empowering users to create keys as needed.
2. Easy Key Renewal: If a new API key is required, users can generate it directly from the Nebula Control Center, providing more convenience and immediate access to a fresh API key when needed.
3. Simplified User Interface: The API key generation process is now accessible under the "User's Device and Service > API Key Management" section in the Nebula Control Center. Here, users can view, delete, or regenerate their API keys easily with just a few clicks.
4. Security Acknowledgment: To ensure security, users are prompted to acknowledge the importance of the API key, as it grants access to critical information about network configurations and settings. This security measure helps users understand the responsibility of key handling.
5. Direct Access to API Documentation: Zyxel has also enhanced the UI to provide links to comprehensive API documentation. Customers can now access guidance on how to integrate and utilize the Nebula Open API, making it easier for them to harness the full power of the Nebula platform.

Step-by-Step Guide: How to Generate an API Key

To generate a new API key using the Nebula Control Center, follow these simple steps:

1. Log into the Nebula Control Center: Access your account through the Nebula platform and navigate to the "API Key Management" section under "User's Device and Service."
2. Generate a New API Key: Click on the "Open API Key" option to start generating a key.
3. Acknowledge Security Measures: Acknowledge the importance of API key security by checking the prompt that appears. This step helps remind users of the security implications involved in API access.
4. Copy and Save the Key: Once generated, simply click the copy icon next to the API key. Paste it into your software or system for immediate integration.
5. Documentation and Integration Guides: For users interested in learning more about integrating Nebula’s Open API, Zyxel provides direct links to the documentation within the same UI. This documentation offers in-depth details on how to utilize the API key effectively in production.

Conclusion

The new API key management system in Nebula 18.20 represents a significant step forward in Zyxel's commitment to customer autonomy and security. The ability for users to manage API keys independently enhances the flexibility and security of network management, allowing seamless integration with Zyxel's powerful Nebula platform.

For more information, please refer to the Nebula API documentation available within the Nebula Control Center or reach out to our support team for any additional assistance.