API

Create Custom Data integration

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

Create a Custom Data integration. Supported source types are S3_BUCKET, GCS_BUCKET, AZURE_BLOB, GCP_BIGQUERY, OSS_BUCKET, GCS_UPLOAD, and EXTERNAL_PUSH. Configure source-to-destination column mappings and source-specific authentication. A storage URI is required except for EXTERNAL_PUSH. OSS_BUCKET requires the Alibaba role ARN and OIDC provider ARN. GCS_UPLOAD and EXTERNAL_PUSH require null cloud credential fields. EXTERNAL_PUSH is an AI Gateway push source and requires the AI Gateway capability; the other source types require the Custom Data integration capability. A successful create does not establish that a later source read or import succeeds.

All auth-object fields are required even when null. Google bucket, BigQuery, and managed-upload sources require null auth fields. GCS_UPLOAD refers to managed upload storage. EXTERNAL_PUSH creation does not create a gateway connection or upload data. See Data Integrations for setup guidance.

Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

A unique identifier for an organization

allowedUserIDs
array of uuids
length ≥ 1

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

allowedUserIDs
auth
object
required

Authentication configuration. Requirements depend on sourceType:

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

AZURE_BLOB: azureAppID and azureDirectoryID are required, roleARN and alibabaOidcProviderARN 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)

GCS_UPLOAD: all fields must be null (managed BYOD bucket for drag-and-drop uploads, no external auth)

OSS_BUCKET: roleARN and alibabaOidcProviderARN are required, azureAppID and azureDirectoryID must be null

string

FontAwesome icon key for the dataset

string
required
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
required

Source to destination column mappings

sourceMapping*
string
enum
required

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

GCS_UPLOAD: gs://bucket-name/path/to/folder (system-managed)

OSS_BUCKET: oss://bucket-name.oss-region.aliyuncs.com/path/to/folder

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?