LogoLogo
SaaS
  • Immuta Documentation - SaaS
  • Configuration
    • Connect Data Platforms
      • Data Platforms Overview
      • Amazon S3 Integration
      • AWS Lake Formation
        • Getting Started with AWS Lake Formation
        • Register an AWS Lake Formation Connection
        • Reference Guides
          • AWS Lake Formation
          • Security and Compliance
          • Protecting Data
          • Accessing Data
      • Azure Synapse Analytics
        • Getting Started with Azure Synapse Analytics
        • Configure Azure Synapse Analytics Integration
        • Reference Guides
          • Azure Synapse Analytics Overview
          • Azure Synapse Analytics Pre-Configuration Details
      • Databricks
        • Databricks Spark
          • Getting Started with Databricks Spark
          • How-to Guides
            • Configure a Databricks Spark Integration
            • Manually Update Your Databricks Cluster
            • Install a Trusted Library
            • Project UDFs Cache Settings
            • Run R and Scala spark-submit Jobs on Databricks
            • DBFS Access
            • Troubleshooting
          • Reference Guides
            • Databricks Spark Integration Configuration
              • Installation and Compliance
              • Customizing the Integration
              • Setting Up Users
              • Spark Environment Variables
              • Ephemeral Overrides
            • Security and Compliance
            • Registering and Protecting Data
            • Accessing Data
              • Delta Lake API
        • Databricks Unity Catalog
          • Getting Started with Databricks Unity Catalog
          • How-to Guides
            • Configure a Databricks Unity Catalog Integration
            • Migrating to Unity Catalog
          • Databricks Unity Catalog Integration Reference Guide
      • Google BigQuery Integration
      • Redshift
        • Getting Started with Redshift
        • How-to Guides
          • Configure Redshift Integration
          • Configure Redshift Spectrum
        • Reference Guides
          • Redshift Overview
          • Redshift Pre-Configuration Details
      • Snowflake
        • Getting Started with Snowflake
        • How-to Guides
          • Configure a Snowflake Integration
          • Edit or Remove Your Snowflake Integration
          • Integration Settings
            • Snowflake Table Grants Private Preview Migration
            • Enable Snowflake Table Grants
            • Using Snowflake Data Sharing with Immuta
            • Enable Snowflake Low Row Access Policy Mode
              • Upgrade Snowflake Low Row Access Policy Mode
            • Configure Snowflake Lineage Tag Propagation
        • Reference Guides
          • Snowflake Integration
          • Snowflake Table Grants
          • Snowflake Data Sharing with Immuta
          • Snowflake Low Row Access Policy Mode
          • Snowflake Lineage Tag Propagation
          • Warehouse Sizing Recommendations
        • Explanatory Guides
          • Phased Snowflake Onboarding
      • Starburst (Trino)
        • Getting Started with Starburst (Trino)
        • How-to Guides
          • Configure Starburst (Trino) Integration
          • Customize Read and Write Access Policies for Starburst (Trino)
        • Starburst (Trino) Integration Reference Guide
      • Queries Immuta Runs in Your Data Platform
      • Connect Your Data
        • Registering a Connection
          • How-to Guides
            • Register a Snowflake Connection
            • Register a Databricks Unity Catalog Connection
            • Manually Run Object Sync
            • Manage Connection Settings
            • Use the Connection Upgrade Manager
              • Troubleshooting
          • Reference Guides
            • Connections
            • Upgrading to Connections
              • Before You Begin
              • API Changes
              • FAQ
        • Registering Metadata
          • Data Sources in Immuta
          • Register Data Sources
            • Amazon S3 Data Source
            • Azure Synapse Analytics Data Source
            • Databricks Data Source
            • Google BigQuery Data Source
            • Redshift Data Source
            • Snowflake Data Source
              • Bulk Create Snowflake Data Sources
            • Create a Starburst (Trino) Data Source
          • Data Source Settings
            • How-to Guides
              • Manage Data Source Settings
              • Manage Data Source Members
              • Manage Access Requests and Tasks
              • Manage Data Dictionary Descriptions
              • Disable Immuta from Sampling Raw Data
            • Data Source Health Checks Reference Guide
          • Schema Monitoring
            • How-to Guides
              • Manage Schema Monitoring
              • Run Schema Monitoring and Column Detection Jobs
            • Reference Guides
              • Schema Monitoring
              • Schema Projects
            • Why Use Schema Monitoring Concept Guide
    • Manage Data Metadata
      • Connect External Catalogs
        • Configure an External Catalog
        • Reference Guides
          • External Catalog Introduction
          • Custom REST Catalog Interface Introduction
          • Custom REST Catalog Interface Endpoints
      • Data Discovery
        • Introduction
        • Getting Started with Data Discovery
        • How-to Guides
          • Use Identifiers in Domains
          • Use Sensitive Data Discovery (SDD)
          • Manage Identification Frameworks
          • Manage Identifiers
          • Run and Manage Sensitive Data Discovery on Data Sources
        • Reference Guides
          • Identifiers in Domains
          • Built-in Identifier Reference
          • Improved Pack: Built-in Identifier Reference
          • Built-in Discovered Tags Reference
          • How Competitive Pattern Analysis Works
      • Data Classification
        • How-to Guides
          • Activate Classification Frameworks
          • Adjust Identification and Classification Framework Tags
          • How to Use a Classification Framework with Your Own Tags
        • Reference Guide
          • Classification Frameworks
      • Manage Tags
        • How-to Guides
          • Create and Manage Tags
          • Add Tags to Data Sources and Projects
        • Tags Reference Guide
    • Manage Users
      • Getting Started with Users
      • Identity Managers (IAMs)
        • How-to Guides
          • Okta LDAP Interface
          • OpenID Connect
            • OpenID Connect Protocol
            • Okta and OpenID Connect
            • OneLogin with OpenID Connect
          • SAML
            • SAML Protocol
            • Microsoft Entra ID
            • Okta SAML SCIM
        • Reference Guides
          • Identity Managers
          • SAML Protocol Configuration Options
          • SAML Single Logout
      • Immuta Users
        • How-to Guides
          • Managing Personas and Permissions
          • User Impersonation
          • Manage Attributes and Groups
          • External User ID Mapping
          • External User Info Endpoint
        • Reference Guides
          • Permissions and Personas
          • Attributes and Groups in Immuta
    • Organize Data into Domains
      • Getting Started with Domains
      • Domains Reference Guide
    • Application Settings
      • How-to Guides
        • App Settings
        • Private Networking Support
          • Data Connection Private Networking
            • AWS PrivateLink for Redshift
            • AWS PrivateLink for API Gateway
            • Databricks Private Connectivity
              • AWS PrivateLink for Databricks
              • Azure Private Link for Databricks
            • Snowflake Private Connectivity
              • AWS PrivateLink for Snowflake
              • Azure Private Link for Snowflake
            • Starburst (Trino) Private Connectivity
              • AWS PrivateLink for Starburst (Trino)
              • Azure Private Link for Starburst (Trino)
          • Immuta SaaS Private Networking
            • Immuta SaaS Private Networking Over AWS PrivateLink
        • BI Tools
          • BI Tool Configuration Recommendations
          • Power BI Configuration Example
          • Tableau Configuration Example
        • IP Filtering
        • System Status Bundle
      • Reference Guides
        • Deployment Options
        • Data Processing
        • Encryption and Masking Practices
  • Marketplace
    • Introduction
      • User Types
      • Walkthrough
    • Share Data Products
      • How-to Guides
        • Manage Data Products
        • View and Respond to Access Requests
        • Customize the Marketplace Branding
      • Reference Guides
        • Marketplace App Requirements
        • Data Products
        • Marketplace Permissions Matrix
        • Understanding Access Provisioning and Underlying Policies in Immuta
          • S3 Provisioning Best Practices
        • Integrating with Existing Catalogs
        • Setting Up Domains for Marketplace
    • Access Data Products
      • How-to Guides
        • Logging into Marketplace
        • Requesting Access to a Data Product
      • Reference Guide
        • Data Source Access Status
    • Short-Term Limitations
  • Governance
    • Introduction
      • Automate Data Access Control Decisions
        • The Two Paths
        • Managing User Metadata
        • Managing Data Metadata
        • Author Policy
        • Test and Deploy Policy
      • Compliantly Open More Sensitive Data for ML and Analytics
        • Managing User Metadata
        • Managing Data Metadata
        • Author Policy
    • Author Policies for Data Access Control
      • Introduction
        • Scalability and Evolvability
        • Understandability
        • Distributed Stewardship
        • Consistency
        • Availability of Data
      • Policies
        • Authoring Policies at Scale
        • Data Engineering with Limited Policy Downtime
        • Subscription Policies
          • Overview
          • How-to Guides
            • Author a Subscription Policy
            • Author an ABAC Subscription Policy
            • Subscription Policies Advanced DSL Guide
            • Author a Restricted Subscription Policy
            • Clone, Activate, or Stage a Global Policy
          • Reference Guides
            • Subscription Policy Access Types
            • Advanced Use of Special Functions
        • Data Policies
          • Overview
          • How-to Guides
            • Author a Masking Data Policy
            • Author a Minimization Policy
            • Author a Purpose-Based Restriction Policy
            • Author a Restricted Data Policy
            • Author a Row-Level Policy
            • Author a Time-Based Restriction Policy
            • Policy Certifications and Diffs
          • Reference Guides
            • Data Policy Types
            • Masking Policies
            • Row-Level Policies
            • Custom WHERE Clause Functions
            • Data Policy Conflicts and Fallback
            • Custom Data Policy Certifications
            • Orchestrated Masking Policies
      • Projects and Purpose-Based Access Control
        • Projects and Purpose Controls
          • Getting Started
          • How-to Guides
            • Create a Project
            • Create and Manage Purposes
            • Adjust a Policy
            • Project Management
              • Manage Projects and Project Settings
              • Manage Project Data Sources
              • Manage Project Members
          • Reference Guides
            • Projects and Purposes
            • Policy Adjustments
          • Concept Guide
            • Why Use Purposes?
        • Equalized Access
          • Manage Project Equalization How-to Guide
          • Equalized Access Reference Guide
          • Why Use Project Equalization?
        • Masked Joins
          • Enable Masked Joins How-to Guide
          • Why Use Masked Joins?
        • Writing to Projects
          • How-to Guides
            • Create and Manage Snowflake Project Workspaces
            • Create and Manage Databricks Spark Project Workspaces
            • Write Data to the Workspace
          • Reference Guides
            • Writing to Projects
            • Project UDFs (Databricks)
      • Data Consumers
        • Subscribe to a Data Source
        • Query Data
          • Querying Snowflake Data
          • Querying Databricks Data
          • Querying Starburst (Trino) Data
          • Querying Databricks SQL Data
          • Querying Redshift Data
          • Querying Azure Synapse Analytics Data
        • Subscribe to Projects
    • Observe Access and Activity
      • Introduction
      • Audit
        • How-to Guides
          • Export Audit Logs to S3
          • Export Audit Logs to ADLS
          • Use Immuta Audit
          • Run Governance Reports
        • Reference Guides
          • Universal Audit Model (UAM)
            • UAM Schema Reference Guide
          • Query Audit Logs
            • Snowflake Query Audit Logs
            • Databricks Unity Catalog Query Audit Logs
            • Databricks Spark Query Audit Logs
            • Starburst (Trino) Query Audit Logs
          • Audit Export GraphQL Reference Guide
          • Unknown Users in Audit Logs
          • Governance Report Types
      • Dashboards
        • Use the Audit Dashboards How-To Guide
        • Audit Dashboards Reference Guide
      • Monitors
        • Manage Monitors and Observations
        • Monitors Reference Guide
  • Releases
    • Deployment Notes
      • 2024
      • 2023
      • 2022
    • Scheduled Maintenance Windows
    • Immuta Support Matrix Overview
    • Immuta CLI Release Notes
    • Preview Features
      • Features in Preview
    • Deprecations
  • Developer Guides
    • The Immuta CLI
      • Install and Configure the Immuta CLI
      • Manage Your Immuta Tenant
      • Manage Data Sources
      • Manage Sensitive Data Discovery
        • Manage Sensitive Data Discovery Rules
        • Manage Identification Frameworks
        • Run Sensitive Data Discovery on Data Sources
      • Manage Policies
      • Manage Projects
      • Manage Purposes
      • Manage Audit Export
    • The Immuta API
      • Integrations API
        • Getting Started
        • How-to Guides
          • Configure an Amazon S3 Integration
          • Configure an Azure Synapse Analytics Integration
          • Configure a Databricks Unity Catalog Integration
          • Configure a Google BigQuery Integration
          • Configure a Redshift Integration
          • Configure a Snowflake Integration
          • Configure a Starburst (Trino) Integration
        • Reference Guides
          • Integrations API Endpoints
          • Integration Configuration Payload
          • Response Schema
          • HTTP Status Codes and Error Messages
      • Connections API
        • How-to Guides
          • Register a Connection
            • Register a Snowflake Connection
            • Register a Databricks Unity Catalog Connection
            • Register an AWS Lake Formation Connection
          • Manage a Connection
          • Deregister a Connection
        • Connection Registration Payloads Reference Guide
      • Marketplace API
        • Marketplace API Endpoints
        • Source Controlling Data Products
      • Immuta V2 API
        • Data Source Payload Attribute Details
          • Data Source Request Payload Examples
        • Create Policies API Examples
        • Create Projects API Examples
        • Create Purposes API Examples
      • Immuta V1 API
        • Authenticate with the API
        • Configure Your Instance of Immuta
          • Get Job Status
          • Manage Frameworks
          • Manage IAMs
          • Manage Licenses
          • Manage Notifications
          • Manage Identifiers in Domains
            • API Changes - Identification Frameworks to Identifiers in Domains
          • Manage Sensitive Data Discovery (SDD)
          • Manage Tags
          • Manage Webhooks
          • Search Filters
        • Connect Your Data
          • Create and Manage an Amazon S3 Data Source
          • Create an Azure Synapse Analytics Data Source
          • Create a Databricks Data Source
          • Create a Redshift Data Source
          • Create a Snowflake Data Source
          • Create a Starburst (Trino) Data Source
          • Manage the Data Dictionary
        • Use Domains
        • Manage Data Access
          • Manage Access Requests
          • Manage Data and Subscription Policies
          • Manage Write Policies
            • Write Policies Payloads and Response Schema Reference Guide
          • Policy Handler Objects
          • Search Audit Logs
          • Search Connection Strings
          • Search for Organizations
          • Search Schemas
        • Subscribe to and Manage Data Sources
        • Manage Projects and Purposes
          • Manage Projects
          • Manage Purposes
        • Generate Governance Reports
