Create Custom Data integration

post

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

Create a new Custom Data integration for importing user-defined cost data.

Source types (sourceType):

S3_BUCKET — Amazon S3
GCS_BUCKET — Google Cloud Storage
AZURE_BLOB — Azure Blob Storage
GCP_BIGQUERY — Google BigQuery table

Configure the storage URI, authentication, and column mappings to define how source data maps to Ternary's cost model.

See Data Integrations for setup guidance.

Body Params

tenantID

uuid

required

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

icon

string

FontAwesome icon key for the dataset

name

string

required

length ≥ 1

Custom Data integration name

nullMarker

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*

sourceType

string

enum

required

Source Type for the Custom Data integration

Allowed:

storageURI

string

required

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

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden