Subscribe to and Manage Data Sources
This page describes the dataSource
endpoint, through which users can subscribe to data sources, make unmasking requests, and manage data source tasks. To create data sources, see the specific handler endpoints.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
Data source workflow
Search data sources and data source details
GET
Get parent and child relationship records for derived data sources using a specified data source ID.
GET
Get all users with the provided access level for this data source.
GET
Retrieves the visibilities, masking information, and filters that the passed in user has access to in the specified data source.
GET
Retrieves a summary of total records, total visibilities, and visibilities a given user has access to.
GET
Retrieves a summary of total records, total visibilities, and visibilities the current user has access to for a specified data source.
Search for data sources
GET
/dataSource
Search for data sources.
Query Parameters
blobHandlerType
array[string]
Describes the type of underlying blob handler that will be used with this data source (e.g., Custom, MS SQL).
No
subscription
array[string]
The requesting user's subscription status: pending
, owner
, subscribed
, not_subscribed
, expert
, or ingest
.
No
status
array[string]
The data source status: passed
or failed
.
No
tag
array[string]
Filters data sources by tags associated with the data sources.
No
searchText
string
Searches for data source names using the provided string
.
No
column
array[string]
Searches for data source column names.
No
connectionString
array[string]
Searches by connection string.
No
schema
string
Searches for data source schema.
No
nameOnly
boolean
When true
, searchText
will only search data source names. Default is false
.
No
idOnly
boolean
When true
, only returns the ID Of the data source and the user's subscription status.
No
dataSourceIds
array[integer]
Searches for the provided data source IDs.
No
selectFields
array[string]
This field accepts the values id
, name
, and columnEvolutionEnabled
. When id
or name
are provided, the request will return only the ID or name of the data source and the subscription status. If columnEvolutionEnabled
is provided, the response will also include information about the policies, policy conflicts, and workspaces associated with the data sources.
No
offset
integer
Used in combination with size
to fetch pages. Default is 0
.
No
size
integer
The number of results to return per page. Default is 10
.
No
sortField
string
Used to sort results by field, which must be createdAt
, name
, blobHandlerType
, subscriptionStatus
, recordCount
, status
, policy
, or editable
.
No
sortOrder
string
Sorts results by order, which must be asc
or desc
.
No
excludedProjects
array[integer]
Filter out any data sources that belong to the specified projects.
No
ephemeral
boolean
When true
, returns ephemeral data sources.
No
clusterName
string
The name of the remote cluster the data source is connected to.
No
mode
integer
Specifies the query mode, which must be 0
(FULL
), 1
(COUNT
), 4
(TAG
), 5
(MIN_MAX
), or 6
(STATUS
).
No
globalPolicy
string
Filter by data sources that have this Global Policy applied.
No
hostname
string
Searches data sources by hostname.
No
Response Parameters
name
string
Data source name.
id
integer
Data source ID.
deleted
boolean
If true
the data source is a deleted data source.
description
string
The data source description.
createdAt
timestamp
The date and time the data source was created.
subscriptionPolicy
array
Details the type of Subscription Policy applied to the data source.
schemaEvolutionId
integer
The schema evolution ID.
recordCount
integer
The record count.
status
array[string]
Accepted statuses are passed
or failed
.
subscriptionStatus
array[string]
Accepted statuses are subscribed
or unsubscribed
.
blobHandlerType
array[string]
Describes the type of underlying blob handler of this data source (e.g., Custom, MS SQL).
subscriptionType
string
The type of subscription policy on the project. The type can be automatic
(which allows anyone to subscribe), approval
(which requires the subscriber to be manually approved), policy
(which only allows users with specific groups or attributes to subscribe), or manual
(which requires users to be manually added).
connectionString
string
The connection string information.
sqlSchemaName
string
The schema name.
policy
string
When this value is none
, there are no data policies applied to the data source. Otherwise, this field indicates whether or not there are policy conflicts among the data policies applied to the data source.
policyHandlerType
string
The policy handler type, such as None
or Builder
.
Request example
The following request returns 2 data sources.
Response example
Get a data source by ID
GET
/dataSource/{dataSourceId}
Get a data source based on the ID.
Query Parameters
dataSourceId
integer
The data source ID .
Yes
Response Parameters
name
string
The data source name.
recordFormat
string
The data format of blobs in the data source, such as json
, xml
, html
, or jpeg
.
description
string
The description of the data source.
policyHandler
array
The ID of the policy handler and details about the data policies enforced on the data source.
sqlSchemaName
string
A string that represents this data source's schema name in the Query Engine.
sqlTableName
string
The SQL table name in the Query Engine.
blobHandler
array[object]
A list of full URLs providing the locations of all blob store handlers to use with this data source.
blobHandlerType
string
Describes the type of underlying blob handler that will be used with this data source (e.g., MS SQL
).
createdBy
integer
The ID of the profile creating the data source.
deleted
boolean
If true, the data source was deleted.
type
string
The data source type, such as queryable
or ingested
.
rowCount
integer
The number of rows.
documentation
string
Documentation associated with the data source.
id
integer
The data source ID.
policyHandlerType
string
The type of policy handler applied to the data source: Builder
.
subscriptionType
string
The type of subscription policy on the data source. The type can be automatic
(which allows anyone to subscribe), approval
(which requires the subscriber to be manually approved), policy
(which only allows users with specific groups or attributes to subscribe), or manual
(which requires users to be manually added).
subscriptionPolicy
array
Details about the Subscription Policy applied to the data source.
globalPolicies
string
Details about the Global Policies applied to the data source.
status
string
The data source health status.
Request example
The following request gets a data source based on the ID 22
.
Response example
Get data source by name
GET
/dataSource/name/{dataSourceName}
Get a data source based on the name.
Query Parameters
dataSourceName
string
The data source name.
Yes
Response Parameters
name
string
The data source name.
recordFormat
string
The data format of blobs in the data source, such as json
, xml
, html
, or jpeg
.
description
string
The description of the data source.
policyHandler
array
The ID of the policy handler and details about the data policies enforced on the data source.
sqlSchemaName
string
A string that represents this data source's schema name in the Query Engine.
sqlTableName
string
The SQL table name in the Query Engine.
blobHandler
array[object]
A list of full URLs providing the locations of all blob store handlers to use with this data source.
blobHandlerType
string
Describes the type of underlying blob handler that will be used with this data source (e.g., MS SQL
).
createdBy
integer
The ID of the profile creating the data source.
deleted
boolean
If true, the data source was deleted.
type
string
The data source type, such as queryable
or ingested
.
rowCount
integer
The number of rows.
documentation
string
Documentation associated with the data source.
id
integer
The data source ID.
policyHandlerType
string
The type of policy handler applied to the data source: Builder
.
subscriptionType
string
The type of subscription policy on the data source. The type can be automatic
(which allows anyone to subscribe), approval
(which requires the subscriber to be manually approved), policy
(which only allows users with specific groups or attributes to subscribe), or manual
(which requires users to be manually added).
subscriptionPolicy
array
Details about the Subscription Policy applied to the data source.
globalPolicies
string
Details about the Global Policies applied to the data source.
status
string
The data source health status.
Request example
The following request gets a data source based on the name Public Barfoo
.
Response example
Get a data source by the short name
GET
/dataSource/sqlTableName/{shortName}
Get a data source based on the SQL table name.
Query Parameters
shortName
string
The data source SQL table name.
Yes
Response Parameters
name
string
The data source name.
recordFormat
string
The data format of blobs in the data source, such as json
, xml
, html
, or jpeg
.
description
string
The description of the data source.
policyHandler
array
The ID of the policy handler and details about the data policies enforced on the data source.
sqlSchemaName
string
A string that represents this data source's schema name in the Query Engine.
sqlTableName
string
The SQL table name in the Query Engine.
blobHandler
array[object]
A list of full URLs providing the locations of all blob store handlers to use with this data source.
blobHandlerType
string
Describes the type of underlying blob handler that will be used with this data source (e.g., MS SQL
).
createdBy
integer
The ID of the profile creating the data source.
deleted
boolean
If true, the data source was deleted.
type
string
The data source type, such as queryable
or ingested
.
rowCount
integer
The number of rows.
documentation
string
Documentation associated with the data source.
id
integer
The data source ID.
policyHandlerType
string
The type of policy handler applied to the data source: Builder
.
subscriptionType
string
The type of subscription policy on the data source. The type can be automatic
(which allows anyone to subscribe), approval
(which requires the subscriber to be manually approved), policy
(which only allows users with specific groups or attributes to subscribe), or manual
(which requires users to be manually added).
subscriptionPolicy
array
Details about the Subscription Policy applied to the data source.
globalPolicies
string
Details about the Global Policies applied to the data source.
status
string
The data source health status.
Request example
The following request gets a data source based on the SQL table name customer_data
.
Response example
Get data source relationships
GET
/dataSource/{dataSourceId}/lineage/{type}
Get parent and child relationship records for derived data sources using a specified data source ID.
Query Parameters
type
string
The type of lineage records to return. Options include: parents
, children
, and all
.
Yes
dataSourceId
integer
The target data source ID.
Yes
Response Parameters
children
array
Details of the child data source, including dataSourceId
, dataSourceName
, projectId
, policyHandlerDiff
, deleted
, createdBy
, and createdAt
.
parents
array
Details of the parent data source, including dataSourceId
, dataSourceName
, projectId
, policyHandlerDiff
, deleted
, createdBy
, and createdAt
.
Request example
The following request gets the parent relationship records for the derived data source with the data source ID 4
.
Response example
Retrieve a Blob
GET
/dataSource/{dataSourceId}/blob/{blobid*}
Retrieve a blob.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
blobId
string
The blob ID.
Yes
Response Parameters
The response will download the blobs in a file you specify.
Request example
The following request retrieves a blob.
Response example
Get a comment by ID
GET
/dataSource/{dataSourceId}/comments/{commentId}
Get a comment by ID for the data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
commentId
integer
The comment ID.
Yes
Response Parameters
author
integer
The user ID of the user who posted the comment.
parentId
integer
The parent comment ID.
resolved
boolean
If true
, the comment has been resolved.
body
string
The text of the comment.
id
integer
The comment ID.
createdAt
timestamp
When the comment was created.
updatedAt
timestamp
When the comment was last updated.
Request example
The following request gets a comment by ID for the data source.
Response example
Get All Comments for a Data Source
GET
/dataSource/{dataSourceId}/comments
Get all the comments for the data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Response Parameters
author
array
The id
, name
, and email
of the author.
resolved
boolean
If true
, the comment has been resolved.
id
integer
The comment ID.
createdAt
timestamp
The date and time the comment was created.
updatedAt
timestamp
The date and time the comment was updated.
models
array
The modelType
(such as datasource
), modelId
, and modelName
.
totalreplies
integer
The number of replies to the comment.
lastreply
timestamp
The date and time of the last reply.
public
boolean
If true
, the comment is public.
Request example
The following request adds a comment to the data source.
Response example
Count the comments for a data source
GET
/dataSource/{dataSourceId}/comments/count
Count the comments for a data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
columns
boolean
When true
, retrieves comments for columns.
No
queries
array[string]
The queries for which to retrieve comments.
No
resolved
boolean
If true
, will retrieve only resolved comments. If false
, will retrieve only unresolved comments. If not set, will retrieve all comments.
No
Response Parameters
modelId
integer
The model ID.
modelType
string
The model type.
count
integer
The number of comments on the data source.
Request example
The following request counts the comments for data source 1
.
Response example
Get users by access level
GET
/dataSource/{dataSourceId}/access
Get all users with the provided access level for this data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
states
Array[string]
The status levels to include when querying for user access.
No
approved
boolean
Denotes whether the returned access objects should be approved.
No
searchText
string
A string used to filter returned users. The query is executed with a wildcard prefix and suffix.
No
size
integer
The number of results to return.
No
offset
integer
The number of results to skip (for paging).
No
sortField
string
The field on which to sort the result set.
No
sortOrder
string
The order in which to sort the results.
No
expandGroups
boolean
If true will return individual members of any group subscribed.
No
ignoreSystemGenerated
boolean
If true, will not return system generated accounts.
No
filterBySchemaEvolution
boolean
If true, will only return users who have the specified level of access across ALL data sources within the same schema evolution group as this one.
No
Response Parameters
count
integer
The number of users with access to the data source.
users
string
The metadata regarding the users with access to the data source.
Request example
The following request gets all users with the provided access level for this data source.
Response example
Get user access info for a data source
GET
/dataSource/{dataSourceId}/users/{profileId}/policyInfo
Retrieves the visibilities, masking information, and filters that the passed in user has access to in the specified data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
profileId
integer
The profile ID of the user.
Yes
projectId
integer
The project ID. If provided, this project will be used when evaluating the user's visibilities.
No
Response Parameters
visibilities
array
Details of the user's visibilities, including anyKey
.
visibilityRuleApplies
boolean
If true
, a visibility rule exists and the user is not excepted from it.
masked
array
Masking information for the data source, including metadata
, name
, type
, and actionType
.
additionalFilters
array
Policy information for the data source, including customWhere
, differentialPrivacy
, eventTimeColumn
, minimization
, time
, filterSeconds
, and isOlderOrNewer
.
Request example
The following request gets the visibility information for the user with the profile ID 2
on the data source with the data source ID 16
.
Response example
Get user visibility info for a data source
GET
/dataSource/{dataSourceId}/users/{profileId}/visibilityReport
Retrieves a summary of total records, total visibilities (the unique values contained in a column protected by a row-level security policy that allow Immuta to determine whether or not a user can see a given row if they possess an attribute that matches the visibility of that row), and visibilities a given user has access to.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
profileId
integer
The profile ID of the user.
Yes
informationOnly
boolean
If true
, the query will just return information for the UI and will skip running some queries for ephemeral data sources.
No
includeNestedColumns
boolean
If true
, the query will return just information for the dictionary page, including the masking policies for nested columns.
No
Response Parameters
noVisibilities
boolean
If true
, the data source has no row-level security or purpose-based restriction policies applied to it.
dataSourceVisibilitiesCount
integer
The total number of possible visibilities the given data source has.
userVisibilitiesCount
integer
The number of visibilities the current user can see for the given data source.
masked
array
Masking information for the data source, including metadata
, name
, type
, and actionType
.
dataSource
integer
The data source ID.
dataSourceName
string
The data source name.
additionalFilters
array
Policy information for the data source, including customWhere
, differentialPrivacy
, eventTimeColumn
, minimization
, time
, filterSeconds
, and isOlderOrNewer
.
allowMaskedJoins
boolean
If true
the data source allows masked joins.
policySet
array
Details about the policies on the data source.
Request example
The following request gets all of the visibility information for the user with the profile ID 2
on the data source with the data source ID 16
.
Response example
Get current user visibility info
GET
/dataSource/{dataSourceId}/visibilityReport
Retrieves a summary of total records, total visibilities (the unique values contained in a column protected by a row-level security policy that allow Immuta to determine whether or not a user can see a given row if they possess an attribute that matches the visibility of that row), and visibilities the current user has access to for a specified data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Response Parameters
noVisibilities
boolean
If true
, the data source has no row-level security or purpose-based restriction policies applied to it.
dataSourceVisibilitiesCount
integer
The total number of possible visibilities the given data source has.
userVisibilitiesCount
integer
The number of visibilities the current user can see for the given data source.
denialReason
string
Reason the user was denied visibility.
masked
array
Masking information for the data source, including metadata
, name
, type
, and actionType
.
dataSource
integer
The data source ID.
dataSourceName
string
The data source name.
additionalFilters
array
Policy information for the data source, including customWhere
, differentialPrivacy
, eventTimeColumn
, minimization
, time
, filterSeconds
, and isOlderOrNewer
.
allowMaskedJoins
boolean
If true
the data source allows masked joins.
policySet
array
Details about the policies on the data source.
Request example
The following request gets all of the visibility information for the current user on the data source with the data source ID 16
.
Response example
Access data sources and make data source requests
Subscribe to a data source
POST
/dataSource/subscribe
Subscribe to a data source.
Query Parameters
dataSourceId
integer
Data source ID number.
Yes
Payload Parameters
dataSourceIds
array
The ID of the data source the user is subscribing to.
No
approvals
array
Includes details about the Subscription policy on the data source: requiredPermissions
, specificApproverRequired
, specificApprover
, and ownerModelId
.
No
Response Parameters
body
array
Contains details about the data source, including the data source ID, subscription status of the user, the profile ID of the user, and the dates the data source was created and updated.
Request example
The following request subscribes to the data source with ID 22
.
Payload example
Response example
Create a SQL account
POST
/dataSource/featureStore
Create a SQL account.
Payload Parameters
username
string
The SQL account username.
Yes
password
string
The SQL account password.
Yes
Response Parameters
status
boolean
If true
, the SQL account was created.
Request example
The following request creates a SQL account.
Request payload example
Response example
Modify a SQL account password
PUT
/dataSource/featureStore/password
Modify SQL account password for the requesting user.
Payload Parameters
password
string
The new SQL account password.
Yes
Response Parameters
success
boolean
If true
, the password was successfully changed.
sqlUser
integer
SQL user ID.
Request example
The following request modifies a SQL account password.
Payload example
Response example
Create a temporary SQL account
POST
/dataSource/featureStore/temporary
Create a temporary SQL account.
Payload Parameters
projectId
string
The ID of the project to be applied.
No
accountPrefix
string
The prefix to use for the SQL username.
No
expiresIn
integer
The number of minutes the account should be valid.
No
forceDirectAudit
boolean
If true
, will force direct audit of queries run by this account.
No
Response Parameters
success
boolean
If true
, a temporary SQL account was created.
sqlUser
string
The SQL username.
sqlPassword
string
The SQL password.
port
integer
The port number.
database
string
The database name.
host
string
The hostname.
sslMode
string
Indicates whether or not SSL is required.
connectionString
string
The connection string.
Request example
The following request creates a temporary SQL account.
Payload example
Response example
Request to unmask values
POST
/dataSource/{dataSourceId}/reverseMask
Makes a request for values to be unmasked.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Payload Parameters
column
string
The column to unmask.
Yes
unmaskingReason
string
The reason the values need to be unmasked.
Yes
unmaskingUsers
array[integer]
The profile ID of the users who can unmask the values for the requestor.
Yes
projectId
integer
The ID of the associated project.
No
dataSourceId
integer
The data source ID.
No
Response Parameters
id
integer
The ID of the request.
requestingUserProfile
integer
The requesting user profile ID.
dataSourceId
integer
The data source ID.
reason
string
The reason for the unmasking request.
metadata
string
Metadata regarding the masking, such as the column
, values
, and maskingConfig
.
type
string
The type of request.
state
string
The state of the task, such as pending
.
createdAt
timestamp
The date and time the task was created.
updatedAt
timestamp
The date and time the task was updated.
Request example
The following requests for values to be unmasked.
Request payload example
Response example
Add a Comment to a Data Source
POST
/dataSource/{dataSourceId}/comments
Add a comment to a data source.
Query Parameters
dataSourceId
integer
The ID of the data source to add the comment to.
Yes
Payload Parameters
body
string
The text of the comment.
Yes
affectedColumn
string
The column to apply the comment to.
No
associatedQuery
integer
The ID of the query to apply the comment to.
No
Response Parameters
id
integer
The comment ID.
Request example
This request adds a comment (saved in example-payload.json
) to the data source with the ID 48
.
Payload example
Response example
Reply to a data source comment
POST
/dataSource/{dataSourceId}/comments/{parentId}/reply
Reply to a data source comment.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
parentId
integer
The parent comment ID.
Yes
Payload Parameters
body
string
The reply to the comment.
Yes
Response Parameters
id
integer
The comment response ID.
Request example
The following request replies to a data source comment.
Payload example
Response Example
Resolve a data source comment
POST
/dataSource/{dataSourceId}/comments/{commentId}/resolve
Resolve a comment for a data source.
Query Parameters
dataSourceId
integer
Data source ID
Yes
commentId
integer
The comment ID
Yes
Response Parameters
success
boolean
if true
the comment for the data source is resolved.
Request example
The following request resolves a comment for a data source.
Response example
Add a user to a data source
POST
/dataSource/{dataSourceId}/access
Add a user to a specific data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Payload Parameters
state
string
The status of the user: subscribed
, owner,
expert
, or ingest
.
Yes
profileId
integer
The profile ID of the user being added to the data source.
Yes
groupId
integer
The ID of the group being added to the data source.
No
approvals
array
Details about the user approving access: requiredPermission
, specificApproverRequired
, and specificApprover
.
No
expiration
date
The date the user's data source subscription ends.
No
Response Parameters
id
integer
The user's subscription ID.
modelId
integer
The model ID.
modelType
string
The model type.
state
string
The user's data source role, such as subscribed
.
denialReasoning
string
If the user was denied access, the reason for denial.
profile
integer
The user's profile ID.
group
integer
If a group was added, the group ID.
expiration
date
The date the user's subscription to the data source will expire.
acknowledgeRequired
boolean
If the data source is associated with a project, this value will be true
if the user needs to confirm they have read the project acknowledgment.
createdAt
timestamp
The date and time of creation.
updatedAt
timestamp
The date and time of update.
approved
boolean
When true
, the user's request has been approved.
Request example
The following request adds a user (saved in example-payload.json
) to this data source.
Request payload example
Response example
Manage data source requests
GET
Get all pending tasks for this user and pending tasks this user has created.
GET
Returns all tasks the user has made/can approve or deny for this data source.
Get pending tasks by user
GET
/dataSource/tasks/pending
Get all pending tasks for this user and pending tasks this user has created.
Query Parameters
searchText
string
If specified, will filter results using the specified string.
No
searchModel
string
Will filter the results by model type: dataSource
or schemaEvolution
.
No
offset
integer
The number of results to skip (for paging).
No
size
integer
The number of results to return per page.
No
schemaEvolutionConnectionString
string
The schema evolution connection string to filter by.
No
countBySchemaEvolution
boolean
Iftrue
, will only return the number of tasks, grouped by schema evolution.
No
countByDataSource
boolean
Iftrue
, will only return the number of tasks, grouped by data source.
No
countOnly
boolean
When true
, will only return a count of the pending tasks.
No
groupByDataSource
boolean
If true
, will return the results as an array of { dataSourceId: , rows: }
.
No
types
Array[string]
Filters the results by the type of task: unmask
, dataSourceCreated
, columnAdded
, columnDeleted
, or columnTypeChanged
.
No
Response Parameters
outgoing
array
Includes details of the tasks or requests created by the user, such as the count
, type
, and targetEmails
.
incoming
array
Includes details about the tasks received by the user, such as the count
, type
, and targetEmails
.
Request example
The following request gets all pending tasks for a user and pending tasks the user has created.
Response example
Mark tasks as complete
GET
/dataSource/tasks/{taskId}
Handles the given task and marks it as complete.
Query Parameters
taskId
integer
The task ID.
Yes
Response Parameters
result
array
Includes details about the task.
Request example
The following request handles the given task and marks it as complete.
Response example
Return tasks for a data source
GET
/dataSource/{dataSourceId}/tasks
Returns all tasks the user has made/can approve or deny for this data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
states
Array[string]
The state of the tasks: pending
or completed
.
No
targetProfileId
integer
Only returns tasks where the target user has this profile ID.
No
requestingUserProfileId
integer
Only returns tasks where the requesting user has this profile ID.
No
profileId
integer
Returns tasks where either the target or requesting user has this profile ID.
No
searchText
string
A string used to filter returned users. The query is executed with a wildcard prefix and suffix.
No
searchModel
string
A string used to determine how results should be filtered using searchText.
No
types
Array[string]
The type of task: unmask
, dataSourceCreated
, columnAdded
, columnDeleted
, or columnTypeChanged
.
No
size
integer
The number of results to return.
No
offset
integer
The number of results to skip (for paging).
No
sortField
string
The field by which to sort the result set.
No
sortOrder
string
The order in which to sort the results. The default is desc
.
No
countOnly
boolean
If true
, will only return the number of tasks.
No
Response Parameters
hits
array
Includes details about each task, such as the id
, state
, type
, and requestor
.
count
integer
The total number of tasks.
Request example
The following request returns all tasks the user has made/can approve or deny for this data source.
Response example
Change user status
PUT
/dataSource/{dataSourceId}/access/{subscriptionId}
Change user status for a specific data source.
Query Parameters
dataSourceId
Integer
The data source ID.
Yes
subscriptionId
Integer
The data source member's subscription ID.
Yes
Payload Parameters
state
string
The new status for the user: subscribed
, owner
, expert
or ingest
.
Yes
Response Parameters
id
integer
The data source member's subscription ID.
modelId
integer
The model ID.
modelType
array
The model type (i.e., datasource
).
state
array
The current state of the user's role: subscribed
, owner
, expert
, or ingest
.
profile
integer
The profile ID.
group
integer
If a group's status is being updated, this is the group ID.
expiration
timestamp
The date the user will no longer have access to the data source.
acknowledgeRequired
boolean
This attribute is specific to projects. When true
the user needs to confirm they have read the project acknowledgement statement.
createdAt
timestamp
The date and time created.
updatedAt
timestamp
The date and time updated.
originalState
array
The user's previous status for the data source.
approved
boolean
If true
, the status is approved.
Request example
The following request changes the user status to subscribed
for the specified data source.
Payload example
Response example
Update data sources
POST
Save blob metadata to Immuta and store raw content in local blob store.
PUT
Trigger the schema monitoring job for the specified detection group, or all groups if no ID is given.
Update a data source
PUT
/dataSource/{dataSourceId}
Update a data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Payload Parameters
blobHandler
array[object]
A list of full URLs providing the locations of all blob store handlers to use with this data source.
No
blobHandlerType
string
Describes the type of underlying blob handler that will be used with this data source (e.g., MS SQL
).
No
recordFormat
string
The data format of blobs in the data source, such as json
, xml
, html
, or jpeg
.
No
type
string
The type of data source: ingested
(metadata will exist in Immuta) or queryable
(metadata is dynamically queried).
No
name
string
The name of the data source. It must be unique within the Immuta instance.
No
sqlTableName
string
A string that represents this data source's table in the Query Engine.
No
organization
string
The organization that owns the data source.
No
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
Response Parameters
private
boolean
When false
, the data source will be publicly available in the Immuta UI.
blobHandler
array[object]
A list of full URLs providing the locations of all blob store handlers to use with this data source.
blobHandlerType
string
Describes the type of underlying blob handler that will be used with this data source (e.g., MS SQL
).
recordFormat
string
The data format of blobs in the data source, such as json
, xml
, html
, or jpeg
.
type
string
The type of data source: ingested
(metadata will exist in Immuta) or queryable
(metadata is dynamically queried).
name
string
The name of the data source. It must be unique within the Immuta instance.
sqlTableName
string
A string that represents this data source's table in the Query Engine.
organization
string
The organization that owns the data source.
description
string
The description of the data source.
policyHandler
array
The ID of the policy handler and details about the data policies enforced on the data source.
subscriptionPolicy
array
Details about the subscription policy enforced on the data source, including the type of policy and exceptions.
Request example
The following request updates the data source's documentation (saved in example-payload.json
).
Request payload example
Response example
Update multiple data sources
PUT
/dataSource/bulk/{type}
Update data sources.
Query Parameters
type
string
The action to perform on the data sources: add-users
, disable
, restore
, delete
, or tags
.
Yes
Payload Parameters
ids
array[integer
] The IDs of the data sources to update.
Yes
update
array[object]
Only required for add-users
(includes metadata about the users' profiles
: id
and state
) and tags
(includes metadata about the tags
: name
and source
) types.
No
Response Parameters
bulkId
string
The ID of the bulk data source update.
jobsCreated
integer
The number of jobs created.
Request example
The following request adds the Address.email
tag to two data sources.
Payload example
Response example
Refresh native views
POST
/dataSource/bulkRefreshViews
Refresh native views.
Payload Parameters
dataSourceIds
array[integer]
The IDs of the data sources of the native views to update.
Yes
Request example
The following request with the payload below refreshes the view for the data source with the ID 202.
Payload example
Save blob metadata to Immuta
POST
/dataSource/{dataSourceId}/blobs
Save blob metadata to Immuta.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Payload Parameters
blobId
string
The unique ID used to identify this blob within its data source.
Yes
file
string
The binary file to add to the data source.
Yes
filename
string
The name that will display in the filesystem.
No
tags
array[string]
Tags to apply to the blob.
No
date
data
A date that corresponds to a date within the record itself.
No
filesize
integer
The size of the file in bytes.
No
Response Parameters
blobsWithoutIds
integer
The number of blobs added without IDs.
blobsInError
array
The blobs that were not added because of an error.
blobsInserted
array
The blobs added to the data source.
tags
array[string]
Tags applied to the blobs.
Request example
The following request saves blob metadata to Immuta.
Payload example
Response example
Store blob metadata locally
POST
/dataSource/{dataSourceId}/persistBlob
Save blob metadata to Immuta and store raw content in local blob store.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Payload Parameters
blobId
string
The unique ID used to identify this blob within its data source.
Yes
file
string
The binary file to add to the data source.
Yes
filename
string
The name that will display in the filesystem.
No
tags
array[string]
Tags to apply to the blob.
No
date
data
A date that corresponds to a date within the record itself.
No
filesize
integer
The size of the file in bytes.
No
Response Parameters
blobsWithoutIds
integer
The number of blobs added without IDs.
blobsInError
array
The blobs that were not added because of an error.
blobsInserted
array
The blobs added to the data source.
tags
array[string]
Tags applied to the blobs.
Request example
The following request saves blob metadata to Immuta and stores raw content in local blob stores.
Payload example
Response example
Trigger schema monitoring jobs
PUT
/dataSource/detectRemoteChanges
Trigger the schema monitoring job for the specified detection group, or all groups if no payload parameters are given.
Payload Parameters
dataSourceIds
array[integer]
The data source IDs to run the column detection job on. Leave empty to run this job globally on all data sources. This parameter cannot be included in the payload if schemaEvolutionId or any combination of hostname, database, port, or table is included.
No
hostname
string
The hostname of the data sources. This parameter cannot be included in the payload if dataSourceIds or schemaEvolutionId is included.
No
port
integer
The port used to connect the data sources to Immuta. This parameter cannot be included in the payload if dataSourceIds or schemaEvolutionId is included.
No
database
string
The database name. This runs schema monitoring on the database provided. If data sources were initially registered via the V2 API, including this parameter will locate new schemas that contain tables Immuta has the ability to access, and Immuta will create a new schema project associated with these newly discovered schemas and create data sources for each table located. If data sources were initially registered via the V1 API, including this parameter will only update the columns and tables of registered schema and tables of the specified database; it will not register any new schemas. This parameter cannot be included in the payload if dataSourceIds or schemaEvolutionId is included.
No
table
string
The table name. This will run column detection to just update the columns in this table. This parameter cannot be included in the payload if dataSourceIds or schemaEvolutionId is included.
No
schemaEvolutionId
integer
The ID of the schema to run the schema monitoring job on. This will run on all tables associated with the specified ID. The schema ID can be found in the response body of /dataSource/{dataSourceId}
. This parameter cannot be included in the payload if dataSourceIds or any combination of hostname, database, port, or table is included.
No
skipColumnDetection
boolean
When true
, Immuta will only pull new tables from the source server. This parameter can only be paired with schemaEvolutionId.
No
overrides.httpPath
string
If Databricks ephemeral overrides are configured, provide the alternative HTTP path to trigger schema monitoring on that ephemeral cluster.
No
Response Parameters
schemaDetection
string
Metadata regarding the jobs.
columnDetection
string
Metadata regarding the jobs.
bulkId
string
The unique identifier of the jobs running schema monitoring and column detection.
Request example
The following request triggers the schema monitoring job for the specified detection group.
Payload example
The tabs below illustrate payloads for triggering schema monitoring on a host, database, or table. The request will run schema monitoring for all databases registered under the hostname provided in the payload.
The request will run schema monitoring for all databases registered under the hostname provided in the payload.
Response examples
The tabs below illustrate the example response for each example payload provided above.
View and Review Data Sources
GET
Get all of the recent policy activities for a given data source.
GET
Return the users who can unmask the given column.
Run a data source health check
GET
/dataSource/{dataSourceId}/test
Run a health check on the data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Response Parameters
blob
object
Indicates whether or not the blob was successfully crawled.
columnEvolution
object
Indicates whether or not the job run to check for columns added or removed from the data source passed
and when it was last run.
externalCatalog
object
Indicates whether or not the external catalog was successfully linked to the data source.
fingerprint
object
Indicates whether or not the fingerprint job was successful (passed
) and when it was last run. The fingerprint captures summary statistics of the data source.
globalPolicy
object
Indicates whether or not global policies were successfully applied to the data source.
highCardinality
object
Indicates whether or not the job run to calculate the data source's high cardinality column passed
and when it was last run.
schemaEvolution
object
Indicates whether or not the job run to check if a new table had been added in the remote database passed
and when it was last run. If a new table was added, Immuta automatically creates a new data source. Correspondingly, if a remote table is removed, that data source will be disabled in the console.
sdd
object
Indicates whether or not sensitive data discovery was successfully run on the data source.
sql
object
Indicates whether or not the SQL query run to check the data source's health passed
and when it was last run.
stats
object
Indicates whether or not the job run to calculate the number of rows in the data source passed
and when it was last run.
Request example
The following request tests a data source.
Response example
Retrieve blob handlers
GET
/dataSource/blobHandlerTypes
Retrieve all blob handlers the current user is allowed to create.
Response Parameters
name
string
The name of the blob handler.
baseUrl
string
The base URL for the data source.
config
array
Includes information about the connection configuration.
port
integer
The port number.
driver
string
The name of the driver.
Request example
The following request retrieves all blob handlers the current user is allowed to create.
Response example
Get data sources by purpose
GET
/dataSource/byPurposes
Get data sources that match a set of purposes.
Query Parameters
purposes
array[string]
The purposes to filter the data sources by.
Yes
excludedProjects
array[integer]
Excludes data sources associated with specified project IDs.
No
Response Parameters
id
integer
The data source ID.
name
array
The name of the data source.
policyId
integer
The policy ID.
restrictions
array
Details regarding the operator
(and
or or
) and purposes
.
Request example
The following request gets data sources that match a set of purposes.
Response example
Return SQL connection parameters
GET
/dataSource/featureStore
Return the user's SQL connection parameters as JSON.
Response Parameters
host
string
The host of the Immuta database.
port
integer
The port number of the Immuta database.
database
string
The name of the Immuta database.
user
string
The SQL username.
sslmode
string
Indicates whether or not SSL is required.
Request example
The following request returns the user's connection parameters for the feature store as JSON.
Response example
Return SQL connection string
GET
/dataSource/featureStore/connection
Return the user's SQL connection string.
Response Parameters
connectionString
string
The connection string.
host
string
The host for the Immuta database.
port
integer
The port number for the Immuta database.
database
string
The Immuta database name.
sslMode
string
Indicates whether or not SSL is required.
sqlUser
string
The SQL username.
Request example
The following request returns the user's connection string or the feature store.
Response example
Retrieve data sources by user
GET
/dataSource/rpc/mine
Retrieves all the data sources the current user has access to.
Response Parameters
id
integer
The data source ID.
name
string
The data source name.
type
string
The type of data source, such as ingested
.
sqlTableName
string
The name of the table in the Immuta Query Engine.
sqlSchemaName
string
The name of the schema in the Immuta Query Engine.
blobHandlerType
string
The type of handler, such as Snowflake
.
sparkUseJDBC
boolean
When true
, uses a JDBC driver.
Request example
The following request retrieves all the data sources the current user has access to.
Response example
Get all comments by data source
GET
/dataSource/{dataSourceId}/comments
Get all of the comments for the data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
columns
array[string]
The columns for which to retrieve comments.
No
queries
array[string]
The queries for which to retrieve comments.
No
resolved
boolean
When true
, will only retrieve comments that are resolved.
No
sortField
string
The field by which to sort results: createdAt
, totalreplies
, lastreply
, body
, or profile.name
.
No
sortOrder
string
Determines whether to sort results in ascending (asc
) or descending (desc
) order.
No
Response Parameters
author
array
Details about the author, including id
, name
, and email
.
body
string
The text of the comment.
totalreplies
integer
The total number of replies to a comment.
public
boolean
When true
, the comment is visible to all users.
Request example
The following request gets all of the comments for data source 23
.
Response example
Get recent policy activities for a data source
GET
/dataSource/{dataSourceId}/activities
Get all of the recent policy activities for a given data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
offset
integer
The number of results to skip (for paging).
No
size
integer
The number of results to return per page.
No
Response Parameters
count
integer
The number of results.
activities
array
Includes details about the policy and the data source, including the policy and data source type, when the activity notification was triggered, and whether or not the policy change was triggered by a Global policy.
actionBy
array
Details about who triggered the action.
targetUser
array
Information about the user who received the notification.
Request example
The following request gets all of the recent policy activities for a given data source.
Response example
Get profiles for data source owners and experts
GET
/dataSource/{dataSourceId}/contacts
Gets the profiles for the data source owners and experts.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Response Parameters
id
integer
The data source ID.
state
string
The user's data source role, such as owner
or subscribed
.
name
string
The user's name.
string
The user's email.
profile
integer
The user's profile ID.
Request example
The following request gets all the profiles for the data source owners and experts.
Response example
Get tags by data source
GET
/dataSource/{dataSourceId}/tags
Get the tags for a data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
blobId
string
Returns the tags for the specified blob.
No
blobTagsOnly
boolean
When true
, will only display blob tags associated with a data source.
No
Response Parameters
tags
array
Includes details about the tags, such as the name
, source
, and the profile ID of the user who added the tag.
Request example
The following request gets the tags for data source 4
.
Response example
Get users who can unmask columns
GET
/dataSource/{dataSourceId}/{columnName}/unmaskUsers
Return the users who can unmask the given column.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
columnName
string
The name of the column to unmask.
Yes
Response Parameters
name
array
The name of the user who can unmask the value.
profileId
integer
The profile ID of the user who can unmask the value.
iamid
string
The IAM ID of the user who can unmask the value.
Request example
The following request returns the users who can unmask the given column.
Response example
Get replies to a comment
GET
/dataSource/{dataSourceId}/comments/{parentId}/replies
Get all of the replies to a specified comment.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
parentId
integer
The ID of the parent comment.
Yes
Response Parameters
author
array
Information about the author of the reply, including their name
and email
.
body
string
The reply to the data source comment.
resolved
boolean
When true
, the reply has been resolved.
id
integer
The comment ID.
createdAt
timestamp
The date and time the reply was written.
updatedAt
timestamp
The date and time the reply was updated.
totalreplies
integer
The number of total replies to the comment.
lastreply
timestamp
The date and time of the last reply.
public
boolean
If true
, the comment is public.
Request example
The following request gets replies to the data source comment 28
.
Response example
Delete Data Sources or Comments
DELETE
Delete a data source. This will perform a soft delete on the first call and a hard delete the second time.
DELETE
Delete a data source comment (and potentially the comment replies).
DELETE
Delete all SQL accounts for user.
Delete a data source
DELETE
/dataSource/{dataSourceId}
Delete a data source. This will perform a soft delete on the first call and a hard delete the second time.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Response Parameters
success
boolean
If true
, the data source is deleted.
id
integer
The data source ID.
schemaEvolutionId
integer
The schema evolution ID.
name
string
The data source name.
disabled
boolean
If true
, the data source is disabled.
handlerDeleteErrorMessage
string
The delete error message.
Request example
The following request deletes the data source 23
.
Response example
Delete a task
DELETE
/dataSource/tasks/{taskId}
Delete the specified task.
Query Parameters
taskId
integer
Target task ID.
Yes
Response Parameters
id
integer
The deleted task ID.
state
array
The state of the deleted task, such as pending
.
type
array
The type of deleted task, such as columnAdded
.
targetNames
string
The name of the user who received the request.
targetEmails
string
The email of the user who received the request.
requester
metadata
Details regarding the requesting profile.
dataSource
metadata
details regarding the data source.
metadata
array
Details about the deleted task.
Request example
The following request deletes a specified task.
Response example
Delete a blob
DELETE
/dataSource/{dataSourceId}/blob/{blobId*}
Delete a blob.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
blobId
string
The blob ID.
Yes
Response Parameters
When the blob is successfully deleted, there will be no response.
Request example
The following request deletes a blob.
Delete a data source comment
DELETE
/dataSource/{dataSourceId}/comments/{commentId}
Delete a data source comment (and potentially the comment replies).
Query Parameters
dataSourceId
integer
The data source ID.
Yes
commentId
string
The comment ID.
Yes
Response Parameters
status
boolean
If true
, the data source comment is deleted.
Request example
The following request deletes the comment 3
.
Response example
Unsubscribe from a data source
DELETE
/dataSource/{dataSourceId}/unsubscribe
Unsubscribe from a data source.
Query Parameters
dataSourceId
integer
The data source ID.
Yes
Response Parameters
status
boolean
If true
, the requesting user is unsubscribed from the data source.
Request example
The following request unsubscribes the user from data source 23
.
Response example
Delete a SQL account
DELETE
/dataSource/featureStore/account/{sqlUsername}
| Delete a SQL account. |
Query Parameters
sqlUsername
string
The SQL username.
Yes
Response Parameters
status
boolean
If true
, the SQL account is deleted.
Request example
The following request deletes the specified SQL account.
Response example
Delete all SQL accounts for a user
DELETE
/dataSource/featureStore/accounts/{targetProfileId}/{targetUserId}
Delete all SQL accounts for user.
Query Parameters
targetProfileId
integer
The profile ID of the user whose SQL accounts will be deleted.
Yes
targetUserId
string
The user's profile ID.
Yes
Response Parameters
status
boolean
If true
, all SQL accounts for the user are deleted.
Request example
The following request deletes all SQL accounts for the user.
Response example
Last updated