API

Update Custom Data integration

patch
https://core-api.ternary.app/api/data-integrations/custom-data/

Update an existing Custom Data integration

Path Params
string
required
length ≥ 1

Unique cloud integration ID

Body Params
string
required
length ≥ 1

Integration ID

allowedUserIDs
array of uuids

For restricted integrations, the IDs of the users who are allowed to access the integration

allowedUserIDs
auth
object

Authentication configuration. Requirements depend on sourceType:

S3_BUCKET: roleARN is required, azureAppID and azureDirectoryID must be null

AZURE_BLOB: azureAppID and azureDirectoryID are required, roleARN must be null

GCP_BIGQUERY: all fields must be null (uses service account authentication)

GCS_BUCKET: all fields must be null (uses service account authentication)

string
length ≥ 1

Custom Data integration name

string

String value that represents NULL in CSV files. Use AUTO or omit for auto-detect, EMPTY_STRING for empty string, or a custom value (e.g. NULL, NaN, NA, -).

sourceMapping
array of objects

Optional source to destination column mappings

sourceMapping
string
enum

Source Type for the Custom Data integration

Allowed:
string
length ≥ 1

Custom Data storage URI. Format depends on sourceType:

S3_BUCKET: s3://bucket-name/path/to/folder

GCS_BUCKET: gs://bucket-name/path/to/folder

GCP_BIGQUERY: bigquery://project/dataset/table

AZURE_BLOB: https://<account-name>.blob.core.windows.net/<container-name>/path/to/folder

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago