Skip to main content

Provider

View as Markdown

A Marketplace listing: a data product that a provider offers to consumers. The summary holds the listing's identity, status and sharing configuration, and the detail holds the descriptive content that consumers see on the listing page.

Listing object​

A Marketplace listing: a data product that a provider offers to consumers. The summary holds the listing's identity, status and sharing configuration, and the detail holds the descriptive content that consumers see on the listing page.

idstring

ID of the listing. Assigned by the server; not allowed in create requests.

summaryobject

Identity, status and sharing configuration of the listing.

Show child attributesHide child attributes
namestring

Display name of the listing. Must start with a letter or digit and be at most 100 characters.

subtitlestring

One-line subtitle shown with the listing name.

statusstring

Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a listing as DRAFT and set the status to PUBLISHED when it is ready.

Values:

  • DRAFT
  • PENDING
  • PUBLISHED
  • SUSPENDED
shareobject

Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD listing, except for app and MCP server listings; notebook and Git repo listings can use git_repo instead. The caller must have access to the share.

Show child attributesHide child attributes
namestring

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestring

Values:

  • SAMPLE
  • FULL
provider_regionobject

Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

settingobject

Listing settings, such as whether the listing is visible in the public Marketplace or only in private exchanges.

Show child attributesHide child attributes
visibilitystring

PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible only to members of the private exchanges that they are shared in.

Values:

  • PUBLIC
  • PRIVATE
created_atint64

Time the listing was created, in epoch milliseconds.

created_bystring

Name of the user who created the listing.

updated_atint64

Time the listing was last updated, in epoch milliseconds.

updated_bystring

Name of the user who last updated the listing.

published_atint64
published_bystring
categoriesarray of string

Categories that consumers can use to filter listings. They also appear as tags on the listing tile and detail page.

Values:

Show 22 possible values
  • ADVERTISING_AND_MARKETING
  • CLIMATE_AND_ENVIRONMENT
  • COMMERCE
  • DEMOGRAPHICS
  • ECONOMICS
  • EDUCATION
  • ENERGY
  • FINANCIAL
  • GAMING
  • GEOSPATIAL
  • HEALTH
  • LOOKUP_TABLES
  • MANUFACTURING
  • MEDIA
  • OTHER
  • PUBLIC_SECTOR
  • RETAIL
  • SECURITY
  • SCIENCE_AND_RESEARCH
  • SPORTS
  • TRANSPORTATION_AND_LOGISTICS
  • TRAVEL_AND_TOURISM
listingTypestring

How consumers get access to the listing. STANDARD listings are instantly available; PERSONALIZED listings require the provider to approve each consumer request. Cannot be changed after the listing is created.

Values:

  • STANDARD
  • PERSONALIZED
created_by_idint64

ID of the user who created the listing.

updated_by_idint64

ID of the user who last updated the listing.

provider_idstring

ID of the provider profile that owns the listing.

exchange_idsarray of string

IDs of the private exchanges that the listing is shared in. A listing can be linked to at most 10 exchanges.

git_repoobject

Git repository that holds the listing's assets, used instead of a share for notebook and Git repo listings. A listing cannot have both a share and a Git repo.

Show child attributesHide child attributes
git_repo_urlstring

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Descriptive content shown to consumers on the listing page, such as the description, links and data attributes.

Show child attributesHide child attributes
descriptionstring

Detailed description of the data product. Supports basic Markdown formatting such as bold, italics and lists.

terms_of_servicestring

URL of the terms of service for the listing. Defaults to the provider profile's terms of service link when empty.

file_idsarray of string
embedded_notebook_file_infosarray of object

Sample notebooks attached to the listing. Create each notebook with createFile, using the EMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values:

  • FREE
  • PAID
pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes
intervalint64

Number of time units. Must be greater than zero.

unitstring

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes
intervalint64

Number of time units. Must be greater than zero.

unitstring

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Types of assets included in the listing. At least one is required unless the listing is a DRAFT. Duplicate values are ignored.

Values:

  • ASSET_TYPE_GIT_REPO
  • ASSET_TYPE_DATA_TABLE
  • ASSET_TYPE_MODEL
  • ASSET_TYPE_NOTEBOOK
  • ASSET_TYPE_MEDIA
  • ASSET_TYPE_PARTNER_INTEGRATION
  • ASSET_TYPE_APP
  • ASSET_TYPE_MCP
licensestring

License of the data asset. Required for listings with model-based assets.

tagsarray of object

Tags that annotate the listing with fixed, low-cardinality values, such as supported languages or tasks.

Show child attributesHide child attributes
tag_namestring

Tag name (enum)

Values:

  • LISTING_TAG_TYPE_LANGUAGE
  • LISTING_TAG_TYPE_TASK
tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

Get a listing GA​

GET /api/2.0/marketplace-provider/listings/{id}

1 more path

GET /api/2.1/marketplace-provider/listings/{id}

Gets a listing owned by one of the caller's provider profiles.

API scopes: marketplace

