Skip to main content

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.

Required 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.

  • 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".

note

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.

Types of data to retrieve​

The Brinqa Connect connector retrieves records that you've sent through the Brinqa Connect API.

info

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​

See Brinqa Connect Releases.