Settings for connectors

When creating or updating a connection through the Krenalis APIs, you must provide the specific settings for that connector, if any.

This includes, for example, authentication data for an app, access data for a database, etc.

.NET

When creating or updating .NET connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

Android

When creating or updating Android connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

ClickHouse

When creating or updating ClickHouse connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • username

    string Required : Username.

  • password

    string Required : Password.

  • database

    string Required : Database name.
For in-depth documentation on these fields and which values to choose, see the documentation page for ClickHouse .

File System

When creating or updating File System connections through the API, the following must be provided in the settings field, in a JSON Object:

  • simulateHighIOLatency

    boolean : Simulate high latency during I/O operations.

Other File System connection settings (as root path and displayed root) are configured via environment variables.

Go

When creating or updating Go connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

Google Analytics

When creating or updating Google Analytics connections through the API, the following must be provided in the settings field, in a JSON Object:

  • measurementID

    string Required : Measurement ID.

  • apiSecret

    string Required : API secret.

  • collectionEndpoint

    string Required : Collection endpoint. Must be Global or EU.
For in-depth documentation on these fields and which values to choose, see the documentation page for Google Analytics .

HTTP GET

When creating or updating HTTP GET connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • headers

    Array of JSON Objects : HTTP headers, specified as an Array of JSON Objects with two keys: key and value.
For in-depth documentation on these fields and which values to choose, see the documentation page for HTTP GET .

HTTP POST

When creating or updating HTTP POST connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • headers

    Array of JSON Objects : HTTP headers, specified as an Array of JSON Objects with two keys: key and value.
For in-depth documentation on these fields and which values to choose, see the documentation page for HTTP POST .

Hubspot

When creating or updating HubSpot connections through the API, the following must be provided in the settings field, in a JSON Object:

  • accessToken

    string Required : Access Token.
For in-depth documentation on these fields and which values to choose, see the documentation page for HubSpot .

iOS

When creating or updating iOS connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

Java

When creating or updating Java connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

JavaScript

When creating or updating JavaScript connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

Klaviyo

When creating or updating Klaviyo connections through the API, the following must be provided in the settings field, in a JSON Object:

  • privateAPIKey

    string Required : Private API key.
For in-depth documentation on these fields and which values to choose, see the documentation page for Klaviyo .

Mailchimp

When creating or updating Mailchimp connections through the API, the following must be provided in the settings field, in a JSON Object:

  • audience

    string Required : Audience.
For in-depth documentation on these fields and which values to choose, see the documentation page for Mailchimp .

Mixpanel

When creating or updating Mixpanel connections through the API, the following must be provided in the settings field, in a JSON Object:

  • projectID

    string Required : Project ID.

  • projectToken

    string Required : Project token.

  • dataResidency

    string Required : Data residency. Possible values are: EU, US or IN
For in-depth documentation on these fields and which values to choose, see the documentation page for Mixpanel .

MySQL

When creating or updating MySQL connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • username

    string Required : Username.

  • password

    string Required : Password.

  • database

    string Required : Database name.
For in-depth documentation on these fields and which values to choose, see the documentation page for MySQL .

Node.js

When creating or updating Node.js connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

PostgreSQL

When creating or updating PostgreSQL connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • username

    string Required : Username.

  • password

    string : Password.

  • database

    string Required : Database name.

  • schema

    string Required : Schema.
For in-depth documentation on these fields and which values to choose, see the documentation page for PostgreSQL .

PostHog

When creating or updating PostHog connections through the API, the following must be provided in the settings field, in a JSON Object:

  • apiKey

    string Required : apiKey.

  • cloud.projectRegion

    string : Project region, when using PostHog cloud.

  • selfHosted.url

    string : URL of PostHog instance, when PostHog is self-hosted.
For in-depth documentation on these fields and which values to choose, see the documentation page for PostHog .

Python

When creating or updating Python connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

RudderStack

When creating or updating RudderStack connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

S3

When creating or updating S3 connections through the API, the following must be provided in the settings field, in a JSON Object:

  • accessKeyID

    string Required : Access key ID.

  • secretAccessKey

    string Required : Secret access key.

  • region

    string Required : Region. Allowed values are: us-east-1, us-east-2, us-west-1, us-west-2, af-south-1, ap-east-1, ap-south-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-south-1, ap-northeast-3, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-east-2, ap-southeast-7, ap-northeast-1, ca-central-1, ca-west-1, eu-central-1, eu-west-1, eu-west-2, eu-south-1, eu-west-3, eu-south-2, eu-north-1, eu-central-2, il-central-1, mx-central-1, me-south-1, me-central-1, sa-east-1.

  • bucket

    string Required : Bucket.
For in-depth documentation on these fields and which values to choose, see the documentation page for S3 .

Segment

When creating or updating Segment connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.

SFTP (source)

When creating or updating SFTP (source) connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • username

    string Required : Username.

  • password

    string Required : Password.
For in-depth documentation on these fields and which values to choose, see the documentation page for SFTP .

SFTP (destination)

When creating or updating SFTP (destination) connections through the API, the following must be provided in the settings field, in a JSON Object:

  • host

    string Required : Host.

  • port

    int Required : Port.

  • username

    string Required : Username.

  • password

    string Required : Password.

  • tempPath

    string : Temporary directory path.
For in-depth documentation on these fields and which values to choose, see the documentation page for SFTP .

Snowflake

When creating or updating Snowflake connections through the API, the following must be provided in the settings field, in a JSON Object:

  • account

    string Required : Account.

  • username

    string Required : Username.

  • password

    string Required : Password.

  • role

    string Required : Role.

  • database

    string Required : Database.

  • schema

    string Required : Schema.

  • warehouse

    string Required : Warehouse.
For in-depth documentation on these fields and which values to choose, see the documentation page for Snowflake .

Stripe

When creating or updating Stripe connections through the API, the following must be provided in the settings field, in a JSON Object:

  • apiKey

    string Required : API Key.
For in-depth documentation on these fields and which values to choose, see the documentation page for Stripe .

Webhook

When creating or updating Webhook connections through the API, there are no settings that must be passed through the settings field, so it must be omitted or set to null.