Marketplace API Endpoints

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

PreviousMarketplace API NextImmuta V2 API

Last updated 2 days ago

Was this helpful?

Search access agreements

Search available access agreements across the system

get

/api/access-agreement

Authorizations

Query parameters

offsetnumber

limitnumber · min: 1 · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "body": "text",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "type": "SIGNATURE"
    }
  ]
}

Create access agreement

Create a new system wide data access agreement

post

/api/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 -L \
  --request POST \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/access-agreement' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","body":"text","type":"SIGNATURE"}'

201

{
  "id": "text",
  "name": "text",
  "body": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-21T18:03:10.960Z",
  "updatedAt": "2025-02-21T18:03:10.960Z",
  "type": "SIGNATURE"
}

Delete access agreement

Delete the specified access agreement

delete

/api/access-agreement/{id}

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

200

No body

Retrieves an individual access agreement

Retrieve data access agreement from the system

get

/api/access-agreement/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "id": "text",
  "name": "text",
  "body": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-21T18:03:10.960Z",
  "updatedAt": "2025-02-21T18:03:10.960Z",
  "type": "SIGNATURE"
}

Search access requests

Search and filter access requests the current user can manage

get

/api/access-request

Authorizations

Query parameters

rolestring · enum[] · default: requestor,manager

dataProductIdstring · cuid

The id of the data product to filter requests by

searchTextstring

statusstring · enum[]

offsetnumber

limitnumber · min: 1 · default: 10

sortOrderstring · enum · default: desc

Options: asc, desc

sortBystring · enumrequired

Options: status, dataProduct, createdAt

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "text",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "status": "PENDING",
      "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"
      },
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ]
}

Cancel a pending access request

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

delete

/api/access-request/{id}

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

Get individual access request

Returns specific details for a specific access request

get

/api/access-request/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "id": "text",
  "createdAt": "2025-02-21T18:03:10.960Z",
  "updatedAt": "2025-02-21T18:03:10.960Z",
  "status": "PENDING",
  "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"
  },
  "dataProduct": {
    "id": "text",
    "name": "Sales",
    "description": "All sales records from the current fiscal year"
  }
}

Get approval records associated with the a request

Returns all approval records associated with a specific access request

get

/api/access-request/{id}/records

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "approvalRecords": [
    {
      "id": "text",
      "approvalPolicyId": "text",
      "dataAccessRequestId": "text",
      "dataAccessAgreementId": "text",
      "reason": "text",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "status": "PENDING",
      "prerequisites": [
        "text"
      ],
      "actionBy": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "approvers": [
        {
          "id": "text",
          "displayName": "text",
          "type": "USER"
        }
      ]
    }
  ]
}

Create an approval policy

Creates a new approval policy based on the provided policy JSON

post

/api/approval-policy

Authorizations

Body

policyJSONobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Get individual approval policy

Returns details for a specific approval policy

get

/api/approval-policy/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Get individual approval record

Returns details for a specific approval record

get

/api/approval-record/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "id": "text",
  "approvalPolicyId": "text",
  "dataAccessRequestId": "text",
  "dataAccessAgreementId": "text",
  "reason": "text",
  "createdAt": "2025-02-21T18:03:10.960Z",
  "updatedAt": "2025-02-21T18:03:10.960Z",
  "status": "PENDING",
  "prerequisites": [
    "text"
  ],
  "actionBy": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "approvers": [
    {
      "id": "text",
      "displayName": "text",
      "type": "USER"
    }
  ]
}

Approve or reject an approval record

Modify a pending approval record as an approver

put

/api/approval-record/{id}

Authorizations

Path parameters

idstringrequired

Body

reasonstring

statusstring · enumrequired

Example: PENDING

Options: APPROVED, BLOCKED, CANCELED, DENIED, PENDING

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "id": "text",
  "approvalPolicyId": "text",
  "dataAccessRequestId": "text",
  "dataAccessAgreementId": "text",
  "reason": "text",
  "createdAt": "2025-02-21T18:03:10.960Z",
  "updatedAt": "2025-02-21T18:03:10.960Z",
  "status": "PENDING",
  "prerequisites": [
    "text"
  ],
  "actionBy": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "approvers": [
    {
      "id": "text",
      "displayName": "text",
      "type": "USER"
    }
  ]
}

Search data products across the marketplace

Search data products in the marketplace using the provided filters

