Snowflake data source API reference guide
The snowflake endpoint allows you to connect and manage Snowflake data sources in Immuta.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
Snowflake imported databases
Immuta does not support Snowflake tables from imported databases. Instead, create a view of the table and register that view as a data source.
POST /snowflake/handler
Save the provided connection information as a data source.
| Attribute | Description | Required |
|---|---|---|
This request creates a Snowflake data source.
GET /snowflake/handler/{handlerId}
Get the handler metadata associated with the provided handler ID.
This request returns metadata for the handler with the ID 30.
PUT /snowflake/handler/{handlerId}
Update the data source metadata associated with the provided handler ID. This endpoint does not perform partial updates, but will allow the dictionary to be omitted. In this case, it uses the current dictionary.
This request updates the metadata for the data source with the handler ID 30.
Payload example
The payload below updates the eventTime to MOST_RECENT_ORDER.
PUT /snowflake/bulk
Update the data source metadata associated with the provided connection string.
This request updates the metadata for all data sources with the connection string specified in example-payload.json.
Payload example
The payload below updates the database to ANALYST_DEMO for the provided connection string.
PUT /snowflake/handler/{handlerId}/triggerHighCardinalityJob
Recalculate the high cardinality column for the specified data source.
The response returns a string of characters that identify the high cardinality job run.
This request re-runs the job that calculates the high cardinality column for the data source with the handler ID 30.
PUT /snowflake/handler/{handlerId}/refreshNativeViewJob
Refresh the native view of a data source.
The response returns a string of characters that identifies the refresh view job run.
This request refreshes the view for the data source with the handler ID 7.
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Method | Path | Purpose |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
private
boolean When false, the data source will be publicly available in the Immuta UI.
Yes
blobHandler
array[object] The parameters for this array include scheme ("https") and url (an empty string).
Yes
blobHandlerType
string Describes the type of underlying blob handler that will be used with this data source (e.g., MS SQL).
Yes
recordFormat
string The data format of blobs in the data source, such as json, xml, html, or jpeg.
Yes
type
string The type of data source: ingested (metadata will exist in Immuta) or queryable (metadata is dynamically queried).
Yes
name
string The name of the data source. It must be unique within the Immuta tenant.
Yes
sqlTableName
string A string that represents this data source's table in Immuta.
Yes
organization
string The organization that owns the data source.
Yes
category
string The category of the data source.
No
description
string The description of the data source.
No
hasExamples
boolean When true, the data source contains examples.
No
id
integer The handler ID.
dataSourceId
integer The ID of the data source.
warnings
string This message describes issues with the created data source, such as the data source being unhealthy.
connectionString
string The connection string used to connect the data source to Immuta.
handlerId
integer The ID of the handler.
Yes
skipCache
boolean When true, will skip the handler cache when retrieving metadata.
No
body
array[object] Metadata about the data source, including the data source ID, schema, database, and connection string.
PUT
/snowflake/handler/{handlerId}
Update the data source metadata associated with the provided handler ID. This endpoint does not perform partial updates, but will allow the dictionary to be omitted. In this case, it uses the current dictionary.
PUT
/snowflake/bulk
PUT
/snowflake/handler/{handlerId}/triggerHighCardinalityJob
PUT
/snowflake/handler/{handlerId}/refreshNativeViewJob
handlerId
integer The ID of the handler.
Yes
skipCache
boolean When true, will skip the handler cache when retrieving metadata.
No
handler
metadata Includes metadata about the handler, such as ssl, port, database, hostname, username, and password.
Yes
connectionString
string The connection string used to connect to the data source.
Yes
id
integer The ID of the handler.
ca
string The certificate authority.
columns
array[object] This is a Data Dictionary object, which provides metadata about the columns in the data source, including the name and data type of the column.
handler
metadata Includes metadata about the handler, such as ssl, port, database, hostname, username, and password.
Yes
connectionString
string The connection string used to connect to the data sources.
Yes
bulkId
string The ID of the bulk data source update.
connectionString
string The connection string shared by the data sources bulk updated.
jobsCreated
integer The number of jobs that ran to update the data sources; this number corresponds to the number of data sources updated.
handlerId
integer The ID of the handler.
Yes
handlerId
integer The ID of the handler.
Yes