Powered by GitBook

Self-managed versions

  • 2024.3
  • 2024.2

Resources

  • Immuta Changelog

Copyright © 2014-2025 Immuta Inc. All rights reserved.

On this page

Was this helpful?

Export as PDF
  1. Marketplace
  2. Share Data Products
  3. How-to Guides

Manage Data Products

PreviousHow-to GuidesNextView and Respond to Access Requests

Last updated 21 days ago

Was this helpful?

Private preview: The Marketplace app is available to select accounts. Contact your Immuta representative for details.

Data product managers are able to publish and manage .

Requirement: Immuta permission GOVERNANCE or Manage Data Product in a domain

Publishing a data product

With the UI

,

  1. Click Publish product.

  2. Select the Domain from the dropdown. You will only be able to include data source from this domain in your data product. .

  3. Click Next.

  4. Select the data sources you want in the data product. .

  5. Click Next.

  6. Enter the following metadata for your new data product:

    • Name of the data product

    • Description of the data product (optional)

    • Enter the subject matter expert (optional). This should be a user that data consumers and stewards can reach out to for any questions about the data product.

  7. Click Next.

  8. Choose if you would like to require approval for access to this data product:

    • Yes: When the user requests access, in addition to acknowledging the data use agreement and answering the required question, they will need to be approved by one of the approvers. Approvers must have the global GOVERNANCE or domain-specific Manage Data Products permission.

    • No: When the user requests access, they will be automatically approved once they acknowledge the data use agreement and answer any question required for access.

  9. Add a data use agreement (optional). You can create a data use agreement yourself or use the default data use agreement. The data use agreement is what the data consumer must agree to when requesting access to your data product.

  10. Click Publish data product.