get

/api/data-product

Authorizations

Query parameters

nextTokenstring

Pagination token to fetch the next page of results

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

The number of items to return per page

sortOrderstring · enum · default: asc

Options: asc, desc

sortBystring · enum

Options: name

nameFilterstring

statusFilterstring · enum[]

roleFilterstring · enum[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "limit": 10,
    "nextToken": "text"
  },
  "data": [
    {
      "id": "text",
      "name": "Sales",
      "suspended": false,
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "approvalPolicyId": "text",
      "requestId": "text",
      "status": "PENDING",
      "domains": [
        "4d004a3a-4568-4c1d-822e-30958ef898dc"
      ],
      "sourceTypes": [
        "Databricks",
        "Redshift",
        "Snowflake"
      ],
      "description": "All sales records from the current fiscal year",
      "stats": {
        "dataSourceCount": 1,
        "pendingRequestCount": 1,
        "approvedRequestCount": 1,
        "revokedRequestCount": 1,
        "canceledRequestCount": 1,
        "deniedRequestCount": 1,
        "totalRequestCount": 1
      },
      "dataUsageAgreements": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "metadata": {
        "subjectMatterExpert": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "username": "text"
        }
      }
    }
  ]
}

Add new data products to the marketplace

Add one or more data products to the marketplace

post

/api/data-product

Authorizations

Body

namestring · min: 1 · max: 64required

Data product name

Example: Sales

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

approvalPolicyIdstring · cuidrequired

statusstring · enum

Example: PENDING

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

domainsstring[]required

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

sourceTypesstring[]

The types of data sources contained in the data product.

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

descriptionone of | nullable

Data product description

statsData Product Stats

Data product statistics

dataUsageAgreementsobject[]

dataSourcesobject[]required

metadataone of | nullablerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Sales","approvalPolicyId":"text","status":"PENDING","domains":["4d004a3a-4568-4c1d-822e-30958ef898dc"],"sourceTypes":["Databricks","Redshift","Snowflake"],"description":"All sales records from the current fiscal year","stats":{"dataSourceCount":1,"pendingRequestCount":1,"approvedRequestCount":1,"revokedRequestCount":1,"canceledRequestCount":1,"deniedRequestCount":1,"totalRequestCount":1},"dataUsageAgreements":[{"id":"text","name":"text"}],"dataSources":[{"name":"Web Sales 2024","type":"text","sourceId":"text"}],"metadata":{"subjectMatterExpert":{"id":"123e4567-e89b-12d3-a456-426614174000","username":"text"}}}'

201

409

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

Delete data product by ID

Delete the specified data product from the system

delete

/api/data-product/{id}

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

200

No body

Get data product by ID

Get data product metadata for the specified data product ID

get

/api/data-product/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Update an existing data product

Update an existing data product by ID

put

/api/data-product/{id}

Authorizations

Path parameters

idstringrequired

Body

namestring · min: 1 · max: 64

Data product name

Example: Sales

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

approvalPolicyIdstring · cuid

suspendedboolean

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

Example: false

statusstring · enum

Example: PENDING

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

domainsstring[]

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

sourceTypesstring[]

The types of data sources contained in the data product.

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

descriptionone of | nullable

Data product description

statsData Product Stats

Data product statistics

dataUsageAgreementsobject[]

dataSourcesobject[]

metadataone of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Sales","suspended":false,"status":"PENDING","domains":["4d004a3a-4568-4c1d-822e-30958ef898dc"],"sourceTypes":["Databricks","Redshift","Snowflake"],"description":"All sales records from the current fiscal year","stats":{"dataSourceCount":1,"pendingRequestCount":1,"approvedRequestCount":1,"revokedRequestCount":1,"canceledRequestCount":1,"deniedRequestCount":1,"totalRequestCount":1},"dataUsageAgreements":[{"id":"text","name":"text"}],"dataSources":[{"name":"Web Sales 2024","type":"text","sourceId":"text"}],"metadata":{"subjectMatterExpert":{"id":"123e4567-e89b-12d3-a456-426614174000","username":"text"}}}'

200

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

Get data access agreements for a data product

get

/api/data-product/{id}/access-agreements

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "accessAgreements": [
    {
      "id": "text",
      "name": "text",
      "body": "text",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "type": "SIGNATURE"
    }
  ]
}

Search all data sources in the data product

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

