Brinqa Connect
Brinqa Connect is a resource that Brinqa provides for you to send custom, unstructured data to the Brinqa Platform using the Brinqa Connect API. The API provides ingress and egress capabilities along with encryption-at-rest to protect your data.
After utilizing the Brinqa Connect API to ingest your data, you can proceed to create a data integration that leverages the Brinqa Connect connector. You can think of Brinqa Connect as a transient repository for your proprietary data, which can now be brought into the Brinqa Platform through a connector.
The following section details the information you must provide for the connector to authenticate with Brinqa Connect and how to obtain that information. See create a data integration for step-by-step instructions on setting up the integration.
Connection settings
When setting up a data integration, select Brinqa Connect 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 the Brinqa Connect API account:
-
Connect URL: The URL for your Brinqa Connect installation, e.g.:
https://<your-brinqa-platform-url>/connect/. -
Username and Password: The username and password associated with the Brinqa Connect API account, which must have permissions to ingest data.
-
API Key: An API key for authentication. This can be used as an alternative to a username and password. The use of an API key requires Brinqa Connect v1.10.4 or later.
-
API Key Header: The name of the header used to send the API key. The default format is
X-API-KEY. -
Page size: The maximum number of records to get per API request. The default setting is 1000.
-
Namespace: The qualifier for the environment or product that the Brinqa Connect API account can access. For example, "development", "production", and so on. If a namespace is not being used, enter "global".
To obtain the username, password, and namespace, you can contact your designated Customer Success Manager (CSM) or, for on-premises installations, the administrator who has installed Brinqa Connect locally.
Additional settings
The Brinqa Connect connector contains additional options for specific configuration:
-
Skip certificate verification: Select this option to allow for untrusted certificates.
-
Read timeout: The number of seconds the integration waits to return data before timing out and reporting a failure. The default setting is 10 seconds.
-
Maximum retries: The maximum number of attempts to retry socket based timeouts before giving up and reporting a failure. The default setting is 3.
-
Connect timeout in seconds: The number of seconds the integration waits to establish a connection before timing out and reporting a failure. The default setting is 30 seconds
Types of data to retrieve
The Brinqa Connect connector retrieves records that you've sent through the Brinqa Connect API.
The Brinqa Connect 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 Brinqa Connect in the Brinqa Platform, see How to view your data.
APIs
The Brinqa Connect connector uses the Brinqa Connect API.
Changelog
The Brinqa Connect connector has undergone the following changes:
Version numbers may occasionally skip ahead (for example, from 2.0.5 to 2.1.0). This typically reflects internal development activity such as testing, preview releases, or fixes that were later pulled back and not released publicly. Any version not listed in the changelog was not formally released.
| Version | Description | Date Published |
|---|---|---|
| 2.1.12 | Fixed an issue where the connector sync was failing due to a classcast exception error. | July 17th, 2025 |
| 2.1.11 | Fixed an issue where schema requests from multiple Brinqa Connect data integrations could return incorrect results. | July 17th, 2025 |
| 2.1.10 | Code clean up and general maintenance. | May 16th, 2025 |
| 2.1.9 | Code clean up and general maintenance. | May 16th, 2025 |
| 2.1.8 | Fixed an issue where the connector sync was failing due to a data type mismatch between Long and Instant for modified time values. | April 28th, 2025 |
| 2.1.7 | - Improved handling of socket timeouts during syncs. - Code clean up and general maintenance. | March 23rd, 2025 |
| 2.1.6 | Fixed an issue where the connector sync was failing when reading from the last sync due to a type conversion error. Beginning of Time syncs were unaffected, but last sync attempts resulted in inconsistent failures. This update resolves the conversion issue to ensure delta syncs work as expected. | March 13th, 2025 |
| 2.1.5 | Fixed an issue where certain attributes could be null or contain empty string values, causing sync failures. The connector now handles these scenarios to ensure data is retrieved successfully. | September 19th, 2024 |
| 2.1.4 | - Added new additional settings to help manage timeout handling: Connect timeout in seconds, Maximum retries, and Read timeout - Code clean up and general maintenance. | August 1st, 2024 |
| 2.1.3 | Code clean up and general maintenance. | July 25th, 2024 |
| 2.1.2 | Fixed an issue where several DateTime values were not converting properly. This fix resolves the data type mismatch errors that were causing the issue. | July 9th, 2024 |
| 2.1.1 | Code clean up and general maintenance. | June 27th, 2024 |
| 2.1.0 | - Added support for API Key–based authentication. You can now authenticate using an API key instead of a username and password. - Code cleanup and general maintenance. | June 26th, 2024 |
| 2.0.5 | - Added support for defining data lifecycle management policies in connector metadata. This enables Brinqa Connect to identify which source data models support inactivity and purge rules. - Improved compatibility with older Brinqa Platform versions when lifecycle metadata is not supported. | May 23rd, 2024 |
| 2.0.4 | Fixed an issue where the connector sync was failing due to an unrecognized fieldTransformations property in the type definition. | May 31st, 2023 |
| 2.0.3 | Fixed an issue where the data model priority value was not being set correctly when pushing schema to Brinqa Connect. This caused data integrations using the Brinqa Connect connector to become uneditable. | January 11th, 2023 |
| 2.0.2 | - Fixed an issue where the connector failed to detect the schema for boolean data type fields. - Code clean up and general maintenance. | January 3rd, 2023 |
| 2.0.0 | Initial Integration+ release. | July 25th, 2022 |