
JSON Connector
File- Overview
- Setup
- Data & mappings
- Operations & API
- Changelog
The JSON Connector ingests data from JSON documents that are delivered to a directory on the Brinqa platform (a file-drop / feed connector). It reads one or more JSON files from a configured data directory, extracts an array of records from each document using a configurable JsonPath expression, and maps every record to a single, configurable Brinqa Unified Data Model (UDM) target model.
The connector is intentionally schema-agnostic: it does not assume a fixed set of fields. Instead,
every key found in a JSON record becomes an attribute on the resulting connector object. This makes
it suitable for loading arbitrary third-party exports (asset inventories, scan results, CMDB
extracts, etc.) into any UDM model such as Host, Vulnerability, or a generic Record.
Data retrieved from Json Connector
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Record (configurable target) | Yes | Record (configurable target) |
Model relationships
For detailed steps on how to view the data retrieved from Json Connector in the Brinqa Platform, see How to view your data.
When the post-process option is enabled, each ingested file is renamed by appending .processed to the file name, so the same file is not ingested again on subsequent syncs.
Connection settings
When setting up a data integration, select Json Connector from the Connector dropdown and provide the following:
| Setting | Required | Default | Description |
|---|---|---|---|
| Json path | No | — | Represents a path inside the JSON document to easily access the array of objects with complex document. |
| Date fields | No | — | Comma separated list of fields in the json object that represent dates. |
| Date format | No | — | Date format to use when parsing date fields e.g. MM/dd/yyyy or static values of ISO_OFFSET and ISO_UTC. |
| Max age | No | — | Maximum number of days a file will be retained, any value less than 0 indicates forever. Zero indicates not to keep the file. |
| Max files | No | — | Maximum number of files to retain. Less than 0 indicates all and 0 indicates none. |
| Post Process | No | — | Rename or move the file after its processed. |
| Target | No | — | The target data model name to be map the provided data, e.g. Host, Vulnerability etc; default to 'Record' |
Authentication
This connector does not authenticate against a remote API. It operates entirely on the local filesystem of the Brinqa platform, reading JSON files that have been delivered to a configured data directory (for example by an SFTP drop, a mounted share, or a scheduled export job).
Because there is no HTTP endpoint, there are no authentication endpoints, request headers, tokens, or credential exchange. Access control is governed by the platform's filesystem permissions for the configured data directory. The relevant operational inputs are configured through the connector's configuration properties (see Configuration) — primarily the data directory path and the file-matching pattern.
Sync Behavior
The connector supports incremental (delta) syncs. It maintains a sync token between runs and applies it as an incremental timestamp filter, so each run re-processes only the records that changed after the previous sync. The initial run retrieves the complete data set; later runs are incremental. The specific timestamp field applied to each object is documented under that object's Sync Duration Parameter.
How to obtain Json Connector credentials
Obtain the required credentials (Data directory (dataDirectory), JSON path (jsonPath), Target (objectClassType)) from your Json Connector administrator or the Json Connector admin console, then enter them in the connection settings above.
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes:
Record (configurable target)
| Source Field Name | SDM Attribute |
|---|---|
| <JSON key> from the matched record | (every JSON key) |
| MD5 hash of the record's values | UID |
| MD5 hash of the record's values | NAME |
Operations & API
Expand each connector object to see its operation options, delta-sync behavior, and the API it uses. See connector operation options for how to apply operation options (keys and values are case-sensitive).
Record (configurable target)
Operation options
This object does not support any operation options.
Delta sync
Supported.
API
- Type: Local file (JsonPath query) · Endpoint:
Local filesystem — JSON files read from the configured
Changelog
The Json Connector connector has undergone the following changes:
| Version | Description | Migration Steps |
|---|---|---|
| 3.0.3 | Improvements Dependency Upgrades Upgraded internal framework and model libraries to the latest stable versions for improved reliability, security patches, and alignment with the rest of the connector platform. | N/A |
| 3.0.2 | Improvements - Refreshed the connector icon for a clearer, higher-resolution appearance in the data source catalog. | N/A |
| 3.0.1 | Improvements - Date fields are now recognized as proper date/time values in the generated schema, so configured date columns are mapped as timestamps rather than free-text strings. This produces more accurate parsing and consistent date handling across all imported records. | • Record: Fields listed under the Date fields configuration are now stored as date/time values instead of numeric or text values. Action: re-sync the data source after upgrading so existing records pick up the corrected date/time types. |
| 3.0.0 | Overview The Json File Connector ingests JSON files from a configured directory and maps each JSON object into a Brinqa data model, letting you onboard data from any JSON feed without a vendor-specific integration. Category: File Models | N/A |