Metadata

APIs used to retrieve metadata from Immuta to enrich the marketplace

Get available Immuta Domains

get

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

get/api/metadata/domain

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/domain HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "domains": [
    {
      "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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Query parameters

offsetnumberOptionalDefault: 0

limitnumber · min: 1OptionalDefault: 10

searchTextstringOptional

Search text to filter data sources

dataSourceIdsnumber[]Optional

Array of ids to filter data sources

Responses

200Success

application/json

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

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/domain/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "data": [
    {
      "dataSourceId": 1,
      "name": "November 2023 Online",
      "platform": "Databricks",
      "createdAt": "2026-07-10T13:12:28.803Z",
      "prefix": "text",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Get the specified domain

get

Returns the Immuta domain specified in the request

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

idstringRequired

namestringRequired

Domain name

Example: North American Sales

descriptionstringRequired

Domain description

Example: A collection of data sources relevant to North American sales

get/api/metadata/domain/{id}

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/domain/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

Search Immuta users

get

Search across all users in Immuta

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptionalDefault: 100

filterstringOptional

globalUserIdstring[]Optional

Responses

200Success

application/json

get/api/metadata/users

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/users HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

Search Immuta groups

get

Search across all groups in Immuta

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptionalDefault: 100

filterstringOptional

Responses

200Success

application/json

get/api/metadata/groups

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/groups HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "groups": [
    {
      "id": 1,
      "iamId": "text",
      "name": "text",
      "email": "[e-mail]"
    }
  ]
}

Search Immuta attributes

get

Search across all attributes in Immuta

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchstringOptional

typestringOptional

Responses

200Success

application/json

get/api/metadata/attributes

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/attributes HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "attributes": [
    {
      "type": "text",
      "value": "text"
    }
  ]
}

Search Immuta tags

get

Search across all tags in Immuta

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchTextstringOptional

A string used to filter returned tags based on name.

fuzzySearchbooleanOptional

Whether to perform a fuzzy search.

limitnumber · max: 200Optional

The maximum number of search results that will be returned.

Responses

200Success

application/json

addedBynumberOptional

colorstringOptional

contextstringOptional

createdAtstringOptional

createdBynumberOptional

dataProductNamestringOptional

deletedbooleanOptional

descriptionstringOptional

displayNamestringOptional

hasLeafNodesbooleanOptional

idnumberOptional

namestringRequired

protectedbooleanOptional

sourcestringOptional

systemCreatedbooleanOptional

updatedAtstringOptional

get/api/metadata/tags

HTTPcURLJavaScriptPython

GET /marketplace/api/metadata/tags HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "addedBy": 1,
    "color": "text",
    "context": "text",
    "createdAt": "text",
    "createdBy": 1,
    "dataProductName": "text",
    "deleted": true,
    "description": "text",
    "displayName": "text",
    "hasLeafNodes": true,
    "id": 1,
    "name": "text",
    "protected": true,
    "source": "text",
    "systemCreated": true,
    "updatedAt": "text"
  }
]