With the API

Editing data products

Once a data product has been published, many components can be edited from different parts of the data product:

  • Details: Edit the name, description, or subject matter expert

  • Data sources: Add or remove data sources from the data product

  • Request policy: Edit the required approval or the data use agreement

With the UI

  1. Select the data product.

  2. Navigate to the tab with the information you want to edit.

  3. Click Edit.

  4. Make your edits and click Save.

With the API

Update the request settings

To update the request settings of a data product:

  1. Run POST /api/approval-policy : Use the ID from the response in the next call.

  2. Run PUT/api/data-product/{id} : The ID in the request should be the data product ID and the approval policy ID from the previous call should be included in the payload.

Update the data sources

To update data sources associated with a data product:

Suspend access to data products

Data products can be suspended. Suspending access revokes all access to data sources in the data product that was gained from the manual approvals in the Marketplace. However, the data product access can be resumed to grant the approvals again.

With the UI

  1. Select the data product.

  2. Navigate to the Settings tab.

  3. Select Suspend access and then click Suspend access on the modal.

With the API

Update the suspended parameter using the endpoint below:

Deleting data products

It is also possible to delete data products, which will remove all users' access to the data sources within the data product. Deleting a data product cannot be undone.

With the UI

  1. Select the data product.

  2. Navigate to the Settings tab.

  3. Click Delete data product.

  4. Enter the name of your data product in the textbox and then click Delete again.

