Skip to main content

Fleet

Fleet is an open-source asset management tool that monitors and scans your hosts and software inventory for potential vulnerabilities. You can bring host, software, and security data from Fleet into Brinqa to form a unified view of your asset inventory and attack surface, thus strengthening your cybersecurity posture.

This document details the information you must provide for the connector to authenticate with Fleet and how to obtain that information from Fleet. 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 Fleet from the Connector drop-down. You must provide the following information to authenticate Fleet with Brinqa:

  • API URL: The Fleet API Server URL.

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

Generate a Fleet API token

For the Fleet connector to retrieve data from the Fleet REST API, you must provide an API token. To do so, follow these steps:

  1. Log in to your organization's Fleet account as an administrator.

  2. Click the profile photo and then click My account from the drop-down.

  3. Click Get API token.

    Your new API token displays. You can not view the token again after this. Copy and save it to a secure location.

    Fleet API token

  4. Click Done.

info

While any user can create API tokens to retrieve data from the Fleet API, Fleet recommends creating an API-only user, as tokens for regular users frequently expire, which can cause disruptions in your workflows. Additionally, the API-only user is assigned the Observer role by default, which is the minimum role required for API access. Fleet Premium customers can also assign team-level access for stricter access. For additional information, see Fleet documentation.

note

If you do not have permissions to create an API token, contact your Fleet administrator. For additional information, see Fleet documentation.

Additional settings

The Fleet connector contains additional options for specific configuration:

  • Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.

  • Parallel requests: The maximum number of parallel API requests. The default setting is 4.

Types of data to retrieve

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

Table 1: Data retrieved from Fleet

Connector ObjectRequiredMaps to Data Model
HostYesHost
Installed PackageYesInstalled Package
PackageYesPackage
VulnerabilityYesVulnerability
Vulnerability DefinitionYesVulnerability Definition
info

The Fleet 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 Fleet 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.

Host

Table 2: Host attribute mappings

Source Field NameMaps to Attribute
buildLocal variable
code_nameLocal variable
computer_nameLocal variable
config_tls_refreshLocal variable
cpu_brandLocal variable
cpu_logical_coresLocal variable
cpu_physical_coresLocal variable
cpu_subtypeLocal variable
cpu_typeLocal variable
created_atsourceCreatedDate
detail_updated_atLocal variable
distributed_intervalLocal variable
display_nameLocal variable
display_textLocal variable
encryption_key_availableLocal variable
enrollment_status (mdm)Local variable
failing_policies_count (issues)Local variable
gigs_disk_space_availableLocal variable
hardware_modelLocal variable
hardware_serialserialNumber
hardware_vendorLocal variable
hardware_versionLocal variable
hostnamehostnames
iduid
label_updated_atLocal variable
last_enrolled_atLocal variable
logger_tls_periodLocal variable
memoryLocal variable
name (mdm)Local variable
os_versionoperatingSystem
osquery_versionLocal variable
pack_statsLocal variable
percent_disk_space_availableLocal variable
platformLocal variable
platform_likeLocal variable
policy_updated_atLocal variable
primary_ipipAddresses
primary_macmacAddresses
public_ippublicIpAddresses
refetch_critical_queries_untilLocal variable
refetch_requestedLocal variable
server_url (mdm)Local variable
seen_timelastSeen
software_updated_atLocal variable
statusstatus
team_idLocal variable
team_nameLocal variable
total_issues_count (issues)Local variable
updated_atsourceLastModified
uptimeLocal variable
uuidLocal 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.

Installed Package

Table 3: Installed Package attribute mappings

Source Field NameMaps to Attribute
bundleIdentifierLocal variable
cve (vulnerabilities)cveIds
details_link (vulnerabilities)Local variable
generated_cpeaffected
host.idtargets
iduid, type
installedPathsLocal variable
namename
sourceLocal variable
versioncurrentVersion
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.

Package

Table 4: Package attribute mappings

Source Field NameMaps to Attribute
archLocal variable
cve (vulnerabilities)Local variable
details_link (vulnerabilities)Local variable
generated_cpecpeIds
hosts_countLocal variable
iduid
namename
releaseLocal variable
sourceLocal variable
vendorLocal variable
versioncurrentVersion
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.

Vulnerability

Table 5: Vulnerability attribute mappings

Source Field NameMaps to Attribute
iduid
statusstatus, sourceStatus, statusCategory
targettargets
vulnerability.cvetype
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.

Vulnerability Definition

Table 6: Vulnerability Definition attribute mappings

Source Field NameMaps to Attribute
cvecveIds, cveRecords, name, uid
detailsLinkdescription, references
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 Fleet connector uses the Fleet REST API v1. Specifically, it uses the following endpoints:

Table 7: Fleet REST API Endpoints

Connector ObjectAPI Endpoint
HostGET /api/v1/fleet/hosts
Installed PackageGET /api/v1/fleet/hosts
GET /api/v1/fleet/hosts/{Id}
PackageGET /api/v1/fleet/software
VulnerabilityGET /api/v1/fleet/hosts
GET /api/v1/fleet/hosts/{Id}
Vulnerability DefinitionGET /api/v1/fleet/hosts
GET /api/v1/fleet/hosts/{Id}

Changelog

The Fleet connector has undergone the following changes:

3.0.0