get

/api/data-product/{id}/datasources

Authorizations

Path parameters

idstringrequired

Query parameters

nextTokenstring

Pagination token to fetch the next page of results

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

The number of items to return per page

userstring · uuid

The global user ID to search data source access status for

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "limit": 10,
    "nextToken": "text"
  },
  "data": [
    {
      "id": "text",
      "name": "Web Sales 2024",
      "type": "text",
      "status": "NONE",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text",
      "prefix": "text"
    }
  ]
}

Add data sources to data products

Add existing data sources to a specified data product

post

/api/data-product/{id}/datasources

Authorizations

Path parameters

idstringrequired

Body

itemsstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "data": [
    {
      "dataSourceId": "text",
      "dataProductId": "text"
    }
  ]
}

Update the data product's data sources

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

put

/api/data-product/{id}/datasources

Authorizations

Path parameters

idstringrequired

Body

dataSourcesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Get all data sources in the data product

get

/api/data-product/{id}/datasources/all

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "dataSources": [
    {
      "name": "Web Sales 2024",
      "type": "text",
      "sourceId": "text",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text",
      "prefix": "text"
    }
  ]
}

Remove a data source from a data product.

delete

/api/data-product/{id}/datasources/{dataSourceId}

Authorizations

Path parameters

idstringrequired

dataSourceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

Search all access requests for the data product

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

get

/api/data-product/{id}/request

Authorizations

Path parameters

idstringrequired

Query parameters

searchTextstring

statusstring · enum[]

offsetnumber

limitnumber · min: 1 · default: 10

sortOrderstring · enum · default: desc

Options: asc, desc

sortBystring · enumrequired

Options: status, dataProduct, createdAt

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "text",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "status": "PENDING",
      "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"
      },
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ]
}

Request access to a data product

Create a new data access request for the specified data product

post

/api/data-product/{id}/request

Authorizations

Path parameters

idstringrequired

Body

userstring · uuidrequired

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

formData Use Formrequired

The data use agreement form

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{global-segment}.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

{
  "id": "text",
  "createdAt": "2025-02-21T18:03:10.960Z",
  "updatedAt": "2025-02-21T18:03:10.960Z",
  "status": "PENDING",
  "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"
  },
  "dataProduct": {
    "id": "text",
    "name": "Sales",
    "description": "All sales records from the current fiscal year"
  }
}

Revoke access to a data product

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

delete

/api/data-product/{id}/request/{requestId}

Authorizations

Path parameters

idstringrequired

requestIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

Returns 5 most recent manual access determinations

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

get

/api/data-product/{id}/recent-determinations

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "determinations": [
    {
      "id": "text",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "updatedAt": "2025-02-21T18:03:10.960Z",
      "status": "PENDING",
      "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"
      },
      "approvalRecords": [
        {
          "reason": "text",
          "updatedAt": "2025-02-21T18:03:10.960Z",
          "status": "PENDING",
          "actionBy": {
            "id": 1,
            "iamId": "text",
            "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
            "username": "text",
            "name": "text"
          }
        }
      ]
    }
  ]
}

Get data product by name

Get data product metadata for the specified data product name

get

/api/data-product/{name}/byName

Authorizations

Path parameters

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Get available Immuta Domains

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

get

/api/metadata/domain

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Get the specified domain

Returns the Immuta domain specified in the request

get

/api/metadata/domain/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Search data sources in domain

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

get

/api/metadata/domain/{id}/datasources

Authorizations

Path parameters

idstringrequired

Query parameters

offsetnumber

limitnumber · min: 1 · default: 10

searchTextstring

Search text to filter data sources

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "dataSourceId": 1,
      "name": "November 2023 Online",
      "platform": "Databricks",
      "createdAt": "2025-02-21T18:03:10.960Z",
      "prefix": "text",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text"
    }
  ]
}

Get all data stewards for the given domain

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

get

/api/metadata/domain/{id}/stewards

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Search Immuta users

Search across all users in Immuta

get

/api/metadata/users

Authorizations

Query parameters

limitnumber · default: 100

filterstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Frontend Settings

Get the settings for the frontend marketplace application.

get

/api/settings/frontend

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/settings/frontend'

200

{
  "theme": {
    "primaryColor": "text",
    "accentColor": "text",
    "lightModeImage": "text",
    "darkModeImage": "text"
  }
}