Azure Blob Storage data source API reference guide
The azureblob endpoint allows you to connect and manage Azure Blob Storage 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.
POST /azureblob/handler
Save the provided connection for an Azure Blob Storage data source.
| Attribute | Description | Required |
|---|---|---|
The following request saves the provided connection information (in example-payload.json) as a data source.
GET /azureblob/handler/{handlerId}
Return the handler metadata associated with the provided handler ID.
The following request returns the handler metadata associated with the provided handler ID.
PUT /azureblob/handler/{handlerId}
Update the provided information for an Azure Blob Storage data source.
The following request with the payload below updates the metadata for the data source with the handler ID 18.
Payload example
PUT /azureblob/bulk
Update the data source metadata associated with the provided connection string.
The following request updates the autoIngest value to true for data sources with the connection string specified in the payload below.
Payload example
PUT /azureblob/handler/{handlerId}/crawl
Re-crawls the data source and updates the metadata.
The response returns a string of characters that identify the job run.
The following request re-crawls the data source.
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Method | Path | Purpose |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
private
boolean When false, the data source will be publicly available in the Immuta UI.
Yes
blobHandler
array[object] A list of full URLs providing the locations of all blob store handlers to use with this data source.
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 instance.
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 specific handler ID.
Yes
skipCache
boolean If true, the handler cache will be skipped when retrieving the handler data.
No
dataSourceId
integer The data source ID.
value
array Details regarding the handler, including container, accountname, sasTokenURL, ingestUserId, tagAttributes, dataSourceName, refreshInterval, eventTimeAttribute, useDirectoryForTags.
PUT
/azureblob/handler/{handlerId}
PUT
/azureblob/bulk
PUT
/azureblob/handler/{handlerId}/crawl
handlerId
integer The specific handler ID.
Yes
skipCache
boolean When true, will skip the handler cache when retrieving metadata.
No
id
integer The ID of the handler.
dataSourceId
integer The data source ID.
metadata
array Details regarding the updated information.
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 specific handler ID.
Yes