Parameters​

idstringRequiredpath

ID of the listing.

Response​

listingobject

The requested listing.

Show child attributesHide child attributes
idstring

ID of the listing. Assigned by the server; not allowed in create requests.

summaryobjectRequired

Identity, status and sharing configuration of the listing.

Show child attributesHide child attributes
namestringRequired

Display name of the listing. Must start with a letter or digit and be at most 100 characters.

subtitlestring

One-line subtitle shown with the listing name.

statusstring

Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a listing as DRAFT and set the status to PUBLISHED when it is ready.

Values:

  • DRAFT
  • PENDING
  • PUBLISHED
  • SUSPENDED
shareobject

Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD listing, except for app and MCP server listings; notebook and Git repo listings can use git_repo instead. The caller must have access to the share.

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL
provider_regionobject

Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

settingobject

Listing settings, such as whether the listing is visible in the public Marketplace or only in private exchanges.

Show child attributesHide child attributes
visibilitystring

PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible only to members of the private exchanges that they are shared in.

Values:

  • PUBLIC
  • PRIVATE
created_atint64

Time the listing was created, in epoch milliseconds.

created_bystring

Name of the user who created the listing.

updated_atint64

Time the listing was last updated, in epoch milliseconds.

updated_bystring

Name of the user who last updated the listing.

published_atint64
published_bystring
categoriesarray of string

Categories that consumers can use to filter listings. They also appear as tags on the listing tile and detail page.

Values:

Show 22 possible values
  • ADVERTISING_AND_MARKETING
  • CLIMATE_AND_ENVIRONMENT
  • COMMERCE
  • DEMOGRAPHICS
  • ECONOMICS
  • EDUCATION
  • ENERGY
  • FINANCIAL
  • GAMING
  • GEOSPATIAL
  • HEALTH
  • LOOKUP_TABLES
  • MANUFACTURING
  • MEDIA
  • OTHER
  • PUBLIC_SECTOR
  • RETAIL
  • SECURITY
  • SCIENCE_AND_RESEARCH
  • SPORTS
  • TRANSPORTATION_AND_LOGISTICS
  • TRAVEL_AND_TOURISM
listingTypestringRequired

How consumers get access to the listing. STANDARD listings are instantly available; PERSONALIZED listings require the provider to approve each consumer request. Cannot be changed after the listing is created.

Values:

  • STANDARD
  • PERSONALIZED
created_by_idint64

ID of the user who created the listing.

updated_by_idint64

ID of the user who last updated the listing.

provider_idstring

ID of the provider profile that owns the listing.

exchange_idsarray of string

IDs of the private exchanges that the listing is shared in. A listing can be linked to at most 10 exchanges.

git_repoobject

Git repository that holds the listing's assets, used instead of a share for notebook and Git repo listings. A listing cannot have both a share and a Git repo.

Show child attributesHide child attributes
git_repo_urlstringRequired

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Descriptive content shown to consumers on the listing page, such as the description, links and data attributes.

Show child attributesHide child attributes
descriptionstring

Detailed description of the data product. Supports basic Markdown formatting such as bold, italics and lists.

terms_of_servicestring

URL of the terms of service for the listing. Defaults to the provider profile's terms of service link when empty.

file_idsarray of string
embedded_notebook_file_infosarray of object

Sample notebooks attached to the listing. Create each notebook with createFile, using the EMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values:

  • FREE
  • PAID
pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Types of assets included in the listing. At least one is required unless the listing is a DRAFT. Duplicate values are ignored.

Values:

  • ASSET_TYPE_GIT_REPO
  • ASSET_TYPE_DATA_TABLE
  • ASSET_TYPE_MODEL
  • ASSET_TYPE_NOTEBOOK
  • ASSET_TYPE_MEDIA
  • ASSET_TYPE_PARTNER_INTEGRATION
  • ASSET_TYPE_APP
  • ASSET_TYPE_MCP
licensestring

License of the data asset. Required for listings with model-based assets.

tagsarray of object

Tags that annotate the listing with fixed, low-cardinality values, such as supported languages or tasks.

Show child attributesHide child attributes
tag_namestring

Tag name (enum)

Values:

  • LISTING_TAG_TYPE_LANGUAGE
  • LISTING_TAG_TYPE_TASK
tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

List listings GA​

GET /api/2.0/marketplace-provider/listings

1 more path

GET /api/2.1/marketplace-provider/listings

Lists the listings owned by the provider profiles in the caller's account.

API scopes: marketplace

Parameters​

page_tokenstringquery

Token from the next_page_token field of a previous response. Omit to get the first page.

page_sizeint32query

Maximum number of results to return per page.

Response​

Returns a list of Listing objects.

Create a listing GA​

POST /api/2.0/marketplace-provider/listing

1 more path

POST /api/2.1/marketplace-provider/listing

Creates a listing under one of the caller's provider profiles. The listing name, provider ID and visibility are required, and the caller must have access to any share that the listing references. Returns the ID of the new listing.

API scopes: marketplace

Request body​

listingobjectRequired

Listing to create.

Show child attributesHide child attributes
idstring

ID of the listing. Assigned by the server; not allowed in create requests.

summaryobjectRequired

Identity, status and sharing configuration of the listing.

Show child attributesHide child attributes
namestringRequired

Display name of the listing. Must start with a letter or digit and be at most 100 characters.

subtitlestring

One-line subtitle shown with the listing name.

statusstring

Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a listing as DRAFT and set the status to PUBLISHED when it is ready.

Values:

  • DRAFT
  • PENDING
  • PUBLISHED
  • SUSPENDED
shareobject

Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD listing, except for app and MCP server listings; notebook and Git repo listings can use git_repo instead. The caller must have access to the share.

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL
provider_regionobject

Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

settingobject

Listing settings, such as whether the listing is visible in the public Marketplace or only in private exchanges.

Show child attributesHide child attributes
visibilitystring

PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible only to members of the private exchanges that they are shared in.

Values:

  • PUBLIC
  • PRIVATE
created_atint64

Time the listing was created, in epoch milliseconds.

created_bystring

Name of the user who created the listing.

updated_atint64

Time the listing was last updated, in epoch milliseconds.

updated_bystring

Name of the user who last updated the listing.

published_atint64
published_bystring
categoriesarray of string

Categories that consumers can use to filter listings. They also appear as tags on the listing tile and detail page.

Values:

Show 22 possible values
  • ADVERTISING_AND_MARKETING
  • CLIMATE_AND_ENVIRONMENT
  • COMMERCE
  • DEMOGRAPHICS
  • ECONOMICS
  • EDUCATION
  • ENERGY
  • FINANCIAL
  • GAMING
  • GEOSPATIAL
  • HEALTH
  • LOOKUP_TABLES
  • MANUFACTURING
  • MEDIA
  • OTHER
  • PUBLIC_SECTOR
  • RETAIL
  • SECURITY
  • SCIENCE_AND_RESEARCH
  • SPORTS
  • TRANSPORTATION_AND_LOGISTICS
  • TRAVEL_AND_TOURISM
listingTypestringRequired

How consumers get access to the listing. STANDARD listings are instantly available; PERSONALIZED listings require the provider to approve each consumer request. Cannot be changed after the listing is created.

Values:

  • STANDARD
  • PERSONALIZED
created_by_idint64

ID of the user who created the listing.

updated_by_idint64

ID of the user who last updated the listing.

provider_idstring

ID of the provider profile that owns the listing.

exchange_idsarray of string

IDs of the private exchanges that the listing is shared in. A listing can be linked to at most 10 exchanges.

git_repoobject

Git repository that holds the listing's assets, used instead of a share for notebook and Git repo listings. A listing cannot have both a share and a Git repo.

Show child attributesHide child attributes
git_repo_urlstringRequired

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Descriptive content shown to consumers on the listing page, such as the description, links and data attributes.

Show child attributesHide child attributes
descriptionstring

Detailed description of the data product. Supports basic Markdown formatting such as bold, italics and lists.

terms_of_servicestring

URL of the terms of service for the listing. Defaults to the provider profile's terms of service link when empty.

file_idsarray of string
embedded_notebook_file_infosarray of object

Sample notebooks attached to the listing. Create each notebook with createFile, using the EMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values:

  • FREE
  • PAID
pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Types of assets included in the listing. At least one is required unless the listing is a DRAFT. Duplicate values are ignored.

Values:

  • ASSET_TYPE_GIT_REPO
  • ASSET_TYPE_DATA_TABLE
  • ASSET_TYPE_MODEL
  • ASSET_TYPE_NOTEBOOK
  • ASSET_TYPE_MEDIA
  • ASSET_TYPE_PARTNER_INTEGRATION
  • ASSET_TYPE_APP
  • ASSET_TYPE_MCP
licensestring

License of the data asset. Required for listings with model-based assets.

tagsarray of object

Tags that annotate the listing with fixed, low-cardinality values, such as supported languages or tasks.

Show child attributesHide child attributes
tag_namestring

Tag name (enum)

Values:

  • LISTING_TAG_TYPE_LANGUAGE
  • LISTING_TAG_TYPE_TASK
tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

Response​

listing_idstring

ID of the created listing.

Update listing GA​

PUT /api/2.0/marketplace-provider/listings/{id}

1 more path

PUT /api/2.1/marketplace-provider/listings/{id}

Updates a listing. Send the full listing definition; the listing type cannot be changed after the listing is created, and changing the share re-links the listing to the new share.

API scopes: marketplace

Parameters​

idstringRequiredpath

ID of the listing to update.

Request body​

listingobjectRequired

Full definition of the listing, including the fields that are not changing.

Show child attributesHide child attributes
idstring

ID of the listing. Assigned by the server; not allowed in create requests.

summaryobjectRequired

Identity, status and sharing configuration of the listing.

