Marketplace API Endpoints

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

Search access agreements

get

Search available access agreements across the system

Authorizations

Query parameters

offsetnumber · default: 0optional

limitnumber · min: 1 · default: 10optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-agreement' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "body": "text",
      "type": "SIGNATURE",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z"
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Create access agreement

post

Create a new system wide data access agreement

Authorizations

Body

namestringrequired

The name of data use/acknowledgement agreement

bodystringrequired

The text of data use/acknowledgement agreement

typestring · enumrequired

How users are required to acknowledge acceptance of the agreement/terms

Options: SIGNATURE, CHECKBOX, QUESTION

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-agreement' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "body": "text",
    "type": "SIGNATURE"
  }'

201

201

{
  "id": "text",
  "name": "text",
  "body": "text",
  "type": "SIGNATURE",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z"
}

Delete access agreement

delete

Delete the specified access agreement

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-agreement/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

No body

Retrieves an individual access agreement

get

Retrieve data access agreement from the system

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-agreement/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "id": "text",
  "name": "text",
  "body": "text",
  "type": "SIGNATURE",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z"
}

Search access requests

get

Search and filter access requests the current user can manage

Authorizations

Query parameters

rolestring · enum[] · min: 1 · default: ["requestor","manager"]optional

dataProductIdstring · cuidoptional

The ID of the data product to filter requests by

searchTextstringoptional

statusstring · enum[]optional

Example: PENDING

offsetnumber · default: 0optional

limitnumber · min: 1 · default: 10optional

sortOrderstring · enum · default: "desc"optional

Options: asc, desc

sortBystring · enumrequired

Options: status, dataProduct, createdAt

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-request?sortBy=status' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "data": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "status": "PENDING",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z",
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Cancel a pending access request

delete

Cancel the specified pending access request by ID, cascading the cancellation to any pending and blocked approval records.

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-request/{id}' \
  --header 'Authorization: Bearer JWT'

204

204

No body

Get individual access request

get

Returns specific details for a specific access request

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-request/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "id": "text",
  "requestingUser": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "user": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "status": "PENDING",
  "createdAt": "2025-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "dataProduct": {
    "id": "text",
    "name": "Sales",
    "description": "All sales records from the current fiscal year"
  }
}

Get approval records associated with the a request

get

Returns all approval records associated with a specific access request

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-request/{id}/records' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "approvalRecords": [
    {
      "id": "text",
      "approvalPolicyId": "text",
      "dataAccessRequestId": "text",
      "dataAccessAgreementId": "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"
      },
      "status": "PENDING",
      "reason": "text",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z"
    }
  ]
}

Create an approval policy

post

Creates a new approval policy based on the provided policy JSON

Authorizations

Body

policyJSONobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://na.api.immutacloud.com/marketplace/api/approval-policy' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "policyJSON": {
      "policyVersion": "text",
      "dataAccessAgreements": [
        "text"
      ],
      "reason": "text",
      "stages": [
        {
          "name": "text",
          "required": [
            {
              "type": "USER",
              "id": "text",
              "displayName": "text"
            }
          ]
        }
      ]
    }
  }'

200

200

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

Get individual approval policy

get

Returns details for a specific approval policy

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/approval-policy/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

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

Get individual approval record

get

Returns details for a specific approval record

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/approval-record/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "id": "text",
  "approvalPolicyId": "text",
  "dataAccessRequestId": "text",
  "dataAccessAgreementId": "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"
  },
  "status": "PENDING",
  "reason": "text",
  "createdAt": "2025-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z"
}

Approve or reject an approval record

put

Modify a pending approval record as an approver

Authorizations

Path parameters

idstringrequired

Body

statusstring · enumrequired

Example: PENDING

Options: APPROVED, BLOCKED, CANCELED, DENIED, PENDING

reasonstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://na.api.immutacloud.com/marketplace/api/approval-record/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "PENDING",
    "reason": "text"
  }'

200

200

{
  "id": "text",
  "approvalPolicyId": "text",
  "dataAccessRequestId": "text",
  "dataAccessAgreementId": "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"
  },
  "status": "PENDING",
  "reason": "text",
  "createdAt": "2025-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z"
}

Search data products across the marketplace

