Marketplace API Endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
Search and filter access requests the current user can manage
The ID of the data product to filter requests by
Whether to include historical access requests
true
Whether to include temporary access requests
false
0
10
desc
Possible values: createdAt
Possible values: GET /marketplace/api/access-request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"id": "text",
"requestingUser": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"user": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"formVersion": "text",
"form": null,
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"dataProduct": {
"id": "text",
"name": "text",
"description": "All sales records from the current fiscal year"
}
}
],
"meta": {
"offset": 0,
"limit": 10,
"totalCount": 1,
"pageCount": 1,
"currentPage": 1,
"totalPages": 1
}
}
Cancel the specified pending access request by ID, cascading the cancellation to any pending and blocked approval records.
DELETE /marketplace/api/access-request/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
No content
Returns specific details for a specific access request
GET /marketplace/api/access-request/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"id": "text",
"requestingUser": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"user": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"formVersion": "text",
"form": null,
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"dataProduct": {
"id": "text",
"name": "text",
"description": "All sales records from the current fiscal year"
}
}
Returns all approval records associated with a specific access request
GET /marketplace/api/access-request/{id}/records HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"approvalRecords": [
{
"id": "text",
"dataAccessRequestId": "text",
"approvers": [
{
"type": "USER",
"id": "text",
"displayName": "text"
}
],
"prerequisites": [
"text"
],
"actionBy": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"status": "PENDING",
"reason": "text",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z"
}
]
}
Returns the risk assessment for a specific access request
GET /marketplace/api/access-request/{id}/risk-assessment HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"conflictDetected": true,
"approvalRisk": "HIGH",
"recommendation": "APPROVED",
"nAllowed": 1,
"nDenied": 1,
"riskValue": 1,
"cohort": {
"literals": [
{
"name": "text"
},
{
"negation": true
}
]
},
"medianApprovalTimeWindowInDays": 1,
"explanation": "text",
"approvalReasons": [
"text"
],
"denialReasons": [
"text"
]
}
Search data products in the marketplace using the provided filters
Pagination token to fetch the next page of results
The number of items to return per page
10
asc
Possible values: GET /marketplace/api/data-product HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"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-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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"
}
]
}
],
"meta": {
"nextToken": "text",
"limit": 10
}
}
Get data product metadata for the specified data product ID
GET /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"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-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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"
}
]
}
Search all data sources for the data product using the provided filters
Pagination token to fetch the next page of results
The number of items to return per page
10
The global user ID to search data source access status for
GET /marketplace/api/data-product/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"id": "text",
"name": "Web Sales 2024",
"type": "text",
"hostname": "text",
"database": "text",
"schema": "text",
"table": "text",
"prefix": "text",
"status": "NONE"
}
],
"meta": {
"nextToken": "text",
"limit": 10
}
}
Get all data sources in the data product
GET /marketplace/api/data-product/{id}/datasources/all HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"dataSources": [
{
"sourceId": "text"
}
]
}
Search all access requests for the data product using the provided filters
Whether to include historical access requests
true
Whether to include temporary access requests
false
0
10
desc
Possible values: createdAt
Possible values: GET /marketplace/api/data-product/{id}/request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"id": "text",
"requestingUser": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"user": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"formVersion": "text",
"form": null,
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"dataProduct": {
"id": "text",
"name": "text",
"description": "All sales records from the current fiscal year"
}
}
],
"meta": {
"offset": 0,
"limit": 10,
"totalCount": 1,
"pageCount": 1,
"currentPage": 1,
"totalPages": 1
}
}
Updates the specified access request to revoked and revokes access to data sources associated with the data product
DELETE /marketplace/api/data-product/{id}/request/{requestId} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
No content
Returns 5 most recent data access requests with a terminal status as well as the approval records which contributed to that status.
GET /marketplace/api/data-product/{id}/recent-determinations HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"determinations": [
{
"id": "text",
"requestingUser": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"user": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"actionBy": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"reason": "text",
"status": "PENDING",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"expiration": "2025-06-20T23:56:33.929Z"
}
]
}
Get data product metadata for the specified data product name
GET /marketplace/api/data-product/{name}/byName HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"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-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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"
}
]
}
Search data use agreements in the Marketplace using the provided filters
0
10
asc
Possible values: name
Possible values: Filter results by data use agreement name
""
Whether the filter should be an exact match
false
GET /marketplace/api/data-use-agreement HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text",
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z"
}
],
"meta": {
"offset": 0,
"limit": 10,
"totalCount": 1,
"pageCount": 1,
"currentPage": 1,
"totalPages": 1
}
}
Get data use agreement by ID
GET /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text",
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z"
}
Get request forms associated with a data use agreement.
GET /marketplace/api/data-use-agreement/{id}/request-forms HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
}
]
Search across all attributes in Immuta
GET /marketplace/api/metadata/attributes HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"attributes": [
{
"type": "text",
"value": "text"
}
]
}
Search Immuta domains that can be used to create a data product in the marketplace
GET /marketplace/api/metadata/domain HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"domains": [
{
"id": "text",
"name": "North American Sales",
"description": "A collection of data sources relevant to North American sales"
}
]
}
Returns the Immuta domain specified in the request
GET /marketplace/api/metadata/domain/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"id": "text",
"name": "North American Sales",
"description": "A collection of data sources relevant to North American sales"
}
Search data sources within the selected domain that can be included in a data product
0
10
Search text to filter data sources
Array of IDs to filter data sources
GET /marketplace/api/metadata/domain/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"dataSourceId": 1,
"name": "November 2023 Online",
"platform": "Databricks",
"createdAt": "2025-06-20T23:56:33.929Z",
"prefix": "text",
"hostname": "text",
"database": "text",
"schema": "text",
"table": "text"
}
],
"meta": {
"offset": 0,
"limit": 10,
"totalCount": 1,
"pageCount": 1,
"currentPage": 1,
"totalPages": 1
}
}
Returns a list of all eligible data stewards for the specified Immuta domain. Includes Immuta governors and admins.
GET /marketplace/api/metadata/domain/{id}/stewards HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"users": [
{
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
}
]
}
Search across all groups in Immuta
100
GET /marketplace/api/metadata/groups HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"groups": [
{
"id": 1,
"iamId": "text",
"name": "text",
"email": "name@gmail.com"
}
]
}
Search across all users in Immuta
100
GET /marketplace/api/metadata/users HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"users": [
{
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
}
]
}
Search request forms in the marketplace using the provided filters
0
10
asc
Possible values: name
Possible values: Filter results by request form name
""
Whether the filter should be an exact match
false
GET /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "2f1bd1bc-b561-4db0-a989-6062cbd6d82e",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreements": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text"
}
],
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z",
"version": "text",
"associatedDomains": [
"4d004a3a-4568-4c1d-822e-30958ef898dc"
]
}
],
"meta": {
"offset": 0,
"limit": 10,
"totalCount": 1,
"pageCount": 1,
"currentPage": 1,
"totalPages": 1
}
}
Get request form by ID
GET /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "d9a49b7d-0085-426b-bd23-41377f968bda",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreements": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text"
}
],
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z",
"version": "text"
}
Get the data products assigned to the request form
GET /marketplace/api/request-form/{id}/data-products HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
[
{
"id": "text",
"name": "text"
}
]
Get request form by its version
GET /marketplace/api/request-form/version/{version} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "d9a49b7d-0085-426b-bd23-41377f968bda",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreements": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text"
}
],
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z",
"version": "text"
}
Get the settings for the frontend marketplace application.
GET /marketplace/api/settings/frontend HTTP/1.1
Host: na.api.immutacloud.com
Accept: */*
{
"theme": {
"primaryColor": "text",
"accentColor": "text",
"lightModeImage": "text",
"darkModeImage": "text"
},
"featureFlags": {
"launchDarklyClientKey": "text",
"launchDarklyClientHash": "text",
"launchDarklyBaseUri": "text"
}
}
Modify a pending approval record as an approver
PENDING
Possible values: PUT /marketplace/api/approval-record/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 72
{
"status": "PENDING",
"reason": "text",
"duration": 1,
"durationUnit": "HOURS"
}
{
"id": "text",
"dataAccessRequestId": "text",
"approvers": [
{
"type": "USER",
"id": "text",
"displayName": "text"
}
],
"prerequisites": [
"text"
],
"actionBy": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"status": "PENDING",
"reason": "text",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z"
}
Add one or more data products to the marketplace
Data product name
^[a-zA-Z0-9)(\-_/\\\s]*$
Data product description
Data product description
All sales records from the current fiscal year
["4d004a3a-4568-4c1d-822e-30958ef898dc"]
PENDING
Possible values: The types of data sources contained in the data product.
["Databricks","Redshift","Snowflake"]
Data product ID
POST /marketplace/api/data-product HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 649
{
"name": "text",
"description": "All sales records from the current fiscal year",
"domains": [
"4d004a3a-4568-4c1d-822e-30958ef898dc"
],
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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 by ID
Data product name
^[a-zA-Z0-9)(\-_/\\\s]*$
Data product description
Data product description
All sales records from the current fiscal year
["4d004a3a-4568-4c1d-822e-30958ef898dc"]
PENDING
Possible values: The types of data sources contained in the data product.
["Databricks","Redshift","Snowflake"]
Data product ID
Whether access to the data product's data sources are suspended
false
PUT /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 667
{
"name": "text",
"description": "All sales records from the current fiscal year",
"domains": [
"4d004a3a-4568-4c1d-822e-30958ef898dc"
],
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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
}
{
"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-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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 sources associated with the data product. Any currently associated data sources not included in the payload will be removed.
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"
}
]
}
{
"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-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"requestFormId": "text",
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"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 a new data access request for the specified data product
Immuta global user ID of the user for whom access is being requested
The request form submission
POST /marketplace/api/data-product/{id}/request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"user": "123e4567-e89b-12d3-a456-426614174000",
"form": null
}
{
"id": "text",
"requestingUser": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"user": {
"id": 1,
"iamId": "text",
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"username": "text",
"name": "text",
"email": "text"
},
"formVersion": "text",
"form": null,
"status": "PENDING",
"expiration": "2025-06-20T23:56:33.929Z",
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedAt": "2025-06-20T23:56:33.929Z",
"dataProduct": {
"id": "text",
"name": "text",
"description": "All sales records from the current fiscal year"
}
}
Create a new data use agreement
The name of data use agreement
The contents of data use agreement
POST /marketplace/api/data-use-agreement HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text",
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z"
}
Update a data use agreement
The name of data use agreement
The contents of data use agreement
PUT /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"name": "text",
"body": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text",
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z"
}
Create a request form
POST /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "1b948ee6-6a22-4ae2-9684-1a7ec2d92199",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreementIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "d9a49b7d-0085-426b-bd23-41377f968bda",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreements": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text"
}
],
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z",
"version": "text"
}
Update a request form
PUT /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "8870adf7-63da-459f-922d-0c888b49a859",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreementIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"fields": [
{
"id": "d9a49b7d-0085-426b-bd23-41377f968bda",
"type": "DROPDOWN",
"label": "text",
"required": true,
"options": [
{
"value": "text"
}
]
}
],
"policy": {
"version": "text",
"rules": [
{
"conditions": {
"all": []
},
"event": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
}
],
"defaultEvent": {
"type": "approve",
"params": {
"comment": "text",
"duration": 1,
"durationUnit": "HOURS"
}
}
},
"dataUseAgreements": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"body": "text"
}
],
"createdBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"createdAt": "2025-06-20T23:56:33.929Z",
"updatedBy": {
"globalUserId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"updatedAt": "2025-06-20T23:56:33.929Z",
"version": "text"
}