Show child attributesHide child attributes
namestringRequired

Display name of the listing. Must start with a letter or digit and be at most 100 characters.

subtitlestring

One-line subtitle shown with the listing name.

statusstring

Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a listing as DRAFT and set the status to PUBLISHED when it is ready.

Values:

  • DRAFT
  • PENDING
  • PUBLISHED
  • SUSPENDED
shareobject

Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD listing, except for app and MCP server listings; notebook and Git repo listings can use git_repo instead. The caller must have access to the share.

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL
provider_regionobject

Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

settingobject

Listing settings, such as whether the listing is visible in the public Marketplace or only in private exchanges.

Show child attributesHide child attributes
visibilitystring

PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible only to members of the private exchanges that they are shared in.

Values:

  • PUBLIC
  • PRIVATE
created_atint64

Time the listing was created, in epoch milliseconds.

created_bystring

Name of the user who created the listing.

updated_atint64

Time the listing was last updated, in epoch milliseconds.

updated_bystring

Name of the user who last updated the listing.

published_atint64
published_bystring
categoriesarray of string

Categories that consumers can use to filter listings. They also appear as tags on the listing tile and detail page.

Values:

Show 22 possible values
  • ADVERTISING_AND_MARKETING
  • CLIMATE_AND_ENVIRONMENT
  • COMMERCE
  • DEMOGRAPHICS
  • ECONOMICS
  • EDUCATION
  • ENERGY
  • FINANCIAL
  • GAMING
  • GEOSPATIAL
  • HEALTH
  • LOOKUP_TABLES
  • MANUFACTURING
  • MEDIA
  • OTHER
  • PUBLIC_SECTOR
  • RETAIL
  • SECURITY
  • SCIENCE_AND_RESEARCH
  • SPORTS
  • TRANSPORTATION_AND_LOGISTICS
  • TRAVEL_AND_TOURISM
listingTypestringRequired

How consumers get access to the listing. STANDARD listings are instantly available; PERSONALIZED listings require the provider to approve each consumer request. Cannot be changed after the listing is created.

Values:

  • STANDARD
  • PERSONALIZED
created_by_idint64

ID of the user who created the listing.

updated_by_idint64

ID of the user who last updated the listing.

provider_idstring

ID of the provider profile that owns the listing.

exchange_idsarray of string

IDs of the private exchanges that the listing is shared in. A listing can be linked to at most 10 exchanges.

git_repoobject

Git repository that holds the listing's assets, used instead of a share for notebook and Git repo listings. A listing cannot have both a share and a Git repo.

Show child attributesHide child attributes
git_repo_urlstringRequired

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Descriptive content shown to consumers on the listing page, such as the description, links and data attributes.

Show child attributesHide child attributes
descriptionstring

Detailed description of the data product. Supports basic Markdown formatting such as bold, italics and lists.

terms_of_servicestring

URL of the terms of service for the listing. Defaults to the provider profile's terms of service link when empty.

file_idsarray of string
embedded_notebook_file_infosarray of object

Sample notebooks attached to the listing. Create each notebook with createFile, using the EMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values:

  • FREE
  • PAID
pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Types of assets included in the listing. At least one is required unless the listing is a DRAFT. Duplicate values are ignored.

Values:

  • ASSET_TYPE_GIT_REPO
  • ASSET_TYPE_DATA_TABLE
  • ASSET_TYPE_MODEL
  • ASSET_TYPE_NOTEBOOK
  • ASSET_TYPE_MEDIA
  • ASSET_TYPE_PARTNER_INTEGRATION
  • ASSET_TYPE_APP
  • ASSET_TYPE_MCP
licensestring

License of the data asset. Required for listings with model-based assets.

tagsarray of object

Tags that annotate the listing with fixed, low-cardinality values, such as supported languages or tasks.

Show child attributesHide child attributes
tag_namestring

Tag name (enum)

Values:

  • LISTING_TAG_TYPE_LANGUAGE
  • LISTING_TAG_TYPE_TASK
tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

Response​

listingobject

The updated listing.

Show child attributesHide child attributes
idstring

ID of the listing. Assigned by the server; not allowed in create requests.

summaryobjectRequired

Identity, status and sharing configuration of the listing.

Show child attributesHide child attributes
namestringRequired

Display name of the listing. Must start with a letter or digit and be at most 100 characters.

subtitlestring

One-line subtitle shown with the listing name.

statusstring

Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a listing as DRAFT and set the status to PUBLISHED when it is ready.

Values:

  • DRAFT
  • PENDING
  • PUBLISHED
  • SUSPENDED
shareobject

Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD listing, except for app and MCP server listings; notebook and Git repo listings can use git_repo instead. The caller must have access to the share.

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL
provider_regionobject

Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

settingobject

Listing settings, such as whether the listing is visible in the public Marketplace or only in private exchanges.

Show child attributesHide child attributes
visibilitystring

PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible only to members of the private exchanges that they are shared in.

Values:

  • PUBLIC
  • PRIVATE