get

Search data products in the marketplace using the provided filters

Authorizations

Query parameters

nextTokenstringoptional

Pagination token to fetch the next page of results

limitnumber · min: 1 · max: 100 · default: 10optional

The number of items to return per page

sortOrderstring · enum · default: "asc"optional

Options: asc, desc

sortBystring · enumoptional

Options: name

nameFilterstringoptional

statusFilterstring · enum[]optional

roleFilterstring · enum[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "data": [
    {
      "id": "text",
      "name": "Sales",
      "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-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z",
      "approvalPolicyId": "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"
        }
      ]
    }
  ],
  "meta": {
    "nextToken": "text",
    "limit": 1
  }
}

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

Example: Sales

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

descriptionone of | nullableoptional

Data product description

Data product description

domainsstring[]required

Example: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]

approvalPolicyIdone ofrequired

statusstring · enumoptional

Example: PENDING

Options: APPROVED, CANCELED, DENIED, PENDING, NONE, PUBLISHER, REVOKED

statsobjectoptional

Data product statistics

sourceTypesstring[]optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]

dataUsageAgreementsobject[]optional

idstring · uuidoptional

Data product ID

dataSourcesobject[]required

metadataone of | nullablerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sales",
    "description": "All sales records from the current fiscal year",
    "domains": [
      "4d004a3a-4568-4c1d-822e-30958ef898dc"
    ],
    "approvalPolicyId": "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"
      }
    }
  }'

201

409

201

{
  "id": "text",
  "name": "Sales",
  "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-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "approvalPolicyId": "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"
    }
  ]
}

Delete data product by ID

delete

Delete the specified data product from the system

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

No body

Get data product by ID

get

Get data product metadata for the specified data product ID

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "id": "text",
  "name": "Sales",
  "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-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "approvalPolicyId": "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

Example: Sales

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

descriptionone of | nullableoptional

Data product description

Data product description

domainsstring[]optional

Example: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]

approvalPolicyIdone ofoptional

statusstring · enumoptional

Example: PENDING

Options: APPROVED, CANCELED, DENIED, PENDING, NONE, PUBLISHER, REVOKED

statsobjectoptional

Data product statistics

sourceTypesstring[]optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]

dataUsageAgreementsobject[]optional

idstring · uuidoptional

Data product ID

dataSourcesobject[]optional

metadataone of | nullableoptional

suspendedbooleanoptional

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

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sales",
    "description": "All sales records from the current fiscal year",
    "domains": [
      "4d004a3a-4568-4c1d-822e-30958ef898dc"
    ],
    "approvalPolicyId": "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
  }'

200

200

{
  "id": "text",
  "name": "Sales",
  "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-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "approvalPolicyId": "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"
    }
  ]
}

Get data access agreements for a data product

get

Get data access agreements for a data product

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/access-agreements' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "accessAgreements": [
    {
      "id": "text",
      "name": "text",
      "body": "text",
      "type": "SIGNATURE",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z"
    }
  ]
}

Search all data sources in the data product

get

Search all data sources for the data product using the provided filters

Authorizations

Path parameters

idstringrequired

Query parameters

nextTokenstringoptional

Pagination token to fetch the next page of results

limitnumber · min: 1 · max: 100 · default: 10optional

The number of items to return per page

userstring · uuidoptional

The global user ID to search data source access status for

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/datasources' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "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": 1
  }
}

Add data sources to data products

post

Add existing data sources to a specified data product

Authorizations

Path parameters

idstringrequired

Body

string[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/datasources' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '[
    "text"
  ]'

201

201

{
  "data": [
    {
      "dataSourceId": "text",
      "dataProductId": "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

dataSourcesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/datasources' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataSources": [
      {
        "sourceId": "text"
      }
    ]
  }'

200

200

{
  "id": "text",
  "name": "Sales",
  "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-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "approvalPolicyId": "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"
    }
  ]
}

Get all data sources in the data product

get

Get all data sources in the data product

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/datasources/all' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "dataSources": [
    {
      "sourceId": "text"
    }
  ]
}

Remove a data source from a data product.

delete

Remove a data source from a data product.

Authorizations

Path parameters

idstringrequired

dataSourceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/datasources/{dataSourceId}' \
  --header 'Authorization: Bearer JWT'

204

204

No body

Search all access requests for the data product

get

Search all access requests for the data product using the provided filters

Authorizations

Path parameters

idstringrequired

Query parameters

searchTextstringoptional

statusstring · enum[]optional

Example: PENDING

offsetnumber · default: 0optional

limitnumber · min: 1 · default: 10optional

sortOrderstring · enum · default: "desc"optional

Options: asc, desc

sortBystring · enumrequired

Options: status, dataProduct, createdAt

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/request?sortBy=status' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "data": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "status": "PENDING",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z",
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Request access to a data product

post

Create a new data access request for the specified data product

Authorizations

Path parameters

idstringrequired

Body

userstring · uuidrequired

Immuta global user ID of the user for whom access is being requested

formone of[]required

The data use agreement form

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/request' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "form": [
      {
        "id": "text",
        "response": "text"
      }
    ]
  }'

201

201

{
  "id": "text",
  "requestingUser": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "user": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "status": "PENDING",
  "createdAt": "2025-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "dataProduct": {
    "id": "text",
    "name": "Sales",
    "description": "All sales records from the current fiscal year"
  }
}

Revoke access to a data product

delete

Updates the specified access request to revoked and revokes access to data sources associated with the data product

Authorizations

Path parameters

idstringrequired

requestIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/request/{requestId}' \
  --header 'Authorization: Bearer JWT'

204

204

No body

Returns 5 most recent manual access determinations

get

Returns 5 most recent data access requests with a terminal status as well as the approval records which contributed to that status.

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/recent-determinations' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "determinations": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "actionBy": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "reason": "text",
      "status": "PENDING",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "updatedAt": "2025-03-25T19:56:03.238Z"
    }
  ]
}

Get data product by name

get

Get data product metadata for the specified data product name

Authorizations

Path parameters

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{name}/byName' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "id": "text",
  "name": "Sales",
  "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-03-25T19:56:03.238Z",
  "updatedAt": "2025-03-25T19:56:03.238Z",
  "approvalPolicyId": "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"
    }
  ]
}

Get available Immuta Domains

get

Search Immuta domains that can be used to create a data product in the marketplace

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/metadata/domain' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "domains": [
    {
      "id": "text",
      "name": "North American Sales",
      "description": "A collection of data sources relevant to North American sales"
    }
  ]
}

Get the specified domain

get

Returns the Immuta domain specified in the request

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/metadata/domain/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "id": "text",
  "name": "North American Sales",
  "description": "A collection of data sources relevant to North American sales"
}

Search data sources in domain

get

Search data sources within the selected domain that can be included in a data product

Authorizations

Path parameters

idstringrequired

Query parameters

offsetnumber · default: 0optional

limitnumber · min: 1 · default: 10optional

searchTextstringoptional

Search text to filter data sources

dataSourceIdsnumber[]optional

Array of IDs to filter data sources

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/metadata/domain/{id}/datasources' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "data": [
    {
      "dataSourceId": 1,
      "name": "November 2023 Online",
      "platform": "Databricks",
      "createdAt": "2025-03-25T19:56:03.238Z",
      "prefix": "text",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text"
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Get all data stewards for the given domain

get

Returns a list of all eligible data stewards for the specified Immuta Domain. Includes Immuta governors and admins.

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/metadata/domain/{id}/stewards' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "users": [
    {
      "id": 1,
      "iamId": "text",
      "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text",
      "name": "text"
    }
  ]
}

Search Immuta users

get

Search across all users in Immuta

Authorizations

Query parameters

limitnumber · default: 100optional

filterstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/metadata/users' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "users": [
    {
      "id": 1,
      "iamId": "text",
      "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text",
      "name": "text"
    }
  ]
}

Frontend Settings

get

Get the settings for the frontend marketplace application.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/settings/frontend'

200

200

{
  "theme": {
    "primaryColor": "text",
    "accentColor": "text",
    "lightModeImage": "text",
    "darkModeImage": "text"
  },
  "featureFlags": {
    "bucketClientKey": "text",
    "launchDarklyClientKey": "text",
    "launchDarklyClientHash": "text"
  }
}