管理と報告

Cloud CNM SecuReporter

Zyxel SecuReporter OpenAPI

Find resources to help automate and quickly build custom-developed applications with APIs for Zyxel SecuReporter platform.

Accessing Device Data with SecuReporter OpenAPI Service

SecuReporter supports an interface for software to directly interact with the SecuReporter cloud platform.
These APIs empower SecuReporter users to retrieve device logs from the past 31 days using an API token.

With the SecuReporter OpenAPI, you can easily access your device data through HTTP requests using any programming language or cURL commands. To utilize this service, ensure your device has a valid SecuReporter license and an OpenAPI Token. These credentials are necessary to authenticate and authorize your requests to the API.

Discover the Ultimate Benefits of SecuReporter’s OpenAPI Token

Streamline your workflows, enhance scalability and enable seamless automation. Experience a secure, efficient and user-friendly method for accessing firewall log files, designed to support both manual and automated processes.

Convenience and Efficiency

Access your firewall logs directly through HTTP requests using any programming language or cURL commands—no portal login needed. This streamlines your workflow, saves time and is perfect for automated systems or scripts requiring regular log retrieval.

Scalability

OpenAPI tokens enable scalable access to firewall logs. Generate multiple tokens for different users or systems, ensuring flexibility and control.

Automation Capability

Integrate seamlessly with other systems and software using API tokens. Automate the retrieval of firewall logs and incorporate this data into your Security Information and Event Management (SIEM) systems without manual intervention.

Why integrate SecuReporter’s OpenAPI Token?

SecuReporter provides a secure, efficient and user-friendly method for accessing firewall log files. Support both manual and automated processes while maintaining high security standards. For more detailed information about SecuReporter OpenAPI integration and more, please visit our GitHub.

Zyxel GitHub

Seamless Integration FAQ

Don't worry, we've got you covered! While you explore how to integrate OpenAPI with SecuReporter, here are some helpful tips and FAQs to guide you through the process.

The Archived Logs Service is the inaugural open service offered by SecuReporter OpenAPI. It enables users to retrieve firewall logs dating back up to 31 days using an API token. Each API token grants a maximum of 50 API requests per hour. Stay tuned for upcoming services to be released in the future.

Please forward the ticket/case email to your local Zyxel sales or sales engineer to validate your feature request in terms of its impact

Prerequisites:

Ensure that your firewall device has an active SecuReporter license and that the SecuReporter service is enabled. If your license has expired, please contact the device owner or purchase a new license from the Zyxel marketplace to access the OpenAPI Service.

Steps to Generate OpenAPI Token on SecuReporter:

Step 1: Select the device with a valid SecuReporter license and click on the "API Access" button.

Step 2: Click "Create New API Token" button.

Step 3: Copy the OpenAPI Token.

Two methods are provided for testing the OpenAPI: cURL and Python.

[1] Testing with cURL

  • Setup: To check if cURL is installed, open your Command Prompt or Terminal and type curl. If you receive an error stating that cURL is not found, follow the installation instructions available on the cURL GitHub repository.
  • Making Your First OpenAPI Request: Open your Command Prompt/Terminal and use the following command. Replace yyyy-MM-dd with a date within the past 31 days (excluding the current date) using the yyyy-mm-dd format. mydir with your actual download folder path on your computer.

macOS

curl -X POST \

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download \

-H "Content-Type: application/json" \

-H "X-Authorization: Bearer $OPEN_API_TOKEN" \

-d "{\"device_date\":\"yyyy-MM-dd\"}" \

-o mydir/archive.tar

Windows

curl -X POST ^

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download ^

-H "Content-Type: application/json" ^

-H "X-Authorization: Bearer %OPEN_API_TOKEN%" ^

-d "{\"device_date\":\"yyyy-MM-dd\"}" ^

-o mydir\archive.tar

Replace "https://api.example.com/endpoint" with the actual API endpoint and "your_api_token" with your API token.

[2] Testing with Python

  • Verify Python Installation: To check if Python is installed, open your Command Prompt or Terminal and type ‘python’. If you receive an error stating that Python is not found, you can install it by following the instructions available on the official Python website. Ensure you have Python 3.8 or newer installed to use the Requests library.
  • Create and Activate a Virtual Environment:
    Create a Project Directory and Virtual Environment: Follow the official Python venv documentation to create your virtual environment in a project directory.

macOS

source your-virtual-environment-path/bin/activate

Windows

your-virtual-environment-path\Scripts\activate

Replace your-virtual-environment-path with the actual path to your virtual environment directory.

Each site can generate one API token, which can be utilized by multiple systems or software applications. However, there is a usage restriction of 50 requests per hour for each API token.