Consumer
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.
DRAFTPENDINGPUBLISHEDSUSPENDED
- 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.
PUBLICPRIVATE
- 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.
Show 22 possible values
ADVERTISING_AND_MARKETINGCLIMATE_AND_ENVIRONMENTCOMMERCEDEMOGRAPHICSECONOMICSEDUCATIONENERGYFINANCIALGAMINGGEOSPATIALHEALTHLOOKUP_TABLESMANUFACTURINGMEDIAOTHERPUBLIC_SECTORRETAILSECURITYSCIENCE_AND_RESEARCHSPORTSTRANSPORTATION_AND_LOGISTICSTRAVEL_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.
STANDARDPERSONALIZED
- 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.
- documentation_linkstring
URL of documentation that helps consumers use the data product.
- support_linkstring
URL where consumers can get support for the listing.
- file_idsarray of string
- privacy_policy_linkstring
URL of the privacy policy for the listing. Defaults to the provider profile's privacy policy link when empty.
- 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.
PROVIDER_ICONEMBEDDED_NOTEBOOKAPP
- 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.
PROVIDERLISTINGLISTING_RESOURCE
- mime_typestring
MIME type of the file content, for example text/html for notebooks or image/png for icons.
- download_linkstring
Short-lived URL for downloading the file content.
- 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.
FILE_STATUS_PUBLISHEDFILE_STATUS_STAGINGFILE_STATUS_SANITIZINGFILE_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
FREEPAID
- 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.
NONESECONDMINUTEHOURLYDAILYWEEKLYMONTHLYQUARTERLYYEARLY
- 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.
NONESECONDMINUTEHOURLYDAILYWEEKLYMONTHLYQUARTERLYYEARLY
- 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.
ASSET_TYPE_GIT_REPOASSET_TYPE_DATA_TABLEASSET_TYPE_MODELASSET_TYPE_NOTEBOOKASSET_TYPE_MEDIAASSET_TYPE_PARTNER_INTEGRATIONASSET_TYPE_APPASSET_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)
LISTING_TAG_TYPE_LANGUAGELISTING_TAG_TYPE_TASK
- tag_valuesarray of string
String representation of the tag value. Values should be string literals (no complex types)
Get listing GA
GET
Get a published listing in the Databricks Marketplace that the consumer has access to.
API scopes: marketplace
Parameters
- idstringRequiredpath
Response
- listingobject
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.
DRAFTPENDINGPUBLISHEDSUSPENDED
- 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.
PUBLICPRIVATE
- 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.
Show 22 possible values
ADVERTISING_AND_MARKETINGCLIMATE_AND_ENVIRONMENTCOMMERCEDEMOGRAPHICSECONOMICSEDUCATIONENERGYFINANCIALGAMINGGEOSPATIALHEALTHLOOKUP_TABLESMANUFACTURINGMEDIAOTHERPUBLIC_SECTORRETAILSECURITYSCIENCE_AND_RESEARCHSPORTSTRANSPORTATION_AND_LOGISTICSTRAVEL_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.
STANDARDPERSONALIZED
- 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.
- documentation_linkstring
URL of documentation that helps consumers use the data product.
- support_linkstring
URL where consumers can get support for the listing.
- file_idsarray of string
- privacy_policy_linkstring
URL of the privacy policy for the listing. Defaults to the provider profile's privacy policy link when empty.
- 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.
PROVIDER_ICONEMBEDDED_NOTEBOOKAPP
- 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.
PROVIDERLISTINGLISTING_RESOURCE
- mime_typestring
MIME type of the file content, for example text/html for notebooks or image/png for icons.
- download_linkstring
Short-lived URL for downloading the file content.
- 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.
FILE_STATUS_PUBLISHEDFILE_STATUS_STAGINGFILE_STATUS_SANITIZINGFILE_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
FREEPAID
- 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.
NONESECONDMINUTEHOURLYDAILYWEEKLYMONTHLYQUARTERLYYEARLY
- 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.
NONESECONDMINUTEHOURLYDAILYWEEKLYMONTHLYQUARTERLYYEARLY
- 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.
ASSET_TYPE_GIT_REPOASSET_TYPE_DATA_TABLEASSET_TYPE_MODELASSET_TYPE_NOTEBOOKASSET_TYPE_MEDIAASSET_TYPE_PARTNER_INTEGRATIONASSET_TYPE_APPASSET_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)
LISTING_TAG_TYPE_LANGUAGELISTING_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
List all published listings in the Databricks Marketplace that the consumer has access to.
API scopes: marketplace
Parameters
- page_tokenstringquery
- page_sizeint32query
- assetsarray of stringquery
Matches any of the following asset types
ASSET_TYPE_GIT_REPOASSET_TYPE_DATA_TABLEASSET_TYPE_MODELASSET_TYPE_NOTEBOOKASSET_TYPE_MEDIAASSET_TYPE_PARTNER_INTEGRATIONASSET_TYPE_APPASSET_TYPE_MCP
- categoriesarray of stringquery
Matches any of the following categories
Show 22 possible values
ADVERTISING_AND_MARKETINGCLIMATE_AND_ENVIRONMENTCOMMERCEDEMOGRAPHICSECONOMICSEDUCATIONENERGYFINANCIALGAMINGGEOSPATIALHEALTHLOOKUP_TABLESMANUFACTURINGMEDIAOTHERPUBLIC_SECTORRETAILSECURITYSCIENCE_AND_RESEARCHSPORTSTRANSPORTATION_AND_LOGISTICSTRAVEL_AND_TOURISM
- tagsobjectquery
Matches listings with this tag
Show child attributesHide child attributes
- tag_namestring
Tag name (enum)
LISTING_TAG_TYPE_LANGUAGELISTING_TAG_TYPE_TASK
- tag_valuesarray of string
String representation of the tag value. Values should be string literals (no complex types)
- is_freebooleanquery
Filters each listing based on if it is free.
- is_private_exchangebooleanquery
Filters each listing based on if it is a private exchange.
- is_staff_pickbooleanquery
Filters each listing based on whether it is a staff pick.
- provider_idsarray of stringquery
Matches any of the following provider ids
Response
Returns a list of Listing objects.
Install from a listing GA
POST
Install payload associated with a Databricks Marketplace listing.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
Request body
- catalog_namestring
- repo_detailobject
for git repo installations
Show child attributesHide child attributes
- repo_namestringRequired
the user-specified repo name for their installed git repo listing
- repo_pathstringRequired
refers to the full url file path that navigates the user to the repo's entrypoint (e.g. a README.md file, or the repo file view in the unified UI) should just be a relative path
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- accepted_consumer_termsobject
Show child attributesHide child attributes
- versionstringRequired
Response
- installationobject
Show child attributesHide child attributes
- idstring
- listing_idstring
- catalog_namestring
- installed_onint64
- statusstring
INSTALLEDFAILED
- error_messagestring
- listing_namestring
- repo_namestring
- repo_pathstring
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- tokensarray of object
Show child attributesHide child attributes
- idstring
Unique id of the Recipient Token.
- created_atint64
Time at which this Recipient Token was created, in epoch milliseconds.
- created_bystring
Username of Recipient Token creator.
- activation_urlstring
Full activation url to retrieve the access token. It will be empty if the token is already retrieved.
- expiration_timeint64
Expiration timestamp of the token in epoch milliseconds.
- updated_atint64
Time at which this Recipient Token was updated, in epoch milliseconds.
- updated_bystring
Username of Recipient Token updater.
- token_detailobject
Show child attributesHide child attributes
- bearerTokenstring
- endpointstring
- expirationTimestring
Update an installation GA
PUT
This is a update API that will update the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table
- the token will be rotate if the rotateToken flag is true
- the token will be forcibly rotate if the rotateToken flag is true and the tokenInfo field is empty
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
- installation_idstringRequiredpath
Request body
- installationobjectRequired
Show child attributesHide child attributes
- idstring
- listing_idstring
- catalog_namestring
- installed_onint64
- statusstring
INSTALLEDFAILED
- error_messagestring
- listing_namestring
- repo_namestring
- repo_pathstring
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- tokensarray of object
Show child attributesHide child attributes
- idstring
Unique id of the Recipient Token.
- created_atint64
Time at which this Recipient Token was created, in epoch milliseconds.
- created_bystring
Username of Recipient Token creator.
- activation_urlstring
Full activation url to retrieve the access token. It will be empty if the token is already retrieved.
- expiration_timeint64
Expiration timestamp of the token in epoch milliseconds.
- updated_atint64
Time at which this Recipient Token was updated, in epoch milliseconds.
- updated_bystring
Username of Recipient Token updater.
- token_detailobject
Show child attributesHide child attributes
- bearerTokenstring
- endpointstring
- expirationTimestring
- rotate_tokenboolean
Response
- installationobject
Show child attributesHide child attributes
- idstring
- listing_idstring
- catalog_namestring
- installed_onint64
- statusstring
INSTALLEDFAILED
- error_messagestring
- listing_namestring
- repo_namestring
- repo_pathstring
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- tokensarray of object
Show child attributesHide child attributes
- idstring
Unique id of the Recipient Token.
- created_atint64
Time at which this Recipient Token was created, in epoch milliseconds.
- created_bystring
Username of Recipient Token creator.
- activation_urlstring
Full activation url to retrieve the access token. It will be empty if the token is already retrieved.
- expiration_timeint64
Expiration timestamp of the token in epoch milliseconds.
- updated_atint64
Time at which this Recipient Token was updated, in epoch milliseconds.
- updated_bystring
Username of Recipient Token updater.
- token_detailobject
Show child attributesHide child attributes
- bearerTokenstring
- endpointstring
- expirationTimestring
Uninstall from a listing GA
DELETE
Uninstall an installation associated with a Databricks Marketplace listing.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
- installation_idstringRequiredpath
Get one batch of listings. One may specify up to 50 IDs per request GA
GET
Batch get a published listing in the Databricks Marketplace that the consumer has access to.
API scopes: marketplace
Parameters
- idsarray of stringquery
Response
Returns a list of Listing objects.
Search listings GA
GET
Search published listings in the Databricks Marketplace that the consumer has access to. This query supports a variety of different search parameters and performs fuzzy matching.
API scopes: marketplace
Parameters
- querystringRequiredquery
Fuzzy matches query
- is_freebooleanquery
- is_private_exchangebooleanquery
- provider_idsarray of stringquery
Matches any of the following provider ids
- categoriesarray of stringquery
Matches any of the following categories
Show 22 possible values
ADVERTISING_AND_MARKETINGCLIMATE_AND_ENVIRONMENTCOMMERCEDEMOGRAPHICSECONOMICSEDUCATIONENERGYFINANCIALGAMINGGEOSPATIALHEALTHLOOKUP_TABLESMANUFACTURINGMEDIAOTHERPUBLIC_SECTORRETAILSECURITYSCIENCE_AND_RESEARCHSPORTSTRANSPORTATION_AND_LOGISTICSTRAVEL_AND_TOURISM
- assetsarray of stringquery
Matches any of the following asset types
ASSET_TYPE_GIT_REPOASSET_TYPE_DATA_TABLEASSET_TYPE_MODELASSET_TYPE_NOTEBOOKASSET_TYPE_MEDIAASSET_TYPE_PARTNER_INTEGRATIONASSET_TYPE_APPASSET_TYPE_MCP
- page_tokenstringquery
- page_sizeint32query
Response
Returns a list of Listing objects.
List providers GA
GET
List all providers in the Databricks Marketplace with at least one visible listing.
API scopes: marketplace
Parameters
- page_tokenstringquery
- page_sizeint32query
- is_featuredbooleanquery
Response
- providersarray of object
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.
- is_featuredboolean
Whether Databricks features the provider in the Marketplace. Set by Databricks; not allowed in create or update requests.
- published_bystring
published_by is only applicable to data aggregators (e.g. Crux)
- company_website_linkstring
URL of the provider's website. Shown on all of the provider's listings.
- icon_file_idstring
ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.
- term_of_service_linkstringRequired
URL of the provider's terms of service. Shown on all of the provider's listings unless a listing sets its own terms of service.
- privacy_policy_linkstringRequired
URL of the provider's privacy policy. Shown on all of the provider's listings unless a listing sets its own privacy policy.
- 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
Get one batch of providers. One may specify up to 50 IDs per request GA
GET
Batch get a provider in the Databricks Marketplace with at least one visible listing.
API scopes: marketplace
Parameters
- idsarray of stringquery
Response
- providersarray of object
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.
- is_featuredboolean
Whether Databricks features the provider in the Marketplace. Set by Databricks; not allowed in create or update requests.
- published_bystring
published_by is only applicable to data aggregators (e.g. Crux)
- company_website_linkstring
URL of the provider's website. Shown on all of the provider's listings.
- icon_file_idstring
ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.
- term_of_service_linkstringRequired
URL of the provider's terms of service. Shown on all of the provider's listings unless a listing sets its own terms of service.
- privacy_policy_linkstringRequired
URL of the provider's privacy policy. Shown on all of the provider's listings unless a listing sets its own privacy policy.
- 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.
Get a provider GA
GET
Get a provider in the Databricks Marketplace with at least one visible listing.
API scopes: marketplace
Parameters
- idstringRequiredpath
Response
- providerobject
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.
- is_featuredboolean
Whether Databricks features the provider in the Marketplace. Set by Databricks; not allowed in create or update requests.
- published_bystring
published_by is only applicable to data aggregators (e.g. Crux)
- company_website_linkstring
URL of the provider's website. Shown on all of the provider's listings.
- icon_file_idstring
ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.
- term_of_service_linkstringRequired
URL of the provider's terms of service. Shown on all of the provider's listings unless a listing sets its own terms of service.
- privacy_policy_linkstringRequired
URL of the provider's privacy policy. Shown on all of the provider's listings unless a listing sets its own privacy policy.
- 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 all installations GA
GET
List all installations across all listings.
API scopes: marketplace
Parameters
- page_tokenstringquery
- page_sizeint32query
Response
- installationsarray of object
Show child attributesHide child attributes
- idstring
- listing_idstring
- catalog_namestring
- installed_onint64
- statusstring
INSTALLEDFAILED
- error_messagestring
- listing_namestring
- repo_namestring
- repo_pathstring
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- tokensarray of object
Show child attributesHide child attributes
- idstring
Unique id of the Recipient Token.
- created_atint64
Time at which this Recipient Token was created, in epoch milliseconds.
- created_bystring
Username of Recipient Token creator.
- activation_urlstring
Full activation url to retrieve the access token. It will be empty if the token is already retrieved.
- expiration_timeint64
Expiration timestamp of the token in epoch milliseconds.
- updated_atint64
Time at which this Recipient Token was updated, in epoch milliseconds.
- updated_bystring
Username of Recipient Token updater.
- token_detailobject
Show child attributesHide child attributes
- bearerTokenstring
- endpointstring
- expirationTimestring
- next_page_tokenstring
List installations for a listing GA
GET
List all installations for a particular listing.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
- page_tokenstringquery
- page_sizeint32query
Response
- installationsarray of object
Show child attributesHide child attributes
- idstring
- listing_idstring
- catalog_namestring
- installed_onint64
- statusstring
INSTALLEDFAILED
- error_messagestring
- listing_namestring
- repo_namestring
- repo_pathstring
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- tokensarray of object
Show child attributesHide child attributes
- idstring
Unique id of the Recipient Token.
- created_atint64
Time at which this Recipient Token was created, in epoch milliseconds.
- created_bystring
Username of Recipient Token creator.
- activation_urlstring
Full activation url to retrieve the access token. It will be empty if the token is already retrieved.
- expiration_timeint64
Expiration timestamp of the token in epoch milliseconds.
- updated_atint64
Time at which this Recipient Token was updated, in epoch milliseconds.
- updated_bystring
Username of Recipient Token updater.
- token_detailobject
Show child attributesHide child attributes
- bearerTokenstring
- endpointstring
- expirationTimestring
- next_page_tokenstring
List all listing fulfillments GA
GET
Get all listings fulfillments associated with a listing. A fulfillment is a potential installation. Standard installations contain metadata about the attached share or git repo. Only one of these fields will be present. Personalized installations contain metadata about the attached share or git repo, as well as the Delta Sharing recipient type.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
- page_tokenstringquery
- page_sizeint32query
Response
- fulfillmentsarray of object
Show child attributesHide child attributes
- listing_idstringRequired
- fulfillment_typestring
REQUEST_ACCESSINSTALL
- repo_infoobject
Show child attributesHide child attributes
- git_repo_urlstringRequired
the git repo url e.g. https://github.com/databrickslabs/dolly.git
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- next_page_tokenstring
Get listing content metadata GA
GET
Get a high level preview of the metadata of listing installable content.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
- page_tokenstringquery
- page_sizeint32query
Response
- next_page_tokenstring
Get the personalization request for a listing GA
GET
Get the personalization request for a listing. Each consumer can make at most one personalization request for a listing.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
Response
- personalization_requestsarray of object
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.
NEWREQUEST_PENDINGFULFILLEDDENIED
- status_messagestring
Reason that the provider gave in the most recent status update.
- 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.
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
List all personalization requests GA
GET
List personalization requests for a consumer across all listings.
API scopes: marketplace
Parameters
- page_tokenstringquery
- page_sizeint32query
Response
- personalization_requestsarray of object
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.
NEWREQUEST_PENDINGFULFILLEDDENIED
- status_messagestring
Reason that the provider gave in the most recent status update.
- 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.
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- next_page_tokenstring
Create a personalization request GA
POST
Create a personalization request for a listing.
API scopes: marketplace
Parameters
- listing_idstringRequiredpath
Request body
- commentstring
- intended_usestringRequired
- first_namestring
- last_namestring
- companystring
- is_from_lighthouseboolean
- recipient_typestring
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPEN
- accepted_consumer_termsobjectRequired
Show child attributesHide child attributes
- versionstringRequired
Response
- idstring