created_atint64

Time the listing was created, in epoch milliseconds.

created_bystring

Name of the user who created the listing.

updated_atint64

Time the listing was last updated, in epoch milliseconds.

updated_bystring

Name of the user who last updated the listing.

published_atint64
published_bystring
categoriesarray of string

Categories that consumers can use to filter listings. They also appear as tags on the listing tile and detail page.

Values:

Show 22 possible values
  • ADVERTISING_AND_MARKETING
  • CLIMATE_AND_ENVIRONMENT
  • COMMERCE
  • DEMOGRAPHICS
  • ECONOMICS
  • EDUCATION
  • ENERGY
  • FINANCIAL
  • GAMING
  • GEOSPATIAL
  • HEALTH
  • LOOKUP_TABLES
  • MANUFACTURING
  • MEDIA
  • OTHER
  • PUBLIC_SECTOR
  • RETAIL
  • SECURITY
  • SCIENCE_AND_RESEARCH
  • SPORTS
  • TRANSPORTATION_AND_LOGISTICS
  • TRAVEL_AND_TOURISM
listingTypestringRequired

How consumers get access to the listing. STANDARD listings are instantly available; PERSONALIZED listings require the provider to approve each consumer request. Cannot be changed after the listing is created.

Values:

  • STANDARD
  • PERSONALIZED
created_by_idint64

ID of the user who created the listing.

updated_by_idint64

ID of the user who last updated the listing.

provider_idstring

ID of the provider profile that owns the listing.

exchange_idsarray of string

IDs of the private exchanges that the listing is shared in. A listing can be linked to at most 10 exchanges.

git_repoobject

Git repository that holds the listing's assets, used instead of a share for notebook and Git repo listings. A listing cannot have both a share and a Git repo.

Show child attributesHide child attributes
git_repo_urlstringRequired

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Descriptive content shown to consumers on the listing page, such as the description, links and data attributes.

Show child attributesHide child attributes
descriptionstring

Detailed description of the data product. Supports basic Markdown formatting such as bold, italics and lists.

terms_of_servicestring

URL of the terms of service for the listing. Defaults to the provider profile's terms of service link when empty.

file_idsarray of string
embedded_notebook_file_infosarray of object

Sample notebooks attached to the listing. Create each notebook with createFile, using the EMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values:

  • FREE
  • PAID
pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes
intervalint64Required

Number of time units. Must be greater than zero.

unitstringRequired

Time unit that the interval is expressed in.

Values:

  • NONE
  • SECOND
  • MINUTE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY
  • YEARLY
collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Types of assets included in the listing. At least one is required unless the listing is a DRAFT. Duplicate values are ignored.

Values:

  • ASSET_TYPE_GIT_REPO
  • ASSET_TYPE_DATA_TABLE
  • ASSET_TYPE_MODEL
  • ASSET_TYPE_NOTEBOOK
  • ASSET_TYPE_MEDIA
  • ASSET_TYPE_PARTNER_INTEGRATION
  • ASSET_TYPE_APP
  • ASSET_TYPE_MCP
licensestring

License of the data asset. Required for listings with model-based assets.

tagsarray of object

Tags that annotate the listing with fixed, low-cardinality values, such as supported languages or tasks.

Show child attributesHide child attributes
tag_namestring

Tag name (enum)

Values:

  • LISTING_TAG_TYPE_LANGUAGE
  • LISTING_TAG_TYPE_TASK
tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

Delete a listing GA​

DELETE /api/2.0/marketplace-provider/listings/{id}

1 more path

DELETE /api/2.1/marketplace-provider/listings/{id}

Deletes a listing permanently. The underlying share is not deleted, and consumers who already have access to the share keep that access until it is revoked in Delta Sharing.

API scopes: marketplace

Parameters​

idstringRequiredpath

ID of the listing to delete.

Get provider GA​

GET /api/2.0/marketplace-provider/providers/{id}

1 more path

GET /api/2.1/marketplace-provider/providers/{id}

Gets a provider profile by ID.

API scopes: marketplace

Parameters​

idstringRequiredpath

ID of the provider profile.

Response​

providerobject

The requested provider profile.

Show child attributesHide child attributes
idstring

ID of the provider profile. Assigned by the server; not allowed in create or update requests.

namestringRequired

Display name of the provider. Consumers can filter listings by provider name.

descriptionstring

Description of the provider organization, shown on the provider profile and on all of its listings.

icon_file_pathstring

URL for downloading the provider icon. Populated by the server from icon_file_id.

business_contact_emailstringRequired

Email address that Databricks uses to contact the provider. Not shown to consumers.

support_contact_emailstring

Email address that consumers can use to request support. Shown on all of the provider's listings.

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

icon_file_idstring

ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_idstring

ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_pathstring

URL for downloading the dark mode provider icon. Populated by the server from dark_mode_icon_file_id.

List providers GA​

GET /api/2.0/marketplace-provider/providers

1 more path

GET /api/2.1/marketplace-provider/providers

