---
title: "Get asset by metadata"
method: GET
path: "/api/asset/byMetadata"
tags: ["Asset"]
---

# Get asset by metadata

`GET /api/asset/byMetadata`

## Request

- Base URL: `https://na.api.immutacloud.com/marketplace`
- URL: `https://na.api.immutacloud.com/marketplace/api/asset/byMetadata`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/immuta/apis/immuta-data-marketplace/docs/api/asset/byMetadata/get.ts> (a function with typed inputs; its response is checked against the schema)

Search for assets by their metadata.

## Query parameters

- `fullyQualifiedName` string, required
- `assetType` string
- `host` string
- `port` integer
- `technology` string

## Response `200`

- union
  - object
    - `id` union, required
      - string, cuid
      - string, uuid
    - `name` string, required: Asset name
    - `type` 'DATA_PRODUCT', required
    - `createdAt` union, required
      - string, date-time
      - string, date-time
    - `updatedAt` union, required
      - string, date-time
      - string, date-time
    - `dagTagId` number, nullable
    - `requestId` string, cuid: If requested, the ID of the access request for the data product
    - `status` 'APPROVED' | 'CANCELED' | 'DENIED' | 'PENDING' | 'NONE' | 'PUBLISHER' | 'REVOKED' | 'EXPIRED'
    - `description` string, nullable: Data product description
    - `domains` string[], required: Array of domain IDs associated with the data product
    - `subjectMatterExperts` object[]
      - `id` string, uuid, required: Immuta global user ID of the subject matter expert
      - `username` string
      - `name` string
    - `suspended` boolean: Whether access to the data product's data sources is suspended
    - `createdBy` string, uuid, required: Immuta global user ID of the user who created the data product
    - `expiration` string, date-time, nullable
    - `stats` object: Data product statistics
      - `dataSourceCount` integer, required: Count of data sources in a data product
      - `pendingRequestCount` integer, required: Count of pending requests for a data product
      - `approvedRequestCount` integer, required: Count of approved requests for a data product
      - `revokedRequestCount` integer, required: Count of revoked requests for a data product
      - `canceledRequestCount` integer, required: Count of canceled requests for a data product
      - `deniedRequestCount` integer, required: Count of denied requests for a data product
      - `expiredRequestCount` integer, required: Count of expired requests for a data product
      - `totalRequestCount` integer, required: Count of total requests for a data product
    - `dataAccessPolicy` object, required: Data product data access policy
      - `version` string: Policy schema version
      - `rules` object[], required
        - `conditions` union, required
          - object
            - `all` unknown[], required
              - …
          - object
            - `any` unknown[], required
              - …
          - object
            - `not` unknown, required
        - `event` union, required
          - object
            - `type` 'approve', required
            - `params` object, required
              - …
          - object
            - `type` 'deny', required
            - `params` object, required
              - …
          - object
            - `type` 'review', required
            - `params` object, required
              - …
          - object
            - `type` 'dataProductPolicy', required
      - `defaultEvent` union, required
        - object
          - `type` 'approve', required
          - `params` object, required
            - `comment` string
            - `duration` number
            - `durationUnit` 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS'
        - object
          - `type` 'review', required
          - `params` object, required
            - `stages` union[], required: Array of stages for manual review
              - …
    - `maskingExceptionPolicy` object, required: Masking exception policy for the data product
      - `version` string: Policy schema version
      - `rules` object[], required
        - `conditions` union, required
          - object
            - `all` unknown[], required
              - …
          - object
            - `any` unknown[], required
              - …
          - object
            - `not` unknown, required
        - `event` union, required
          - object
            - `type` 'approve', required
            - `params` object, required
              - …
          - object
            - `type` 'deny', required
            - `params` object, required
              - …
          - object
            - `type` 'review', required
            - `params` object, required
              - …
          - object
            - `type` 'dataProductPolicy', required
      - `defaultEvent` union, required
        - object
          - `type` 'approve', required
          - `params` object, required
            - `comment` string
            - `duration` number
            - `durationUnit` 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS'
        - object
          - `type` 'review', required
          - `params` object, required
            - `stages` union[], required: Array of stages for manual review
              - …
  - object
    - `id` union, required
      - string, cuid
      - string, uuid
    - `name` string, required: Asset name
    - `type` 'DATA_OBJECT', required
    - `createdAt` union
      - string, date-time
      - string, date-time
    - `updatedAt` union
      - string, date-time
      - string, date-time
    - `dagTagId` number, nullable
    - `requestId` string, cuid: If requested, the ID of the access request for the asset
    - `status` 'APPROVED' | 'CANCELED' | 'DENIED' | 'PENDING' | 'NONE' | 'PUBLISHER' | 'REVOKED' | 'EXPIRED'
    - `metadata` object, required: Data object asset metadata
      - `subjectMatterExperts` object[]
        - `id` string, uuid, required: Immuta global user ID of the subject matter expert
        - `username` string
        - `name` string
      - `objectPath` string[], required
      - `technology` 'Snowflake' | 'PostgreSQL' | 'Databricks' | 'Glue' | 'MySQL' | 'Teradata' | 'MariaDB' | 'Oracle' | 'SQLServer' | 'Trino' | 'Redshift' | 'BigQuery'
      - `host` string
      - `port` integer
      - `legacyType` string
      - `dataSourceId` number
      - `description` string, nullable
      - `externalLink` string, nullable
    - `registered` boolean: Whether the asset has been registered
    - `stats` object: Data object asset statistics
      - `dataSourceCount` integer, required: Count of data sources in the data object

---

[API](https://skmtc.dev/immuta/apis/immuta-data-marketplace.md) - [All operations](https://skmtc.dev/immuta/apis/immuta-data-marketplace/llms.txt) - [OpenAPI document](https://skmtc.dev/immuta/apis/immuta-data-marketplace/revisions/622b396ca2d7?raw)