With the API

Ensure you set the and use a when using the Marketplace API. See the for additional guidance or to download the OpenAPI YAML for your own client generation.

There is a with the Marketplace app where adding data sources to a data product with active subscription policies set to Always Require could result in currently subscribed users losing access.

,

Ensure you set the and use a when using the Marketplace API. See the for additional guidance or to download the OpenAPI YAML for your own client generation.

Ensure you set the and use a when using the Marketplace API. See the for additional guidance or to download the OpenAPI YAML for your own client generation.

,

Ensure you set the and use a when using the Marketplace API. See the for additional guidance or to download the OpenAPI YAML for your own client generation.

,

Ensure you set the and use a when using the Marketplace API. See the for additional guidance or to download the OpenAPI YAML for your own client generation.

From the Marketplace app
From the Marketplace app
From the Marketplace app
data products
From the Marketplace app
Marketplace API docs
Marketplace API docs
Marketplace API docs
Marketplace API docs
Marketplace API docs

Delete data product by ID

delete

Delete the specified data product from the system

Authorizations
Path parameters
idstringRequired
Responses
200Success
delete
DELETE /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success

No content

  • Publishing a data product
  • With the UI
  • With the API
  • POSTAdd new data products to the marketplace
  • Editing data products
  • With the UI
  • With the API
  • POSTCreate an approval policy
  • PUTUpdate an existing data product
  • PUTUpdate the data product's data sources
  • Suspend access to data products
  • With the UI
  • With the API
  • PUTUpdate an existing data product
  • Deleting data products
  • With the UI
  • With the API
  • DELETEDelete data product by ID