Lists the provider profiles in the caller's account.

API scopes: marketplace

Parameters​

page_tokenstringquery

Token from the next_page_token field of a previous response. Omit to get the first page.

page_sizeint32query

Maximum number of results to return per page.

Response​

providersarray of object

Provider profiles on this page.

Show child attributesHide child attributes
idstring

ID of the provider profile. Assigned by the server; not allowed in create or update requests.

namestringRequired

Display name of the provider. Consumers can filter listings by provider name.

descriptionstring

Description of the provider organization, shown on the provider profile and on all of its listings.

icon_file_pathstring

URL for downloading the provider icon. Populated by the server from icon_file_id.

business_contact_emailstringRequired

Email address that Databricks uses to contact the provider. Not shown to consumers.

support_contact_emailstring

Email address that consumers can use to request support. Shown on all of the provider's listings.

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

icon_file_idstring

ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_idstring

ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_pathstring

URL for downloading the dark mode provider icon. Populated by the server from dark_mode_icon_file_id.

next_page_tokenstring

Token for the next page. Not set when there are no more results.

Create a provider GA​

POST /api/2.0/marketplace-provider/provider

1 more path

POST /api/2.1/marketplace-provider/provider

Creates a provider profile in the caller's account. Returns the ID of the new profile.

API scopes: marketplace

Request body​

providerobjectRequired

Provider profile to create.

Show child attributesHide child attributes
idstring

ID of the provider profile. Assigned by the server; not allowed in create or update requests.

namestringRequired

Display name of the provider. Consumers can filter listings by provider name.

descriptionstring

Description of the provider organization, shown on the provider profile and on all of its listings.

icon_file_pathstring

URL for downloading the provider icon. Populated by the server from icon_file_id.

business_contact_emailstringRequired

Email address that Databricks uses to contact the provider. Not shown to consumers.

support_contact_emailstring

Email address that consumers can use to request support. Shown on all of the provider's listings.

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

icon_file_idstring

ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_idstring

ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_pathstring

URL for downloading the dark mode provider icon. Populated by the server from dark_mode_icon_file_id.

Response​

idstring

ID of the created provider profile.

Update provider GA​

PUT /api/2.0/marketplace-provider/providers/{id}

1 more path

PUT /api/2.1/marketplace-provider/providers/{id}

Updates a provider profile. Send the full profile definition.

API scopes: marketplace

Parameters​

idstringRequiredpath

ID of the provider profile to update.

Request body​

providerobjectRequired

Full definition of the provider profile, including the fields that are not changing.

Show child attributesHide child attributes
idstring

ID of the provider profile. Assigned by the server; not allowed in create or update requests.

namestringRequired

Display name of the provider. Consumers can filter listings by provider name.

descriptionstring

Description of the provider organization, shown on the provider profile and on all of its listings.

icon_file_pathstring

URL for downloading the provider icon. Populated by the server from icon_file_id.

business_contact_emailstringRequired

Email address that Databricks uses to contact the provider. Not shown to consumers.

support_contact_emailstring

Email address that consumers can use to request support. Shown on all of the provider's listings.

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

icon_file_idstring

ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_idstring

ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_pathstring

URL for downloading the dark mode provider icon. Populated by the server from dark_mode_icon_file_id.

Response​

providerobject

The updated provider profile.

Show child attributesHide child attributes
idstring

ID of the provider profile. Assigned by the server; not allowed in create or update requests.

namestringRequired

Display name of the provider. Consumers can filter listings by provider name.

descriptionstring

Description of the provider organization, shown on the provider profile and on all of its listings.

icon_file_pathstring

URL for downloading the provider icon. Populated by the server from icon_file_id.

business_contact_emailstringRequired

Email address that Databricks uses to contact the provider. Not shown to consumers.

support_contact_emailstring

Email address that consumers can use to request support. Shown on all of the provider's listings.

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

icon_file_idstring

ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_idstring

ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON file type.

dark_mode_icon_file_pathstring

URL for downloading the dark mode provider icon. Populated by the server from dark_mode_icon_file_id.

Delete provider GA​

DELETE /api/2.0/marketplace-provider/providers/{id}

1 more path

DELETE /api/2.1/marketplace-provider/providers/{id}

Deletes a provider profile and all of the listings that it owns.

API scopes: marketplace

Parameters​

idstringRequiredpath

ID of the provider profile to delete.

All personalization requests across all listings GA​

GET /api/2.0/marketplace-provider/personalization-requests

1 more path

GET /api/2.1/marketplace-provider/personalization-requests

List personalization requests to this provider. This will return all personalization requests, regardless of which listing they are for.

API scopes: marketplace

Parameters​

page_tokenstringquery

Token from the next_page_token field of a previous response. Omit to get the first page.

page_sizeint32query

Maximum number of results to return per page.

Response​

personalization_requestsarray of object

Personalization requests on this page.

Show child attributesHide child attributes
idstring

ID of the personalization request.

consumer_regionobjectRequired

