Skip to main content

runZero

runZero (formerly Rumble Network Discovery) is an asset management tool that discovers, identifies, and manages assets across your environments. You can bring asset and security data from runZero into Brinqa to gain insights into the relationships between your vulnerabilities and assets, thus constructing a unified view of your attack surface.

This document details the information you must provide for the connector to authenticate with runZero and how to obtain that information from runZero. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select runZero from the Connector drop-down. If you cannot find the connector in the drop-down, make sure that you have installed it first. You must provide the following information to authenticate runZero with Brinqa:

  • API URL: The runZero API URL. The default URL is https://console.runzero.run.

  • API token: The Organization API or Export token associated with the runZero account, which must have permissions to log in to the API server and return data.

Generate a runZero API token

For the runZero connector to access the runZero API, you must provide an API token. To generate a new API token, follow these steps:

  1. Log in to your organization's runZero console as an administrator.

  2. Click Organizations in the menu.

  3. Click the organization you want to generate a token for, and then click Edit organization.

  4. Locate the API token section on the page. You have two options:

    • Export token: Provides a read-only access token that lets you extract inventory data from your organization within runZero. Its primary function is to allow this data to be transferred or integrated into other platforms or systems. Click Generate export token if you want to use this token.

    • Organization API: Provides a broader level of access, allowing administrative operations within your organization's resources in runZero. In addition to its own specific uses, the Organization API key can be employed for accessing the Export API. Click Generate API key if you want to use this token.

    Copy the token and save it in a secure location.

  5. Click Save.

note

If you do not have permissions to generate a token, contact your runZero administrator. For additional information, see runZero documentation.

Additional settings

The runZero connector contains an additional option for specific configuration:

  • Skip certificate verification: Select this option to allow for untrusted certificates.

Types of data to retrieve

The runZero connector can retrieve the following types of data from the runZero API:

Table 1: Data retrieved from runZero

Connector ObjectRequiredMaps to Data Model
AssetYesDevice
VulnerabilityYesVulnerability
Vulnerability DefinitionYesVulnerability Definition
info

The runZero connector does not currently support operation options for the types of data it retrieves.

For detailed steps on how to view the data retrieved from runZero in the Brinqa Platform, see How to view your data.

Attribute mappings

Expand the sections below to view the mappings between the source and the Brinqa data model attributes.

Asset

Table 2: Asset attribute mappings

Source Field NameMaps to Attribute
aliveLocal variable
asset_typecategories, Local variable
created_atsourceCreatedDate
detected_byLocal variable
first_seenfirstSeen
hardwareLocal variable
ipv4_addressipAddresses, publicIpAddresses, privateIpAddresses
ipv6_addressipAddresses, publicIpAddresses, privateIpAddresses
last_seenlastSeen
mac_addressmacAddress
mac_vendorsLocal variable
namesLocal variable
open_portsLocal variable
org_idLocal variable
org_nameLocal variable
osos
os_versionos
site_idLocal variable
site_nameLocal variable
statusstatus
sys_iduid
tagstags
updated_atsourceLastModified
Vulnerability

Table 3: Vulnerability attribute mappings

Source Field NameMaps to Attribute
STATUSstatus
STATUS_CATEGORYstatusCategory
vulnerability_asset_idtargets
vulnerability_attributesLocal variable
vulnerability_created_atsourceCreatedDate
vulnerability_first_detected_atfirstSeen
vulnerability_iduid
vulnerability_last_detected_atlastSeen
vulnerability_organization_idLocal variable
vulnerability_service_addressLocal variable
vulnerability_service_portport
vulnerability_service_transportLocal variable
vulnerability_source_idLocal variable
vulnerability_updated_atsourceLastModified
Vulnerability Definition

Table 4: Vulnerability Definition attribute mappings

Source Field NameMaps to Attribute
vulnerability_descriptiondescription
vulnerability_severity_scoreLocal variable
vulnerability_namename
vulnerability_severityseverity, severityScore
vulnerability_cvss2_temporal_scorecvssV2TemporalScore
vulnerability_solutionrecommendation
vulnerability_cvss2_base_scorecvssV2BaseScore
vulnerability_cveuid, cveIds
vulnerability_cvss3_temporal_scorecvssV3TemporalScore
vulnerability_categorycategories
vulnerability_cvss3_base_scorecvssV3BaseScore
vulnerability_vuln_idtype, uid
vulnerability_published_atpublishedDate
vulnerability_cpe23affected
vulnerability_risk_scoreLocal variable
vulnerability_riskLocal variable
info

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

APIs

The runZero connector uses the runZero API. Specifically, it uses the following endpoints:

Table 5: runZero API Endpoints

Connector ObjectAPI Endpoint
AssetGET /api/v1.0/export/org/assets.json
VulnerabilityGET /api/v1.0/export/org/vulnerabilities.json
Vulnerability DefinitionGET /api/v1.0/export/org/vulnerabilities.json

Changelog

The runZero connector has undergone the following changes:

Table 6: runZero connector changelog

VersionDescription
3.0.3Added support for Data lifecycle management to the Asset and Vulnerability objects.
3.0.2Updated dependencies.
3.0.1Added a new additional setting to skip certificate verification: Skip certificate verification.
3.0.0Initial Integration+ release.