Skip to content

Endpoint access and authentication

To access any Export API endpoint, you must authenticate using a valid API token. A tenant administrator generates this token, as described in the Generating an access token section.

Session management

To authenticate using the Swagger UI:

  1. Open the Swagger UI interface: Export Gateway API
  2. In the top-right corner, select the Authorize button. A pop-up window will appear with a field labeled Authorization.
  3. Enter your token in the following format:
    Bearer your_token_here
  1. Select Authorize to confirm. If successful, you can now test endpoints directly.
  2. Use the Logout button to remove or replace the token.

While authorized, the system sends the bearer token with each API request in the Authorization header.

Note

The bearer token remains active until:

  • It reaches its expiration date
  • You manually revoke it
  • Your role permissions or tenant access change.

Available Endpoint Groups

The Export API provides access to six primary data categories:

Group Endpoint(s) Description
octoplant Server /octoplantservers Retrieves information about octoplant servers
Asset Information /assetinformation Retrieves asset metadata for specific or all servers
Components /componentinformation Retrieves information about software and hardware components
Jobs /jobs;/jobresults Retrieves job configurations per server and the results of executed jobs
Logs /adminlogs;/componentlogs;/eventlogs Retrieves entries from admin, component, and event logs
CVEs /cves;/cves/{cveId}/impact Retrieves common vulnerabilities and exposures related to system assets
Authentication /createtoken Validates an API key and generates a Bearer token for authenticated access

Each endpoint supports optional filters such as server_ids, component_key, pagination controls, and sort options, where applicable.

Example request

    GET /components?page_size=10&page_number=1&sort_order=asc&sort_field=server_id
    Authorization: Bearer <your_token_here>

This request includes common query parameters:

    /components:
    get:
        summary: Get component information
        parameters:
        - page_size
        - page_number
        - sort_order
        - sort_field

Note

To view the complete API specification, visit the Export Gateway API specification

Best practices

  • Use pagination for large datasets.
  • Use query parameters to filter by server or component key when possible.