Cloud and region of the consumer's Unity Catalog metastore.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

contact_infoobject

Contact details that the consumer entered with the request.

Show child attributesHide child attributes
first_namestring

First name of the consumer contact.

last_namestring

Last name of the consumer contact.

emailstring

Email address of the consumer contact.

companystring

Company of the consumer contact.

commentstring

Comment that the consumer entered with the request.

intended_usestring

How the consumer intends to use the data product, as entered with the request.

statusstring

Current status of the request.

Values:

  • NEW
  • REQUEST_PENDING
  • FULFILLED
  • DENIED
status_messagestring

Reason that the provider gave in the most recent status update.

shareobject

Share information is required for data listings but should be empty/ignored for non-data listings (MCP and App).

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL
created_atint64

Time the request was created, in epoch milliseconds.

listing_idstring

ID of the listing that the request was made for.

updated_atint64

Time the request was last updated, in epoch milliseconds.

metastore_idstring

ID of the consumer's Unity Catalog metastore.

listing_namestring

Name of the listing that the request was made for.

is_from_lighthouseboolean
provider_idstring

ID of the provider profile that owns the listing.

recipient_typestring

How the consumer receives the shared data: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS for a consumer on a Databricks workspace, DELTA_SHARING_RECIPIENT_TYPE_OPEN for a consumer on another platform who uses a credential file.

Values:

  • DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS
  • DELTA_SHARING_RECIPIENT_TYPE_OPEN
next_page_tokenstring

Token for the next page. Not set when there are no more results.

Update personalization request status GA​

PUT /api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status

1 more path

PUT /api/2.1/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status

Updates the status of a personalization request; other properties of the request cannot be changed. Fulfilling a request grants the consumer access to the share, and denying a fulfilled request revokes that access. The listing must be published.

API scopes: marketplace

Parameters​

listing_idstringRequiredpath

ID of the listing that the request was made for.

request_idstringRequiredpath

ID of the personalization request.

Request body​

statusstringRequired

New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING, FULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING.

Values:

  • NEW
  • REQUEST_PENDING
  • FULFILLED
  • DENIED
reasonstring

Message for the consumer that explains the status change, at most 255 characters.

shareobject

Share to grant the consumer access to. Required when fulfilling a request for a listing with data assets and not allowed with other statuses. Ignored for app and MCP server listings.

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL

Response​

requestobject

The updated personalization request.

Show child attributesHide child attributes
idstring

ID of the personalization request.

consumer_regionobjectRequired

Cloud and region of the consumer's Unity Catalog metastore.

Show child attributesHide child attributes
cloudstring

Cloud provider: aws, azure or gcp.

regionstring

Cloud region, for example us-west-2.

contact_infoobject

Contact details that the consumer entered with the request.

Show child attributesHide child attributes
first_namestring

First name of the consumer contact.

last_namestring

Last name of the consumer contact.

emailstring

Email address of the consumer contact.

companystring

Company of the consumer contact.

commentstring

Comment that the consumer entered with the request.

intended_usestring

How the consumer intends to use the data product, as entered with the request.

statusstring

Current status of the request.

Values:

  • NEW
  • REQUEST_PENDING
  • FULFILLED
  • DENIED
status_messagestring

Reason that the provider gave in the most recent status update.

shareobject

Share information is required for data listings but should be empty/ignored for non-data listings (MCP and App).

Show child attributesHide child attributes
namestringRequired

Name of the Delta Sharing share in the provider's Unity Catalog metastore.

typestringRequired

Values:

  • SAMPLE
  • FULL
created_atint64

Time the request was created, in epoch milliseconds.

listing_idstring

ID of the listing that the request was made for.

updated_atint64

Time the request was last updated, in epoch milliseconds.

metastore_idstring

ID of the consumer's Unity Catalog metastore.

listing_namestring

Name of the listing that the request was made for.

is_from_lighthouseboolean
provider_idstring

ID of the provider profile that owns the listing.

recipient_typestring

How the consumer receives the shared data: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS for a consumer on a Databricks workspace, DELTA_SHARING_RECIPIENT_TYPE_OPEN for a consumer on another platform who uses a credential file.

Values:

  • DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS
  • DELTA_SHARING_RECIPIENT_TYPE_OPEN

Get a file GA​

GET /api/2.0/marketplace-provider/files/{file_id}

1 more path

GET /api/2.1/marketplace-provider/files/{file_id}

Gets a file's metadata, including a short-lived download URL.

API scopes: marketplace

Parameters​

file_idstringRequiredpath

ID of the file.

Response​

file_infoobject

Metadata of the file.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

List files GA​

GET /api/2.0/marketplace-provider/files

1 more path

GET /api/2.1/marketplace-provider/files

Lists the files attached to a provider profile or a listing.

API scopes: marketplace

Parameters​

file_parentobjectRequiredquery

Provider profile or listing whose files to list.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
page_tokenstringquery

Token from the next_page_token field of a previous response. Omit to get the first page.

