runZero
Collect runZero asset inventory and exposed services
The runZero connector allows you to retrieve asset discovery and network visibility data from your runZero instance.
Overview
The runZero connector enables you to collect the following information:
- Discovered asset inventory
- Exposed services and ports
- Unmanaged equipment
Prerequisites
- Access to a runZero instance
- runZero API token generated
- API access permissions configured
Information to provide in OverView
| Field | Description |
|---|---|
| API URL | runZero API URL (e.g., https://api.runzero.com) |
| API Key | runZero API key |
Parameters
These parameters are optional. Leave them at their default value unless you have a specific reason to change them.
| Parameter | Description | Default |
|---|---|---|
| Use Latest Scans Only | Only use data from latest scans | Disabled |
Configuration
Generate a runZero Export Token
- Log in to your runZero instance.
- Navigate to the Organizations page from the main menu.
- Select the organization you want to integrate with OverView.
- Click Edit organization.
- Go to the Export tokens section.
- Click Create a new export token.
- Give it a descriptive name (e.g., OverView Connector).
- Click Create.
- Immediately copy the token value (it will only be displayed once). Export tokens have the format
XT_...and are read-only.
Note: For OverView integration, Export Tokens are recommended as they provide read-only access to asset discovery data. Other token types (Organization API Token, Account API Token) are also available for different use cases.
Configure the connector in OverView
- In OverView, go to Data Sources Settings > Sources.
- Select runZero and click Configure.
- Fill in the required fields:
- API URL: https://api.runzero.com (or your instance URL)
- API Key: Your Export Token
- Click Save Configuration.
Reference: runZero API - Leveraging the API
Required Permissions
The API key must have the following minimum permissions:
- Read access to asset inventory
- Access to service and port information
- Access to network scan results
Alternative: file import through DropPoint
The API access described above is the recommended method for this connector. Where it is not available (a segregated network, a version or licence without API, an export you already produce), OverView accepts file exports, to be uploaded to the bucket dedicated to runZero.
Bucket : s3://runzero/
Example : s3://runzero/export.csv
The procedure is described in the OverView DropPoint guide: generating credentials, configuring the client, then sending files from the OverView web interface, the AWS CLI or an SDK. Its examples come pre-filled with this bucket when you follow this link.