Export API¶

Overview¶

The Export API enables you to extract data from the octoplant pro hub in a structured, automated manner. With this API, you can retrieve information such as device assets, component versions, job results, system logs, and vulnerability reports.

The Export API is available to tenant-level users with the appropriate permissions. It uses secure, token-based authentication and is built for flexible, high-performance data extraction, even at large scale.

The API offers several dedicated service endpoints, each focused on a specific data domain:

• Asset Information: Retrieve metadata about assets across servers.
• Components: Access detailed information about software and hardware components.
• Jobs: Obtain job configurations per server, along with results from executed jobs, including backup comparisons.
• Logs: Access administrative and operational log entries.
• CVEs: Retrieve data on common vulnerabilities and exposures (CVEs) related to your assets.

To use this feature, learn how to:

• Get and configure access to Export API
• Generate and revoke a token
• Access endpoints

Additional resources¶

• Export Gateway API
• Contact your system administrator to request changes to roles or permissions.