page_sizeint32query

Maximum number of results to return per page.

Response​

file_infosarray of object

Files on this page.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

next_page_tokenstring

Token for the next page. Not set when there are no more results.

Create a file GA​

POST /api/2.0/marketplace-provider/files

1 more path

POST /api/2.1/marketplace-provider/files

Creates a file and returns a short-lived URL for uploading its content with an HTTP PUT request. Only provider icons (PROVIDER_ICON files on a PROVIDER parent) and sample notebooks (EMBEDDED_NOTEBOOK files on a LISTING parent) are supported.

API scopes: marketplace

Request body​

file_parentobjectRequired

Provider profile or listing to attach the file to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
marketplace_file_typestringRequired

Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; EMBEDDED_NOTEBOOK requires a LISTING parent.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
mime_typestringRequired

MIME type of the file content: text/html for notebooks; image/png, image/jpeg or image/svg+xml for icons.

display_namestring

Name shown to consumers for the file, for example a notebook title. At most 255 characters.

Response​

upload_urlstring

Short-lived URL for uploading the file content with an HTTP PUT request.

file_infoobject

Metadata of the created file.

Show child attributesHide child attributes
idstring

ID of the file.

marketplace_file_typestring

Purpose of the file, such as a provider icon or a notebook attached to a listing.

Values:

  • PROVIDER_ICON
  • EMBEDDED_NOTEBOOK
  • APP
file_parentobject

Provider or listing that the file belongs to.

Show child attributesHide child attributes
parent_idstring

ID of the provider or listing that the file belongs to.

file_parent_typestring

Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.

Values:

  • PROVIDER
  • LISTING
  • LISTING_RESOURCE
mime_typestring

MIME type of the file content, for example text/html for notebooks or image/png for icons.

created_atint64

Time the file was created, in epoch milliseconds.

updated_atint64

Time the file was last updated, in epoch milliseconds.

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Processing status of the file. New files start in FILE_STATUS_STAGING and become FILE_STATUS_PUBLISHED after Databricks has sanitized them.

Values:

  • FILE_STATUS_PUBLISHED
  • FILE_STATUS_STAGING
  • FILE_STATUS_SANITIZING
  • FILE_STATUS_SANITIZATION_FAILED
status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

Delete a file GA​

DELETE /api/2.0/marketplace-provider/files/{file_id}

1 more path

DELETE /api/2.1/marketplace-provider/files/{file_id}

Deletes a file. Fails if the file is still in use.

API scopes: marketplace

Parameters​

file_idstringRequiredpath

ID of the file to delete.

Get provider analytics dashboard GA​

GET /api/2.0/marketplace-provider/analytics_dashboard

1 more path

GET /api/2.1/marketplace-provider/analytics_dashboard

Gets the Provider Analytics Dashboard that was created for the caller's account. Returns an empty response if the dashboard has not been created yet.

API scopes: marketplace

Response​

idstringRequired

Marketplace-specific ID of the dashboard record. Use it as the id when updating the dashboard.

versionint64

Version of the dashboard template that the dashboard was created or last updated from.

dashboard_idstringRequired

ID of the AI/BI dashboard in the workspace. Use it to open the dashboard.

Create provider analytics dashboard GA​

POST /api/2.0/marketplace-provider/analytics_dashboard

1 more path

POST /api/2.1/marketplace-provider/analytics_dashboard

Creates the Provider Analytics Dashboard in the caller's workspace from the latest template. Fails if the dashboard already exists. Returns the Marketplace-specific id of the dashboard record, which is distinct from the AI/BI dashboard ID.

API scopes: marketplace

Response​

idstringRequired

Marketplace-specific ID of the dashboard record, distinct from the AI/BI dashboard ID.

Update provider analytics dashboard GA​

PUT /api/2.0/marketplace-provider/analytics_dashboard/{id}

1 more path

PUT /api/2.1/marketplace-provider/analytics_dashboard/{id}

Updates the Provider Analytics Dashboard to a newer version of the template. The requested version must be newer than the version that the dashboard currently uses.

API scopes: marketplace

Parameters​

idstringRequiredpath

Marketplace-specific ID of the dashboard record, as returned when the dashboard was created or retrieved.

Request body​

versionint64

Version of the dashboard template to update to. Must be newer than the version that the dashboard currently uses; use the version returned by getLatestVersionProviderAnalyticsDashboard.

Response​

idstringRequired

Marketplace-specific ID of the dashboard record, the same as in the request.

versionint64

Version of the dashboard template that the dashboard now uses.

dashboard_idstringRequired

ID of the AI/BI dashboard that now contains the updated template.

Get latest version of provider analytics dashboard GA​

GET /api/2.0/marketplace-provider/analytics_dashboard/latest

1 more path

GET /api/2.1/marketplace-provider/analytics_dashboard/latest

Gets the latest available version of the Provider Analytics Dashboard template.

API scopes: marketplace

Response​

versionint64

Latest available version of the dashboard template.