Add new data products to the marketplace

post

Add one or more data products to the marketplace

Authorizations
Body
namestring · min: 1 · max: 64Required

Data product name

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$
descriptionone of | nullableOptional

Data product description

stringOptional

Data product description

Example: All sales records from the current fiscal year
domainsstring[]RequiredExample: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]
approvalPolicyIdone of | nullableOptional
string · cuidOptional
or
string · uuidOptional
requestFormIdone of | nullableOptional
string · cuidOptional
or
string · uuidOptional
statusstring · enumOptionalExample: PENDINGPossible values:
sourceTypesstring[]Optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]
idstring · uuidOptional

Data product ID

metadataone of | nullableRequired
Responses
201Success
application/json
409
Data Product name in use.
post
POST /marketplace/api/data-product HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 635

{
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataSources": [
    {
      "sourceId": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-16T11:29:29.849Z",
  "updatedAt": "2025-05-16T11:29:29.849Z",
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Create an approval policy

post

Creates a new approval policy based on the provided policy JSON

Authorizations
Body
Responses
200Success
application/json
post
POST /marketplace/api/approval-policy HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "policyJSON": {
    "policyVersion": "text",
    "dataAccessAgreements": [
      "text"
    ],
    "reason": "text",
    "stages": [
      {
        "name": "text",
        "required": [
          {
            "type": "USER",
            "id": "text",
            "displayName": "text"
          }
        ]
      }
    ]
  }
}
200Success
{
  "id": "text",
  "policyJSON": {
    "policyVersion": "text",
    "dataAccessAgreements": [
      "text"
    ],
    "reason": "text",
    "stages": [
      {
        "name": "text",
        "required": [
          {
            "type": "USER",
            "id": "text",
            "displayName": "text"
          }
        ]
      }
    ]
  }
}

Update an existing data product

put

Update an existing data product by ID

Authorizations
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64Optional

Data product name

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$
descriptionone of | nullableOptional

Data product description

stringOptional

Data product description

Example: All sales records from the current fiscal year
domainsstring[]OptionalExample: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]
approvalPolicyIdone of | nullableOptional
string · cuidOptional
or
string · uuidOptional
requestFormIdone of | nullableOptional
string · cuidOptional
or
string · uuidOptional
statusstring · enumOptionalExample: PENDINGPossible values:
sourceTypesstring[]Optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]
idstring · uuidOptional

Data product ID

metadataone of | nullableOptional
suspendedbooleanOptional

Whether access to the data product's data sources are suspended

Example: false
Responses
200Success
application/json
put
PUT /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 653

{
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataSources": [
    {
      "sourceId": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "suspended": false
}
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-16T11:29:29.849Z",
  "updatedAt": "2025-05-16T11:29:29.849Z",
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Update the data product's data sources

put

Update the data sources associated with the data product. Any currently associated data sources not included in the payload will be removed.

Authorizations
Path parameters
idstringRequired
Body
Responses
200Success
application/json
put
PUT /marketplace/api/data-product/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "dataSources": [
    {
      "sourceId": "text"
    }
  ]
}
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-16T11:29:29.849Z",
  "updatedAt": "2025-05-16T11:29:29.849Z",
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Update an existing data product

put

Update an existing data product by ID

Authorizations
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64Optional

Data product name

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$
descriptionone of | nullableOptional

Data product description

stringOptional

Data product description

Example: All sales records from the current fiscal year
domainsstring[]OptionalExample: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]
approvalPolicyIdone of | nullableOptional
string · cuidOptional
or
string · uuidOptional
requestFormIdone of | nullableOptional
string · cuidOptional
or
string · uuidOptional
statusstring · enumOptionalExample: PENDINGPossible values:
sourceTypesstring[]Optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]
idstring · uuidOptional

Data product ID

metadataone of | nullableOptional
suspendedbooleanOptional

Whether access to the data product's data sources are suspended

Example: false
Responses
200Success
application/json
put
PUT /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 653

{
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataSources": [
    {
      "sourceId": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "suspended": false
}
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-16T11:29:29.849Z",
  "updatedAt": "2025-05-16T11:29:29.849Z",
  "approvalPolicyId": "text",
  "requestFormId": "text",
  "status": "PENDING",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}
If you do not see a domain available, create one with at least one data source
If you do not see a data source you expected to see, it is not in the domain you selected
correct global segment
Marketplace-specific personal access token (PAT)
correct global segment
Marketplace-specific personal access token (PAT)
correct global segment
Marketplace-specific personal access token (PAT)
correct global segment
Marketplace-specific personal access token (PAT)
correct global segment
Marketplace-specific personal access token (PAT)
short term limitation