Databricks

Check access policy to a resource. GET /api/2.0/access-control/check-policy-v2 on Databricks. Requires actor, permission, resource, consistency_token, authz_identity.

Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the resource can contain an access rule of the role.

Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported.

Creates a new account access identity rule for a given account. This allows administrators to explicitly allow or deny specific principals from accessing the account.

Creates (allows) an identity attribute control-list entry for an account.

DESTRUCTIVE - Deletes an account access identity rule for a given principal.

DESTRUCTIVE - Deletes an identity attribute control-list entry.

Gets an account access identity rule for a given principal.

Gets an identity attribute control-list entry.

Retrieves an external group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.

Retrieves an external service principal with the given external ID from the customer's IdP. If the service principal does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.

Retrieves an external user with the given external ID from the customer's IdP. If the user does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.

Lists all account access identity rules for a given account. These rules control which principals (users, service principals, groups) from the customer's IdP are allowed or denied access to the Databricks account.

Lists the identity attribute control-list entries for an account.

Updates an identity attribute control-list entry for an account.

DESTRUCTIVE - Cancel a Custom LLM Optimization Run.

Create a Custom LLM. POST /api/2.0/custom-llms on Databricks. Requires name, instructions.

DESTRUCTIVE — Delete a Custom LLM. DELETE /api/2.0/custom-llms/{id} on Databricks. Requires id.

Get a Custom LLM. GET /api/2.0/custom-llms/{id} on Databricks. Requires id.

Start a Custom LLM Optimization Run. POST /api/2.0/custom-llms/{id}/optimize on Databricks. Requires id.

Update a Custom LLM. PATCH /api/2.0/custom-llms/{id} on Databricks. Requires id, custom_llm, update_mask.

Creates an agent service in a Unity Catalog schema. An agent service is a governed securable that registers an AI agent and exposes it for discovery, access control, and auditing. The caller supplies the leaf name in ``agent_service_id`` and the agent...

Creates an MCP service in a Unity Catalog schema. An MCP (Model Context Protocol) service is a governed securable that registers an MCP server and exposes its tools for discovery, access control, and invocation. The caller supplies the leaf name in...

Creates a model provider service in a Unity Catalog schema. A model provider service is a governed connection to an external model provider (for example OpenAI, Azure OpenAI, or Amazon Bedrock) that model services reference to invoke that provider. The...

Creates a model service in a Unity Catalog schema. A model service is a governed AI Gateway endpoint that routes inference requests to one or more model destinations. The caller supplies the leaf name in ``model_service_id``. You must be the owner of the...

DESTRUCTIVE - Deletes the agent service identified by its resource name. Optionally supply an ``etag`` to make the delete conditional on the agent service not having changed since it was read. You must be the owner of the agent service or have ``MANAGE`` on...

DESTRUCTIVE - Deletes the MCP service identified by its resource name. Optionally supply an ``etag`` to make the delete conditional on the MCP service not having changed since it was read. You must be the owner of the MCP service or have ``MANAGE`` on it...

DESTRUCTIVE - Deletes the model provider service identified by its resource name. Optionally supply an ``etag`` to make the delete conditional on the model provider service not having changed since it was read. You must be the owner of the model provider...

DESTRUCTIVE - Deletes the model service identified by its resource name. Optionally supply an ``etag`` to make the delete conditional on the model service not having changed since it was read. You must be the owner of the model service or have ``MANAGE`` on...

Returns the agent service identified by its resource name. You must be the owner of the agent service or have ``EXECUTE``, ``READ_METADATA``, or ``MANAGE`` on it, plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the parent schema.

Returns the MCP service identified by its resource name. You must be the owner of the MCP service or have ``EXECUTE``, ``READ_METADATA``, or ``MANAGE`` on it, plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the parent schema.

Returns the model provider service identified by its resource name. You must be the owner of the model provider service or have ``EXECUTE``, ``READ_METADATA``, or ``MANAGE`` on it, plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the parent...

Returns the model service identified by its resource name. You must be the owner of the model service or have ``EXECUTE``, ``READ_METADATA``, or ``MANAGE`` on it, plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the parent schema.

Lists the agent services in a Unity Catalog schema. Provide ``parent`` as ``schemas/{catalog}.{schema}``. Results are paginated; pass the returned ``next_page_token`` to fetch subsequent pages. Requires ``USE_CATALOG`` on the parent catalog and...

Lists the MCP services in a Unity Catalog schema. Provide ``parent`` as ``schemas/{catalog}.{schema}``. Results are paginated; pass the returned ``next_page_token`` to fetch subsequent pages. Requires ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA``...

Lists the model provider services in a Unity Catalog schema. Provide ``parent`` as ``schemas/{catalog}.{schema}``. Results are paginated; pass the returned ``next_page_token`` to fetch subsequent pages. Requires ``USE_CATALOG`` on the parent catalog and...

Lists the model services in a Unity Catalog schema. Provide ``parent`` as ``schemas/{catalog}.{schema}``. Results are paginated; pass the returned ``next_page_token`` to fetch subsequent pages. Requires ``USE_CATALOG`` on the parent catalog and...

Updates an agent service. Only the fields named in ``update_mask`` are changed; the resource name and agent service type are immutable. Optionally supply an ``etag`` to make the update conditional on the agent service not having changed since it was read...

Updates an MCP service. Only the fields named in ``update_mask`` are changed; the resource name is immutable. Optionally supply an ``etag`` to make the update conditional on the MCP service not having changed since it was read. You must be the owner of the...

Updates a model provider service. Only the fields named in ``update_mask`` are changed; the resource name and provider type are immutable. Optionally supply an ``etag`` to make the update conditional on the model provider service not having changed since it...

Updates a model service. Only the fields named in ``update_mask`` are changed; the resource name is immutable. Optionally supply an ``etag`` to make the update conditional on the model service not having changed since it was read. You must be the owner of...

Create a new AI Search endpoint. POST /api/2.0/ai-search/{parent}/endpoints on Databricks. Requires parent.

Create a new AI Search index. POST /api/2.0/ai-search/{parent}/indexes on Databricks. Requires parent.

DESTRUCTIVE - Delete an AI Search endpoint.

DESTRUCTIVE - Delete an AI Search index.

Get details for a single AI Search endpoint.

Get details for a single AI Search index.

List AI Search endpoints in a workspace.

List AI Search indexes on an endpoint. GET /api/2.0/ai-search/{parent}/indexes on Databricks. Requires parent.

Query (search) an AI Search index. Read-only, so a read-scoped token may invoke it.

DESTRUCTIVE - Remove rows by primary key from a Direct Access AI Search index.

Scan (paginate over) the rows of an AI Search index.

Synchronize a Delta Sync AI Search index with its source Delta table. Applies only to Delta Sync indexes; Direct Access indexes are written via the data-plane upsert path.

Update an existing AI Search endpoint. Multi-bucket masks are supported and dispatched in deterministic bucket order: budget policy, custom tags, throughput, then scaling/replicas. Per-bucket dispatch is not atomic across buckets — if a later bucket fails...

Upsert rows into a Direct Access AI Search index.

DESTRUCTIVE - Delete the AI/BI dashboard embedding access policy, reverting back to the default.

Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains.

Updates the AI/BI dashboard embedding access policy at the workspace level.

DESTRUCTIVE - Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default empty list.

Retrieves the list of domains approved to host embedded AI/BI dashboards.

Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS.

Creates an alert. POST /api/2.0/sql/alerts on Databricks.

DESTRUCTIVE - Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.

Gets an alert. GET /api/2.0/sql/alerts/{id} on Databricks. Requires id.

Creates an alert. An alert is a Databricks SQL object that periodically runs a query, evaluates a condition of its result, and notifies users or notification destinations if the condition was met. **Warning**: This API is deprecated. Please use...

DESTRUCTIVE - Deletes an alert. Deleted alerts are no longer accessible and cannot be restored. **Note**: Unlike queries and dashboards, alerts cannot be moved to the trash. **Warning**: This API is deprecated. Please use :method:alerts/delete instead. `Learn...

Gets an alert. **Warning**: This API is deprecated. Please use :method:alerts/get instead. `Learn more `__

Gets a list of alerts. **Warning**: This API is deprecated. Please use :method:alerts/list instead. `Learn more `__

Updates an alert. **Warning**: This API is deprecated. Please use :method:alerts/update instead. `Learn more `__

Gets a list of alerts accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.

Updates an alert. PATCH /api/2.0/sql/alerts/{id} on Databricks. Requires id, update_mask.

Create Alert. POST /api/2.0/alerts on Databricks.

Gets an alert. GET /api/2.0/alerts/{id} on Databricks. Requires id.

Gets a list of alerts accessible to the user, ordered by creation time.

DESTRUCTIVE - Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.

Update alert. PATCH /api/2.0/alerts/{id} on Databricks. Requires id, update_mask.

Creates a new app. POST /api/2.0/apps on Databricks.

Creates a new app space. POST /api/2.0/app-spaces on Databricks.

Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method.

DESTRUCTIVE — Deletes an app. DELETE /api/2.0/apps/{name} on Databricks. Requires name.

DESTRUCTIVE - Deletes the thumbnail for an app.

DESTRUCTIVE — Deletes an app space. DELETE /api/2.0/app-spaces/{name} on Databricks. Requires name.

Creates an app deployment for the app with the supplied name.

Retrieves information for the app with the supplied name.

Retrieves information for the app deployment with the supplied name and deployment id.

Gets the permission levels that a user can have on an object.

Gets the permissions of an app. Apps can inherit permissions from their root object.

Retrieves information for the app space with the supplied name.

Gets the status of an app space update operation.

Gets the status of an app update. GET /api/2.0/apps/{app_name}/update on Databricks. Requires app_name.

Lists all apps in the workspace. GET /api/2.0/apps on Databricks.

Lists all app deployments for the app with the supplied name.

Lists all app spaces in the workspace. GET /api/2.0/app-spaces on Databricks.

Creates a custom template. POST /api/2.0/apps-settings/templates on Databricks.

DESTRUCTIVE - Deletes the custom template with the specified name.

Gets the custom template with the specified name.

Lists all custom templates in the workspace.

Updates the custom template with the specified name. Note that the template name cannot be updated.

Start the last active deployment of the app in the workspace.

Stops the active deployment of the app in the workspace.

Updates the app with the supplied name. PATCH /api/2.0/apps/{name} on Databricks. Requires name.

Updates the thumbnail for an app. PATCH /api/2.0/apps/{name}/thumbnail on Databricks. Requires name.

Updates an app space. The update process is asynchronous and the status of the update can be checked with the GetSpaceOperation method.

Gets the automatic cluster update setting.

Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in ``PATCH`` requests (as part of the setting field). The etag can be retrieved by making a ``GET`` request before the ``PATCH`` request. If the setting is...

Marks a version as complete and releases the deployment lock. The server atomically: 1. Sets the version status to the provided terminal status. 2. Sets `complete_time` to the current server timestamp. 3. Releases the lock on the parent deployment. 4...

Creates a new deployment in the workspace. The caller must provide a `deployment_id` which becomes the final component of the deployment's resource name. If a deployment with the same ID already exists, the server returns `ALREADY_EXISTS`.

Creates a resource operation under a version. The caller must provide a `resource_key` which becomes the final component of the operation's name. If an operation with the same key already exists under the version, the server returns `ALREADY_EXISTS`. On...

Creates a new version under a deployment. Creating a version acquires an exclusive lock on the deployment, preventing concurrent deploys. The caller provides a `version_id` which the server validates equals `last_version_id + 1` on the deployment.

DESTRUCTIVE - Deletes a deployment. The deployment is marked as deleted. It and all its children (versions and their operations) will be permanently deleted after the retention policy expires. If the deployment has an in-progress version, the server returns...

Marks a version as complete and releases the deployment lock. The server atomically: 1. Sets the version status to the provided terminal status. 2. Sets ``complete_time`` to the current server timestamp. 3. Releases the lock on the parent deployment. 4...

Creates a new deployment in the workspace.

Creates a new version under a deployment. Creating a version acquires an exclusive lock on the deployment, preventing concurrent deploys. The caller provides a ``version_id``, a numeric string that must be numerically greater than the deployment's most...

DESTRUCTIVE — Deletes a deployment. DELETE /api/2.0/bundle/{name} on Databricks. Requires name.

Retrieves a deployment by its resource name.

Retrieves a resource operation by its resource name.

Retrieves a deployment resource by its resource name.

Retrieves a version by its resource name.

Sends a heartbeat to renew the lock held by a version. The server validates that the version is the active (non-terminal) version on the parent deployment and resets the lock expiry. If the lock has already expired or the version is no longer active, the...

Lists deployments in the workspace. GET /api/2.0/bundle/deployments on Databricks.

Lists resource operations under a version.

Lists resources under a deployment. GET /api/2.0/bundle/{parent}/resources on Databricks. Requires parent.

Lists versions under a deployment, ordered numerically by version_id descending (most recent first).

Updates a resource operation's mutable fields. ``state``, ``error_message``, ``resource_id``, ``status``, and ``dashboard_metadata`` may be updated, independently; ``update_mask`` must contain only those paths. All other fields are immutable. The update is...

Retrieves a deployment by its resource name.

Retrieves a resource operation by its resource name.

Retrieves a deployment resource by its resource name.

Retrieves a version by its resource name.

Sends a heartbeat to renew the lock held by a version. The server validates that the version is the active (non-terminal) version on the parent deployment and resets the lock expiry. If the lock has already expired or the version is no longer active, the...

Lists deployments in the workspace. GET /api/2.0/bundle/deployments on Databricks.

Lists resource operations under a version.

Lists resources under a deployment. GET /api/2.0/bundle/{parent}/resources on Databricks. Requires parent.

Lists versions under a deployment, ordered by version_id descending (most recent first).

Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the **CREATE_CATALOG** privilege.

DESTRUCTIVE - Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog.

Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the catalog, or a user that has the **USE_CATALOG** privilege set for their account.

Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs will be retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has the **USE_CATALOG** privilege) will be retrieved. There is no...

Updates the catalog that matches the supplied name. The caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog).

Create a clean room asset —share an asset like a notebook or table into the clean room. For each UC asset that is added through this method, the clean room owner must also have enough privilege on the asset to consume it. The privilege must be maintained...

List assets. GET /api/2.0/clean-rooms/{clean_room_name}/assets on Databricks. Requires clean_room_name.

Create an auto-approval rule. POST /api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules on Databricks. Requires clean_room_name, auto_approval_rule.

DESTRUCTIVE - Delete a auto-approval rule by rule ID

Get a auto-approval rule by rule ID. GET /api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules/{rule_id} on Databricks. Requires clean_room_name, rule_id.

List all auto-approval rules for the caller

Update a auto-approval rule by rule ID. PATCH /api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules/{rule_id} on Databricks. Requires clean_room_name, rule_id.

List all the historical notebook task runs in a clean room.

List all the historical task runs in a clean room.

Create a new clean room with the specified collaborators. This method is asynchronous; the returned name field inside the clean_room field can be used to poll the clean room status, using the `cleanrooms/get `__ method. When this method returns, the clean...

Create the output catalog of the clean room.

DESTRUCTIVE - Delete a clean room. After deletion, the clean room will be removed from the metastore. If the other collaborators have not deleted the clean room, they will still have the clean room in their metastore, but it will be in a DELETED state and no...

Get the details of a clean room given its name.

Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are returned.

Update a clean room. The caller must be the owner of the clean room, have **MODIFY_CLEAN_ROOM** privilege, or be metastore admin. When the caller is a metastore admin, only the **owner** field can be updated.

Creates a new policy with prescribed settings.

DESTRUCTIVE - Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.

Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.

Get a cluster policy entity. Creation and editing is available to admins only.

Gets the permission levels that a user can have on an object.

Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root object.

Returns a list of policies accessible by the requesting user.

Change the owner of the cluster. You must be an admin and the cluster must be terminated to perform this operation. The service principal application ID can be supplied as an argument to ``owner_username``.

Creates a new Spark cluster. This method will acquire new instances from the cloud provider if necessary. This method is asynchronous; the returned ``cluster_id`` can be used to poll the cluster status. When this method returns, the cluster will be in a...

DESTRUCTIVE - Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once the termination has completed, the cluster will be in a ``TERMINATED`` state. If the cluster is already in a ``TERMINATING`` or ``TERMINATED`` state...

Updates the configuration of a cluster to match the provided attributes and size. A cluster can be updated if it is in a ``RUNNING`` or ``TERMINATED`` state. If a cluster is updated while in a ``RUNNING`` state, it will be restarted so that the new...

Retrieves a list of events about the activity of a cluster. This API is paginated. If there are more events to read, the response includes all the parameters necessary to request the next page of events.

Retrieves the information for a cluster given its identifier. Clusters can be described while they are running, or up to 60 days after they are terminated.

Returns the most recent cluster diagnostics result for a cluster. Cluster diagnostics are a set of environment checks -- for example, network reachability to the control plane, storage, DNS, and the SCC tunnel -- that verify the cluster's environment is set...

Gets the permission levels that a user can have on an object.

Gets the permissions of a cluster. Clusters can inherit permissions from their root object.

Return information about all pinned and active clusters, and all clusters terminated within the last 30 days. Clusters terminated prior to this period are not included.

Returns a list of supported Spark node types. These node types can be used to launch a cluster.

Returns a list of availability zones where clusters can be created in (For example, us-west-2a). These zones can be used to launch a cluster.

DESTRUCTIVE - Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously removed. In addition, users will no longer see permanently deleted clusters in the cluster list, and API users can no longer perform any action on...

Pinning a cluster ensures that the cluster will always be returned by the ListClusters API. Pinning a cluster that is already pinned will have no effect. This API can only be called by workspace admins.

Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a ``RUNNING`` state.

DESTRUCTIVE - Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a ``RUNNING`` state, nothing will happen.

Returns the list of available Spark versions. These versions can be used to launch a cluster.

Starts a terminated Spark cluster with the supplied ID. This works similar to ``createCluster`` except: - The previous cluster id and attributes are preserved. - The cluster starts with the last specified cluster size. - If the previous cluster was an...

Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API. Unpinning a cluster that is not pinned will have no effect. This API can only be called by workspace admins.

Updates the configuration of a cluster to match the partial set of attributes and size. Denote which fields to update using the ``update_mask`` field in the request body. A cluster can be updated if it is in a ``RUNNING`` or ``TERMINATED`` state. If a...

Gets the compliance security profile setting.

Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided in ``PATCH`` requests (as part of the setting field). The etag can be retrieved by making a ``GET`` request before the ``PATCH`` request. If the setting is...

Creates a new connection Creates a new connection to an external data source. It allows users to specify connection details and configurations for interaction with the external server.

DESTRUCTIVE - Deletes the connection that matches the supplied name.

Gets a connection from it's name. GET /api/2.1/unity-catalog/connections/{name} on Databricks. Requires name.

List all connections. NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still...

Updates the connection that matches the supplied name.

Get a high level preview of the metadata of listing installable content.

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...

Install payload associated with a Databricks Marketplace listing.

DESTRUCTIVE - Uninstall an installation associated with a Databricks Marketplace listing.

List all installations across all listings.

List all installations for a particular listing.

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 1. the token will be rotate if the rotateToken flag is...

Batch get a published listing in the Databricks Marketplace that the consumer has access to.

Get a published listing in the Databricks Marketplace that the consumer has access to.

List all published listings in the Databricks Marketplace that the consumer has access to.

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.

Create a personalization request for a listing.

Get the personalization request for a listing. Each consumer can make at *most* one personalization request for a listing.

List personalization requests for a consumer across all listings.

Batch get a provider in the Databricks Marketplace with at least one visible listing.

Get a provider in the Databricks Marketplace with at least one visible listing.

List all providers in the Databricks Marketplace with at least one visible listing.

Creates a new credential. The type of credential to be created is determined by the **purpose** field, which should be either **SERVICE** or **STORAGE**. The caller must be a metastore admin or have the metastore privilege **CREATE_STORAGE_CREDENTIAL** for...

DESTRUCTIVE - Deletes a service or storage credential from the metastore. The caller must be an owner of the credential.

Returns a set of temporary credentials generated using the specified service credential. The caller must be a metastore admin or have the metastore privilege **ACCESS** on the service credential.

Gets a service or storage credential from the metastore. The caller must be a metastore admin, the owner of the credential, or have any permission on the credential.

Gets an array of credentials (as **CredentialInfo** objects). The array is limited to only the credentials that the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a...

Exchange tokens with an Identity Provider to get a new access token. It allows specifying scopes to determine token permissions. POST /exchange-tokens/token is the documented public form, expressed via ``google.api.http`` below. GET...

Updates a service or storage credential on the metastore. The caller must be the owner of the credential or a metastore admin or have the ``MANAGE`` permission. If the caller is a metastore admin, only the **owner** field can be changed.

Validates a credential. For service credentials (purpose is **SERVICE**), either the **credential_name** or the cloud-specific credential must be provided. For storage credentials (purpose is **STORAGE**), at least one of **external_location_name** and...

Get details about the current method caller's identity.

DESTRUCTIVE - Reverts the Dashboard Email Subscriptions setting to its default value.

Gets the Dashboard Email Subscriptions setting.

Updates the Dashboard Email Subscriptions setting.

Adds a widget to a dashboard. POST /api/2.0/preview/sql/widgets on Databricks. Requires dashboard_id, options, width.

DESTRUCTIVE - Removes a widget from a dashboard

Updates an existing widget. POST /api/2.0/preview/sql/widgets/{id} on Databricks. Requires id, dashboard_id, options, width.

DESTRUCTIVE - Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot be shared. **Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. `Learn more `__

Returns a JSON representation of a dashboard object, including its visualization and query objects. **Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. `Learn more `__

Fetch a paginated list of dashboard objects. **Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban. **Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead...

A restored dashboard appears in list views and searches and can be shared. **Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. `Learn more `__

Modify this dashboard definition. This operation only affects attributes of the dashboard object. It does not add, modify, or remove widgets. **Note**: You cannot undo this operation. **Warning**: This API is deprecated. Please use the AI/BI Dashboards API...

Create Data Classification configuration for a catalog. Creates a new config resource, which enables Data Classification for the specified catalog. - The config must not already exist for the catalog.

DESTRUCTIVE - Delete Data Classification configuration for a catalog.

Get the Data Classification configuration for a catalog.

Update the Data Classification configuration for a catalog. - The config must already exist for the catalog. - Updates fields specified in the update_mask. Use update_mask field to perform partial updates of the configuration.

DESTRUCTIVE - Cancels a data quality monitor refresh. Currently only supported for the ``table`` ``object_type``. The call must be made in the same workspace as where the monitor was created. The caller must have either of the following sets of permissions...

Create a data quality monitor on a Unity Catalog object. The caller must provide either ``anomaly_detection_config`` for a schema monitor or ``data_profiling_config`` for a table monitor. For the ``table`` ``object_type``, the caller must have either of the...

Creates a refresh. Currently only supported for the ``table`` ``object_type``. The call must be made in the same workspace as where the monitor was created. The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG**...

DESTRUCTIVE - Delete a data quality monitor on Unity Catalog object. For the ``table`` ``object_type``, the caller must have either of the following sets of permissions: **MANAGE** and **USE_CATALOG** on the table's parent catalog. **USE_CATALOG** on the...

DESTRUCTIVE - (Unimplemented) Delete a refresh

Read a data quality monitor on a Unity Catalog object. For the ``table`` ``object_type``, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's...

Get data quality monitor refresh. The call must be made in the same workspace as where the monitor was created. For the ``table`` ``object_type``, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the...

(Unimplemented) List data quality monitors.

List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created. For the ``table`` ``object_type``, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the...

Update a data quality monitor on Unity Catalog object. For the ``table`` ``object_type``, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's...

(Unimplemented) Update a refresh. PATCH /api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes/{refresh_id} on Databricks. Requires object_type, object_id, refresh_id, update_mask.

Retrieves a full list of SQL warehouses available in this workspace. All fields that appear in this API response are enumerated for clarity. However, you need only a SQL warehouse's ``id`` to create new queries against it. **Warning**: This API is...

Create a Database Catalog. POST /api/2.0/database/catalogs on Databricks.

Create a Database Instance. POST /api/2.0/database/instances on Databricks.

Create a role for a Database Instance. POST /api/2.0/database/instances/{instance_name}/roles on Databricks. Requires instance_name.

Create a Database Table. Useful for registering pre-existing PG tables in UC. See CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC.

Create a Synced Database Table. POST /api/2.0/database/synced_tables on Databricks.

DESTRUCTIVE - Delete a Database Catalog.

DESTRUCTIVE - Delete a Database Instance.

DESTRUCTIVE - Deletes a role for a Database Instance.

DESTRUCTIVE — Delete a Database Table. DELETE /api/2.0/database/tables/{name} on Databricks. Requires name.

DESTRUCTIVE - Delete a Synced Database Table.

Failover the primary node of a Database Instance to a secondary.

Find a Database Instance by uid. GET /api/2.0/database/instances:findByUid on Databricks.

Generates a credential that can be used to access database instances.

Get a Database Catalog. GET /api/2.0/database/catalogs/{name} on Databricks. Requires name.

Get a Database Instance. GET /api/2.0/database/instances/{name} on Databricks. Requires name.

Gets a role for a Database Instance. GET /api/2.0/database/instances/{instance_name}/roles/{name} on Databricks. Requires instance_name, name.

Get a Database Table. GET /api/2.0/database/tables/{name} on Databricks. Requires name.

Get a Synced Database Table. GET /api/2.0/database/synced_tables/{name} on Databricks. Requires name.

This API is currently unimplemented, but exposed for Terraform support.

START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage < PUBLIC_PREVIEW. With more recent Lakebase V2 plans, we don't plan to ever advance these to PUBLIC_PREVIEW. These APIs will remain effectively undocumented/UI-only and we'll aim for a...

List Database Instances. GET /api/2.0/database/instances on Databricks.

This API is currently unimplemented, but exposed for Terraform support.

This API is currently unimplemented, but exposed for Terraform support.

Update a Database Instance. PATCH /api/2.0/database/instances/{name} on Databricks. Requires name, update_mask.

Update a role for a Database Instance. PATCH /api/2.0/database/instances/{instance_name}/roles/{name} on Databricks. Requires instance_name, name.

This API is currently unimplemented, but exposed for Terraform support.

Upgrade a Database Instance to Autoscaling.

Appends a block of data to the stream specified by the input handle. If the handle does not exist, this call will throw an exception with ``RESOURCE_DOES_NOT_EXIST``. If the block of data exceeds 1 MB, this call will throw an exception with...

Closes the stream specified by the input handle. If the handle does not exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``.

Opens a stream to write to a file and returns a handle to this stream. There is a 10 minute idle timeout on this handle. If a file or directory already exists on the given path and **overwrite** is set to false, this call will throw an exception with...

DESTRUCTIVE - Delete the file or directory (optionally recursively delete all files in the directory). This call throws an exception with ``IO_ERROR`` if the path is a non-empty directory and ``recursive`` is set to ``false`` or on other similar errors. When...

Gets the file information for a file or directory. If the file or directory does not exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``.

List the contents of a directory, or details of the file. If the file or directory does not exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``. When calling list on a large directory, the list operation will time out after approximately...

Creates the given directory and necessary parent directories if they do not exist. If a file (not a directory) exists at any prefix of the input path, this call throws an exception with ``RESOURCE_ALREADY_EXISTS``. **Note**: If this operation fails, it...

Moves a file from one location to another location within DBFS. If the source file does not exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``. If a file already exists in the destination path, this call throws an exception with...

Uploads a file through the use of multipart form post. It is mainly used for streaming uploads, but can also be used as a convenient single call for data upload. Alternatively you can pass contents as base64 string. The amount of data that can be passed...

Returns the contents of a file. If the file does not exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``. If the path is a directory, the read length is negative, or if the offset is negative, this call throws an exception with...

DESTRUCTIVE - Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in ``DELETE`` requests (as a query parameter). The etag can be retrieved by making a ``GET`` request before the ``DELETE`` request. If the setting is...

Gets the default namespace setting. GET /api/2.0/settings/types/default_namespace_ws/names/default on Databricks.

Updates the default namespace setting for the workspace. A fresh etag needs to be provided in ``PATCH`` requests (as part of the setting field). The etag can be retrieved by making a ``GET`` request before the ``PATCH`` request. Note that if the setting...

DESTRUCTIVE - Reverts the Default Warehouse Id setting to its default value.

Gets the Default Warehouse Id setting. GET /api/2.0/settings/types/default_warehouse_id/names/default on Databricks.

Updates the Default Warehouse Id setting.

DESTRUCTIVE - Deletes legacy access disablement status.

Retrieves legacy access disablement Status.

Updates legacy access disablement status.

DESTRUCTIVE - Deletes the disable legacy DBFS setting for a workspace, reverting back to the default.

Gets the disable legacy DBFS setting. GET /api/2.0/settings/types/disable_legacy_dbfs/names/default on Databricks.

Updates the disable legacy DBFS setting for the workspace.

Create a new failover group. POST /api/disaster-recovery/v1/{parent}/failover-groups on Databricks. Requires parent, failover_group_id.

Create a new stable URL. POST /api/disaster-recovery/v1/{parent}/stable-urls on Databricks. Requires parent, stable_url_id.

DESTRUCTIVE — Delete a failover group. DELETE /api/disaster-recovery/v1/{name} on Databricks. Requires name.

DESTRUCTIVE — Delete a stable URL. DELETE /api/disaster-recovery/v1/{name} on Databricks. Requires name.

Initiate a failover to a new primary region.

Get a failover group. GET /api/disaster-recovery/v1/{name} on Databricks. Requires name.

Get a stable URL. GET /api/disaster-recovery/v1/{name} on Databricks. Requires name.

List failover groups. List entries are abbreviated: ``state`` and ``replication_point`` are not populated. Call GetFailoverGroup to retrieve the full resource.

List stable URLs for an account. GET /api/disaster-recovery/v1/{parent}/stable-urls on Databricks. Requires parent.

Update a failover group. PATCH /api/disaster-recovery/v1/{name} on Databricks. Requires name, update_mask.

Gets the Notebook and File exporting setting.

Updates the Notebook and File exporting setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.

Gets the Results Table Clipboard features setting.

Updates the Results Table Clipboard features setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.

Gets the Notebook results download setting.

Updates the Notebook results download setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.

Creates a new network connectivity endpoint that enables private connectivity between your network resources and Databricks services. After creation, the endpoint is initially in the PENDING state. The Databricks endpoint service automatically reviews and...

DESTRUCTIVE - Deletes a network endpoint. This will remove the endpoint configuration from Databricks. Depending on the endpoint type and use case, you may also need to delete corresponding network resources in your cloud provider account.

Gets details of a specific network endpoint.

Lists all network connectivity endpoints for the account.

Gets the enhanced security monitoring setting.

Updates the enhanced security monitoring setting for the workspace. A fresh etag needs to be provided in ``PATCH`` requests (as part of the setting field). The etag can be retrieved by making a ``GET`` request before the ``PATCH`` request. If the setting is...

Creates a tag assignment for an Unity Catalog entity. To add tags to Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema - **USE CATALOG** on the...

DESTRUCTIVE - Deletes a tag assignment for an Unity Catalog entity by its key. To delete tags from Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE_SCHEMA** on the entity's parent schema...

Gets a tag assignment for an Unity Catalog entity by tag key.

List tag assignments for an Unity Catalog entity PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the...

Updates an existing tag assignment for an Unity Catalog entity. To update tags to Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema - **USE...

Retrieves multiple WorkspaceBaseEnvironments by name in a single call. The operation is atomic: it either returns all of the requested environments or fails.

Creates a new WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously generate a materialized environment to optimize dependency resolution and is only marked as done when the materialized environment has been...

DESTRUCTIVE - Deletes a WorkspaceBaseEnvironment. Deleting a base environment may impact linked notebooks and jobs. This operation is irreversible and should be performed only when you are certain the environment is no longer needed.

Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current default base environment settings for both CPU and GPU compute.

Gets the status of a long-running operation. Clients can use this method to poll the operation result.

Retrieves a WorkspaceBaseEnvironment by its name.

Lists all WorkspaceBaseEnvironments in the workspace. Databricks provides the following base environments: - ``workspace-base-environments/databricks_ai_...``: includes popular AI and deep learning packages for serverless GPU compute. -...

Refreshes the materialized environment for a WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been...

Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the specified base environments as the workspace defaults for CPU and/or GPU compute.

Updates an existing WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has...

Creates an experiment with a name. Returns the ID of the newly created experiment. Validates that another experiment with the same name does not already exist and fails if another experiment with the same name already exists. Throws...

Create a logged model. POST /api/2.0/mlflow/logged-models on Databricks. Requires experiment_id.

Creates a new run within an experiment. A run is usually a single execution of a machine learning or data ETL pipeline. MLflow uses runs to track the ``mlflowParam``, ``mlflowMetric``, and ``mlflowRunTag`` associated with a single execution.

DESTRUCTIVE - Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If the experiment uses FileStore, artifacts associated with the experiment are also deleted.

DESTRUCTIVE — Delete a logged model. DELETE /api/2.0/mlflow/logged-models/{model_id} on Databricks. Requires model_id.

DESTRUCTIVE - Delete a tag on a logged model.

DESTRUCTIVE — Marks a run for deletion. POST /api/2.0/mlflow/runs/delete on Databricks. Requires run_id.

DESTRUCTIVE - Bulk delete runs in an experiment that were created prior to or at the specified timestamp. Deletes at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on

DESTRUCTIVE - Deletes a tag on a run. Tags are run metadata that can be updated during a run and after a run completes.

Finalize a logged model. PATCH /api/2.0/mlflow/logged-models/{model_id} on Databricks. Requires model_id, status.

Gets metadata for an experiment. This endpoint will return deleted experiments, but prefers the active experiment if an active and deleted experiment share the same name. If multiple deleted experiments share the same name, the API will return one of them...

Gets metadata for an experiment. This method works on deleted experiments.

Gets a list of all values for the specified metric for a given run.

Get a logged model. GET /api/2.0/mlflow/logged-models/{model_id} on Databricks. Requires model_id.

Batch endpoint for getting logged models from a list of model IDs

Gets the permission levels that a user can have on an object.

Gets the permissions of an experiment. Experiments can inherit permissions from their root object.

Gets the metadata, metrics, params, and tags for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp. If there are multiple values with the latest timestamp, return the maximum of...

List artifacts for a run. Takes an optional ``artifact_path`` prefix which if specified, the response contains only artifacts with the specified prefix. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call...

Gets a list of all experiments. GET /api/2.0/mlflow/experiments/list on Databricks.

Logs a batch of metrics, params, and tags for a run. If any data failed to be persisted, the server will respond with an error (non-200 status code). In case of error (due to internal server error or an invalid request), partial data may be written. You can...

Logs inputs, such as datasets and models, to an MLflow Run.

Logs params for a logged model. A param is a key-value pair (string key, string value). Examples include hyperparameters used for ML model training. A param can be logged only once for a logged model, and attempting to overwrite an existing param with a...

Log a metric for a run. A metric is a key-value pair (string key, float value) with an associated timestamp. Examples include the various metrics that represent ML model accuracy. A metric can be logged multiple times.

**Note:** the [Create a logged model](/api/workspace/experiments/createloggedmodel) API replaces this endpoint. Log a model to an MLflow Run.

Logs outputs, such as models, from an MLflow Run.

Logs a param used for a run. A param is a key-value pair (string key, string value). Examples include hyperparameters used for ML model training and constant dates and values used in an ETL pipeline. A param can be logged only once for a run.

Restore an experiment marked for deletion. This also restores associated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with experiment are also restored. Throws ``RESOURCE_DOES_NOT_EXIST`` if...

Restores a deleted run. This also restores associated metadata, runs, metrics, params, and tags. Throws ``RESOURCE_DOES_NOT_EXIST`` if the run was never created or was permanently deleted.

Bulk restore runs in an experiment that were deleted no earlier than the specified timestamp. Restores at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on

Searches for experiments that satisfy specified search criteria.

Search for Logged Models that satisfy specified search criteria.

Searches for runs that satisfy expressions. Search expressions can use ``mlflowMetric`` and ``mlflowParam`` keys.

Sets a tag on an experiment. Experiment tags are metadata that can be updated.

Set tags for a logged model. PATCH /api/2.0/mlflow/logged-models/{model_id}/tags on Databricks. Requires model_id.

Sets a tag on a run. Tags are run metadata that can be updated during a run and after a run completes.

Updates experiment metadata. POST /api/2.0/mlflow/experiments/update on Databricks. Requires experiment_id.

Updates run metadata. POST /api/2.0/mlflow/runs/update on Databricks.

Creates an external lineage relationship between a Databricks or external metadata object and another external metadata object.

DESTRUCTIVE - Deletes an external lineage relationship between a Databricks or external metadata object and another external metadata object.

Lists external lineage relationships of a Databricks object or external metadata given a supplied direction.

Updates an external lineage relationship between a Databricks or external metadata object and another external metadata object.

Creates a new external location entry in the metastore. The caller must be a metastore admin or have the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated storage credential.

DESTRUCTIVE - Deletes the specified external location from the metastore. The caller must be the owner of the external location.

Gets an external location from the metastore. The caller must be either a metastore admin, the owner of the external location, or a user that has some privilege on the external location.

Gets an array of external locations (**ExternalLocationInfo** objects) from the metastore. The caller must be a metastore admin, the owner of the external location, or a user that has some privilege on the external location. There is no guarantee of a...

Updates an external location in the metastore. The caller must be the owner of the external location, or be a metastore admin. In the second case, the admin can only update the name of the external location.

Creates a new external metadata object in the parent metastore if the caller is a metastore admin or has the **CREATE_EXTERNAL_METADATA** privilege. Grants **BROWSE** to all account users upon creation by default.

DESTRUCTIVE - Deletes the external metadata object that matches the supplied name. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MANAGE** privilege.

Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **BROWSE** privilege.

Gets an array of external metadata objects in the metastore. If the caller is the metastore admin, all external metadata objects will be retrieved. Otherwise, only external metadata objects that the caller has **BROWSE** on will be retrieved. There is no...

Updates the external metadata object that matches the supplied name. The caller can only update either the owner or other metadata fields in one request. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the...

Batch create materialized features. POST /api/2.0/feature-engineering/materialized-features:batchCreate on Databricks. Requires requests.

Create a Feature. POST /api/2.0/feature-engineering/features on Databricks.

Create a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.

Create a materialized feature. POST /api/2.0/feature-engineering/materialized-features on Databricks.

Create a Stream, a governed UC entity representing an external streaming data source.

DESTRUCTIVE — Delete a Feature. DELETE /api/2.0/feature-engineering/features/{full_name} on Databricks. Requires full_name.

DESTRUCTIVE - Delete a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.

DESTRUCTIVE - Delete a materialized feature.

DESTRUCTIVE - Delete a Stream by its full three-part name (catalog.schema.stream).

Get a Feature. GET /api/2.0/feature-engineering/features/{full_name} on Databricks. Requires full_name.

Get a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.

Get a materialized feature. GET /api/2.0/feature-engineering/materialized-features/{materialized_feature_id} on Databricks. Requires materialized_feature_id.

Get a Stream by its full three-part name (catalog.schema.stream).

List Features. GET /api/2.0/feature-engineering/features on Databricks. Requires catalog_name, schema_name.

List Kafka configs. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.

List materialized features. GET /api/2.0/feature-engineering/materialized-features on Databricks.

List Streams under a given catalog.schema parent.

Update a Feature. PATCH /api/2.0/feature-engineering/features/{full_name} on Databricks. Requires full_name, update_mask.

Update a Kafka config. During PrPr, Kafka configs can be read and used when creating features under the entire metastore. Only the creator of the Kafka config can delete it.

Update a materialized feature (pause/resume).

Update a Stream. Only fields listed in ``update_mask`` are mutated.

Create an Online Feature Store. POST /api/2.0/feature-store/online-stores on Databricks.

DESTRUCTIVE - Delete an Online Feature Store.

DESTRUCTIVE — Delete online table. DELETE /api/2.0/feature-store/online-tables/{online_table_name} on Databricks. Requires online_table_name.

Get an Online Feature Store. GET /api/2.0/feature-store/online-stores/{name} on Databricks. Requires name.

List Online Feature Stores. GET /api/2.0/feature-store/online-stores on Databricks.

Publish features. POST /api/2.0/feature-store/tables/{source_table_name}/publish on Databricks. Requires source_table_name, publish_spec.

Update an Online Feature Store. PATCH /api/2.0/feature-store/online-stores/{name} on Databricks. Requires name, update_mask.

Creates a serverless forecasting experiment. Returns the experiment ID.

Public RPC to get forecasting experiment

**WARNING: This API is experimental and will change in future versions** Creates a new function The user must have the following permissions in order for the function to be created: - **USE_CATALOG** on the function's parent catalog - **USE_SCHEMA** and...

DESTRUCTIVE - Deletes the function that matches the supplied name. For the deletion to succeed, the user must satisfy one of the following conditions: - Is the owner of the function's parent catalog - Is the owner of the function's parent schema and have...

Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must satisfy one of the following requirements: - Is a metastore admin - Is an owner of the function's parent catalog - Have the **USE_CATALOG** privilege on the...

List functions within the specified parent catalog and schema. If the user is a metastore admin, all functions are returned in the output list. Otherwise, the user must have the **USE_CATALOG** privilege on the catalog and the **USE_SCHEMA** privilege on...

Updates the function that matches the supplied name. Only the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner. - Is a metastore admin - Is the owner of the...

Create new message in a [conversation](:method:genie/startconversation). The AI response uses all previously created messages in the conversation to respond.

Create a comment on a conversation message.

Creates a Genie space from a serialized payload.

DESTRUCTIVE — Delete a conversation. DELETE /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id} on Databricks. Requires space_id, conversation_id.

DESTRUCTIVE - Delete a conversation message.

Download a rendered image of a message visualization attachment. The response body is the raw PNG image, not a JSON payload. This is only available if the attachment is a visualization and the message status is ``COMPLETED``. This endpoint is not supported...

Execute the SQL for a message query attachment. Use this API when the query attachment has expired and needs to be re-executed.

DEPRECATED: Use [Execute Message Attachment Query](:method:genie/executemessageattachmentquery) instead.

Initiates a new SQL execution and returns a ``download_id`` and ``download_id_signature`` that you can use to track the progress of the download. The query result is stored in an external link and can be retrieved using the [Get Download Full Query...

Create and run evaluations for multiple benchmark questions in a Genie space.

Get details for evaluation results. GET /api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id}/results/{result_id} on Databricks. Requires space_id, eval_run_id, result_id.

Get evaluation run details. GET /api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id} on Databricks. Requires space_id, eval_run_id.

List evaluation results for a specific evaluation run.

Lists all evaluation runs in a space. GET /api/2.0/genie/spaces/{space_id}/eval-runs on Databricks. Requires space_id.

After [Generating a Full Query Result Download](:method:genie/generatedownloadfullqueryresult) and successfully receiving a ``download_id`` and ``download_id_signature``, use this API to poll the download progress. Both ``download_id`` and...

Get message from conversation. GET /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id} on Databricks. Requires space_id, conversation_id, message_id.

Get the result of SQL query if the message has a query attachment. This is only available if a message has a query attachment and the message status is ``EXECUTING_QUERY`` OR ``COMPLETED``.

DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.

DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.

Get details of a Genie Space. GET /api/2.0/genie/spaces/{space_id} on Databricks. Requires space_id.

List all comments across all messages in a conversation.

List messages in a conversation. GET /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages on Databricks. Requires space_id, conversation_id.

Get a list of conversations in a Genie Space.

List comments on a specific conversation message.

Get list of Genie Spaces. GET /api/2.0/genie/spaces on Databricks.

Send feedback for a message. POST /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/feedback on Databricks. Requires space_id, conversation_id, message_id, rating.

Start a new conversation. POST /api/2.0/genie/spaces/{space_id}/start-conversation on Databricks. Requires space_id, content.

DESTRUCTIVE - Move a Genie Space to the trash.

Updates a Genie space with a serialized payload.

DESTRUCTIVE - Deletes the specified Git credential.

Gets the Git credential with the specified credential ID.

Lists the calling user's Git credentials.

Creates a new global init script in this workspace.

DESTRUCTIVE - Deletes a global init script.

Gets all the details of a script, including its Base64-encoded contents.

Get a list of all global init scripts for this workspace. This returns all properties for each script but **not** the script contents. To retrieve the contents of a script, use the [get a global init script](:method:globalinitscripts/get) operation.

Updates a global init script, specifying only the fields to change. All fields are optional. Unspecified fields retain their current value.

Gets the permissions for a securable. Does not include inherited permissions. NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. PAGINATION BEHAVIOR: When using pagination (max_results...

Gets the effective permissions for a securable. Includes inherited permissions from any parent securables. NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. PAGINATION BEHAVIOR: When...

Lists the privilege assignments for a securable. Does not include inherited privileges. Paginated version of Get Permissions API.

Lists the effective privilege assignments for a securable. Includes inherited privileges. Paginated version of Get Effective Permissions API.

Creates a group in the Databricks workspace with a unique name, using the supplied group details.

DESTRUCTIVE - Deletes a group from the Databricks workspace.

Gets the information for a specific group in the Databricks workspace.

Gets all details of the groups associated with the Databricks workspace.

Partially updates the details of a group.

Updates the details of a group by replacing the entire group entity.

Creates a group in the Databricks workspace with a unique name, using the supplied group details.

DESTRUCTIVE - Deletes a group from the Databricks workspace.

Gets the information for a specific group in the Databricks workspace.

Gets all details of the groups associated with the Databricks workspace.

Partially updates the details of a group.

Updates the details of a group by replacing the entire group entity.

Creates a new instance pool using idle and ready-to-use cloud instances.

DESTRUCTIVE - Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously.

Modifies the configuration of an existing instance pool.

Retrieve the information for an instance pool based on its identifier.

Gets the permission levels that a user can have on an object.

Gets the permissions of an instance pool. Instance pools can inherit permissions from their root object.

Gets a list of instance pools with their statistics.

Registers an instance profile in Databricks. In the UI, you can then give users the permission to use this instance profile when launching clusters. This API is only available to admin users.

The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true: - Your role name and instance profile name do not match. The name is the part...

List the instance profiles that the calling user can use to launch a cluster. This API is available to all users.

DESTRUCTIVE - Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function. This API is only accessible to admin users.

Creates an IP access list for this workspace. A list can be an allow list or a block list. See the top of this file for a description of how the server treats allow lists and block lists at runtime. When creating or updating an IP access list: - For all...

DESTRUCTIVE - Deletes an IP access list, specified by its list ID.

Gets an IP access list, specified by its list ID.

Gets all IP access lists for the specified workspace.

Replaces an IP access list, specified by its ID. A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When replacing an IP access list: - For all allow...

Updates an existing IP access list, specified by its ID. A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When updating an IP access list: - For all...

DESTRUCTIVE - Cancels all active runs of a job. The runs are canceled asynchronously, so it doesn't prevent new runs from being started.

DESTRUCTIVE - Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when this request completes.

Create a new job. POST /api/2.2/jobs/create on Databricks.

DESTRUCTIVE — Deletes a job. POST /api/2.2/jobs/delete on Databricks. Requires job_id.

DESTRUCTIVE - Deletes a non-active run. Returns an error if the run is active.

Export and retrieve the job run task. GET /api/2.2/jobs/runs/export on Databricks. Requires run_id.

Retrieves the details for a single job. Large arrays in the results will be paginated when they exceed 100 elements. A request for a single job will return all properties for that job, and the first 100 elements of array properties (``tasks``...

Gets the permission levels that a user can have on an object.

Gets the permissions of a job. Jobs can inherit permissions from their root object.

Retrieves the metadata of a run. Large arrays in the results will be paginated when they exceed 100 elements. A request for a single run will return all properties for that run, and the first 100 elements of array properties (``tasks``, ``job_clusters``...

Retrieve the output and metadata of a single task run. When a notebook task returns a value through the ``dbutils.notebook.exit()`` call, you can use this endpoint to retrieve that value. Databricks restricts this API to returning the first 5 MB of the...

Retrieves a list of jobs. GET /api/2.2/jobs/list on Databricks.

List runs in descending order by end time. If a run has not finished, it falls back to start time.

Re-run one or more tasks. Tasks are re-run as part of the original job run. They use the current job and task settings, and can be viewed in the history for the original job run.

DESTRUCTIVE - Overwrite all settings for the given job. Use the [*Update* endpoint](:method:jobs/update) to update job settings partially.

Run a job and return the ``run_id`` of the triggered run.

Submit a one-time run. This endpoint allows you to submit a workload directly without creating a job. Runs submitted using this endpoint don’t display in the UI. Use the ``jobs/runs/get`` API to check the run state after the job is submitted. **Important:**...

Add, update, or remove specific settings of an existing job. Use the [*Reset* endpoint](:method:jobs/reset) to overwrite all job settings.

Creates an example for a Knowledge Assistant.

Creates a Knowledge Assistant. POST /api/2.1/knowledge-assistants on Databricks.

Creates a Knowledge Source under a Knowledge Assistant.

DESTRUCTIVE - Deletes an example from a Knowledge Assistant.

DESTRUCTIVE - Deletes a Knowledge Assistant.

DESTRUCTIVE - Deletes a Knowledge Source.

Gets an example from a Knowledge Assistant.

Gets a Knowledge Assistant. GET /api/2.1/{name} on Databricks. Requires name.

Gets a Knowledge Source. GET /api/2.1/{name} on Databricks. Requires name.

Gets the permission levels that a user can have on an object.

Gets the permissions of a knowledge assistant. Knowledge assistants can inherit permissions from their root object.

Lists examples under a Knowledge Assistant.

List Knowledge Assistants. GET /api/2.1/knowledge-assistants on Databricks.

Lists Knowledge Sources under a Knowledge Assistant.

Sync all non-index Knowledge Sources for a Knowledge Assistant (index sources do not require sync)

Updates an example in a Knowledge Assistant.

Updates a Knowledge Assistant. PATCH /api/2.1/{name} on Databricks. Requires name, update_mask.

Updates a Knowledge Source. PATCH /api/2.1/{name} on Databricks. Requires name, update_mask.

Create a draft dashboard. POST /api/2.0/lakeview/dashboards on Databricks.

Create dashboard schedule. POST /api/2.0/lakeview/dashboards/{dashboard_id}/schedules on Databricks. Requires dashboard_id.

Create schedule subscription. POST /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions on Databricks. Requires dashboard_id, schedule_id.

DESTRUCTIVE - Delete dashboard schedule.

DESTRUCTIVE - Delete schedule subscription.

Get the current published dashboard within an embedded context.

Get a required authorization details and scopes of a published dashboard to mint an OAuth token.

Get a draft dashboard. GET /api/2.0/lakeview/dashboards/{dashboard_id} on Databricks. Requires dashboard_id.

Get the current published dashboard. GET /api/2.0/lakeview/dashboards/{dashboard_id}/published on Databricks. Requires dashboard_id.

Get dashboard schedule. GET /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id} on Databricks. Requires dashboard_id, schedule_id.

Get schedule subscription. GET /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions/{subscription_id} on Databricks. Requires dashboard_id, schedule_id, subscription_id.

List dashboards. GET /api/2.0/lakeview/dashboards on Databricks.

List dashboard schedules. GET /api/2.0/lakeview/dashboards/{dashboard_id}/schedules on Databricks. Requires dashboard_id.

List schedule subscriptions. GET /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions on Databricks. Requires dashboard_id, schedule_id.

Migrates a classic SQL dashboard to Lakeview.

Publish the current draft dashboard. POST /api/2.0/lakeview/dashboards/{dashboard_id}/published on Databricks. Requires dashboard_id.

Revert a dashboard's definition in draft mode to the last published version.

DESTRUCTIVE — Trash a dashboard. DELETE /api/2.0/lakeview/dashboards/{dashboard_id} on Databricks. Requires dashboard_id.

DESTRUCTIVE — Unpublish the dashboard. DELETE /api/2.0/lakeview/dashboards/{dashboard_id}/published on Databricks. Requires dashboard_id.

Update a draft dashboard. PATCH /api/2.0/lakeview/dashboards/{dashboard_id} on Databricks. Requires dashboard_id.

Update dashboard schedule. PUT /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id} on Databricks. Requires dashboard_id, schedule_id.

Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster via the API or the libraries UI.

Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API or the libraries UI. The order of returned libraries is as follows: 1. Libraries set to be installed on this cluster, in the order that...

Create a default base environment within workspaces to define the environment version and a list of dependencies to be used in serverless notebooks and jobs. This process will asynchronously generate a cache to optimize dependency resolution.

DESTRUCTIVE - Delete the default base environment given an ID. The default base environment may be used by downstream workloads. Please ensure that the deletion is intentional.

Return the default base environment details for a given ID.

Add libraries to install on a cluster. The installation is asynchronous; it happens in the background after the completion of this request.

List default base environments defined in the workspaces for the requested user.

Refresh the cached default base environments for the given IDs. This process will asynchronously regenerate the caches. The existing caches remains available until it expires.

DESTRUCTIVE - Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is restarted. A request to uninstall a library that is not currently installed is ignored.

Update the default base environment for the given ID. This process will asynchronously regenerate the cache. The existing cache remains available until it expires.

Set the default base environment for the workspace. This marks the specified DBE as the workspace default.

DESTRUCTIVE - Reverts the enable partner powered AI features workspace setting to its default value.

Gets the enable partner powered AI features workspace setting.

Updates the enable partner powered AI features workspace setting.

Creates a FeatureTag. POST /api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags on Databricks. Requires table_name, feature_name.

DESTRUCTIVE — Deletes a FeatureTag. DELETE /api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags/{key} on Databricks. Requires table_name, feature_name, key.

Get Feature Lineage. GET /api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/lineage on Databricks. Requires table_name, feature_name.

Gets a FeatureTag. GET /api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags/{key} on Databricks. Requires table_name, feature_name, key.

Lists FeatureTags. GET /api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags on Databricks. Requires table_name, feature_name.

Updates a FeatureTag. PATCH /api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags/{key} on Databricks. Requires table_name, feature_name, key.

Creates a new metastore assignment. If an assignment for the same **workspace_id** exists, it will be overwritten by the new **metastore_id** and **default_catalog_name**. The caller must be an account admin.

Creates a new metastore based on a provided name and optional storage root path. By default (if the **owner** field is not set), the owner of the new metastore is the user calling the **createMetastore** API. If the **owner** field is set to the empty...

Gets the metastore assignment for the workspace being accessed.

DESTRUCTIVE - Deletes a metastore. The caller must be a metastore admin.

Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info.

Gets an array of the available metastores (as **MetastoreInfo** objects). The caller must be an admin to retrieve this info. There is no guarantee of a specific ordering of the elements in the array. NOTE: we recommend using max_results=0 to use the...

Gets information about a metastore. This summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID.

DESTRUCTIVE - Deletes a metastore assignment. The caller must be an account administrator.

Updates information for a specific metastore. The caller must be a metastore admin. If the **owner** field is set to the empty string (**""**), the ownership is updated to the System User.

Updates a metastore assignment. This operation can be used to update **metastore_id** or **default_catalog_name** for a specified Workspace, if the Workspace is already assigned a metastore. The caller must be an account admin to update **metastore_id**...

Approves a model version stage transition request.

Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display relevant information about the model. For example, test results or deployment errors.

Creates a new registered model with the name specified in the request body. Throws ``RESOURCE_ALREADY_EXISTS`` if a registered model with the given name exists.

Creates a model version. POST /api/2.0/mlflow/model-versions/create on Databricks. Requires name, source.

Creates a model version stage transition request.

**NOTE:** This endpoint is in Public Preview. Creates a registry webhook.

DESTRUCTIVE - Deletes a comment on a model version.

DESTRUCTIVE - Deletes a registered model.

DESTRUCTIVE - Deletes the tag for a registered model.

DESTRUCTIVE — Deletes a model version. DELETE /api/2.0/mlflow/model-versions/delete on Databricks. Requires name, version.

DESTRUCTIVE - Deletes a model version tag.

DESTRUCTIVE - Cancels a model version stage transition request.

DESTRUCTIVE - **NOTE:** This endpoint is in Public Preview. Deletes a registry webhook.

Gets the latest version of a registered model.

Get the details of a model. This is a Databricks workspace version of the `MLflow endpoint `__ that also returns the model's Databricks workspace ID and the permission level of the requesting user on the model.

Get a model version. GET /api/2.0/mlflow/model-versions/get on Databricks. Requires name, version.

Gets a URI to download the model version.

Gets the permission levels that a user can have on an object.

Gets the permissions of a registered model. Registered models can inherit permissions from their root object.

Lists all available registered models, up to the limit specified in **max_results**.

Gets a list of all open stage transition requests for the model version.

**NOTE:** This endpoint is in Public Preview. Lists all registry webhooks.

Rejects a model version stage transition request.

Renames a registered model. POST /api/2.0/mlflow/registered-models/rename on Databricks. Requires name.

Searches for specific model versions based on the supplied **filter**.

Search for registered models based on the specified **filter**.

Sets a tag on a registered model. POST /api/2.0/mlflow/registered-models/set-tag on Databricks. Requires name, key, value.

Sets a model version tag. POST /api/2.0/mlflow/model-versions/set-tag on Databricks. Requires name, version, key, value.

**NOTE:** This endpoint is in Public Preview. Tests a registry webhook.

Transition a model version's stage. This is a Databricks workspace version of the `MLflow endpoint `__ that also accepts a comment associated with the transition to be recorded.

Post an edit to a comment on a model version.

Updates a registered model. PATCH /api/2.0/mlflow/registered-models/update on Databricks. Requires name.

Updates the model version. PATCH /api/2.0/mlflow/model-versions/update on Databricks. Requires name, version.

**NOTE:** This endpoint is in Public Preview. Updates a registry webhook.

DESTRUCTIVE - Deletes a model version from the specified registered model. Any aliases assigned to the model version will also be deleted. The caller must be a metastore admin or an owner of the parent registered model. For the latter case, the caller must...

Get a model version. The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the parent registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog...

Get a model version by alias. The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog...

List model versions. You can list model versions under a particular schema, or list all model versions in the current metastore. The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list...

Updates the specified model version. The caller must be a metastore admin or an owner of the parent registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**...

Creates a notification destination. Requires workspace admin permissions.

DESTRUCTIVE - Deletes a notification destination. Requires workspace admin permissions.

Gets a notification destination. GET /api/2.0/notification-destinations/{id} on Databricks. Requires id.

Lists notification destinations. GET /api/2.0/notification-destinations on Databricks.

Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body.

Create a new Online Table. POST /api/2.0/online-tables on Databricks.

DESTRUCTIVE - Delete an online table. Warning: This will delete all the data in the online table. If the source Delta table was deleted or modified since this Online Table was created, this will lose the data forever!

Get information about an existing online table and its status.

Migrate Permissions. POST /api/2.0/permissionmigration on Databricks. Requires workspace_id, from_workspace_group_name, to_account_group_name.

Gets the permissions of an object. Objects can inherit permissions from their parent objects or root object.

Gets the permission levels that a user can have on an object.

Applies the current pipeline environment onto the pipeline compute. The environment applied can be used by subsequent dev-mode updates.

Creates a new pipeline using Unity Catalog from a pipeline using Hive Metastore. This method returns the ID of the newly created clone. Additionally, this method starts an update for the newly created pipeline.

Creates a new data processing pipeline based on the requested configuration. If successful, this method returns the ID of the new pipeline.

DESTRUCTIVE - Deletes a pipeline. If the pipeline publishes to Unity Catalog, pipeline deletion will cascade to all pipeline tables. Please reach out to Databricks support for assistance to undo this action.

Get a pipeline. GET /api/2.0/pipelines/{pipeline_id} on Databricks. Requires pipeline_id.

Gets the permission levels that a user can have on an object.

Gets the permissions of a pipeline. Pipelines can inherit permissions from their root object.

Gets an update from an active pipeline. GET /api/2.0/pipelines/{pipeline_id}/updates/{update_id} on Databricks. Requires pipeline_id, update_id.

Retrieves events for a pipeline. GET /api/2.0/pipelines/{pipeline_id}/events on Databricks. Requires pipeline_id.

Lists pipelines defined in the Spark Declarative Pipelines system.

List updates for an active pipeline. GET /api/2.0/pipelines/{pipeline_id}/updates on Databricks. Requires pipeline_id.

Restores a pipeline that was previously deleted, if within the restoration window. All tables deleted at pipeline deletion will be undropped as well.

Starts a new update for the pipeline. If there is already an active update for the pipeline, the request will fail and the active update will remain running.

Stops the pipeline by canceling the active update. If there is no active update for the pipeline, this request is a no-op.

Updates a pipeline with the supplied configuration.

Creates a new policy on a securable. The new policy applies to the securable and all its descendants.

DESTRUCTIVE - Delete an ABAC policy defined on a securable.

Get the policy definition on a securable

List all policies defined on a securable. Optionally, the list can include inherited policies defined on the securable's parent schema or catalog. PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a...

Update an ABAC policy on a securable. PATCH /api/2.1/unity-catalog/policies/{on_securable_type}/{on_securable_fullname}/{name} on Databricks. Requires on_securable_type, on_securable_fullname, name.

DESTRUCTIVE - Cancels a pending enforcement on a cluster. After canceling the pending enforcement, the cluster will no longer update on the next termination or restart. Pending enforcements cannot be canceled when a cluster is in ``TERMINATING`` state. Only...

Updates a cluster to be compliant with the current version of its policy. If a cluster is updated while in a ``TERMINATED`` state, it will remain ``TERMINATED``. The next time the cluster is started, the new attributes will take effect. For clusters in...

Returns the policy compliance status of a cluster. Clusters could be out of compliance if their policy was updated after the cluster was last edited.

Returns the policy compliance status of all clusters that use a given policy. Clusters could be out of compliance if their policy was updated after the cluster was last edited.

Updates a job so the job clusters that are created when running the job (specified in ``new_cluster``) are compliant with the current versions of their respective cluster policies. All-purpose clusters used in the job will not be updated.

Returns the policy compliance status of a job. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and some of its job clusters no longer comply with their updated policies.

Returns the policy compliance status of all jobs that use a given policy. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and its job clusters no longer comply with the updated policy.

Retrieve the information for an policy family based on its identifier and version

Returns the list of policy definition types available to use at their latest version. This API is paginated.

Creates a new database branch in the project.

Register a Postgres database in the Unity Catalog.

Create a CDF configuration that materializes the change data feed for all tables in a Postgres schema as open-format Delta tables in Unity Catalog. Once created, each table's change history is continuously written to its corresponding Lakehouse table.

Enable Data API for a database. POST /api/2.0/postgres/{parent}/data-api on Databricks. Requires parent.

Create a Database. Creates a database in the specified branch. A branch can have multiple databases.

Creates a new compute endpoint in the branch.

Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.

Creates a new replication group for the project.

Creates a new Postgres role in the branch.

Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.

Create a Synced Table. POST /api/2.0/postgres/synced_tables on Databricks. Requires synced_table_id.

Create a Table (non-synced database table for Autoscaling v2 Lakebase projects).

DESTRUCTIVE - Deletes the specified database branch.

DESTRUCTIVE - Delete a Database Catalog.

DESTRUCTIVE - Delete a CDF configuration and stop materializing the change data feed. When force=true, also drops the Delta tables in Unity Catalog. When force=false (default), the existing tables are preserved at their last state.

DESTRUCTIVE - Disable Data API for a database.

DESTRUCTIVE — Delete a Database. DELETE /api/2.0/postgres/{name} on Databricks. Requires name.

DESTRUCTIVE - Deletes the specified compute endpoint.

DESTRUCTIVE - Hard delete a Forward ETL configuration and all associated table mappings. Unlike DisableForwardEtl, this permanently removes the config and mapping rows.

DESTRUCTIVE - Deletes the specified database project.

DESTRUCTIVE - Deletes the specified recovery branch after reconciliation is complete.

DESTRUCTIVE - Deletes the specified replication group.

DESTRUCTIVE - Deletes the specified Postgres role.

DESTRUCTIVE - Deletes the specified snapshot.

DESTRUCTIVE — Delete a Synced Table. DELETE /api/2.0/postgres/{name} on Databricks. Requires name.

DESTRUCTIVE - Delete a Table (non-synced database table for Autoscaling v2 Lakebase projects).

DESTRUCTIVE - Disable Forward ETL for a branch.

Fails over the replication group to a target workspace, promoting the secondary to primary.

Generate OAuth credentials for a Postgres database.

Retrieves information about the specified database branch.

Get a Database Catalog. GET /api/2.0/postgres/{name} on Databricks. Requires name.

Get a single Lakebase CDF configuration, including the source Postgres schema, target Unity Catalog schema, and the identity under which writes are authorized.

Get the CDF status of a single table within a Lakebase CDF configuration, including its current state and the last committed position in the feed.

Lists the specific compute instance under an endpoint. Note: ComputeInstances are managed via the parent Endpoint resource, and cannot be created, updated, or deleted directly.

Get Data API configuration for a database.

Get a Database. GET /api/2.0/postgres/{name} on Databricks. Requires name.

Retrieves information about the specified compute endpoint, including its connection details and operational state.

Get Forward ETL metadata (database and schema OIDs).

Get Forward ETL configuration and status for a branch.

Retrieves the status of a long-running operation.

Retrieves information about the specified database project.

Retrieves information about the specified recovery branch.

Retrieves information about the specified replication group.

Retrieves information about the specified Postgres role, including its authentication method and permissions.

Retrieves information about the specified snapshot.

Retrieves the snapshot schedule for a branch. A branch with no configured schedule returns an empty schedule (not NOT_FOUND).

Get a Synced Table. GET /api/2.0/postgres/{name} on Databricks. Requires name.

Get a Table (non-synced database table for Autoscaling v2 Lakebase projects).

Materializes a temporary inspection branch from the specified recovery branch for data examination.

Returns a paginated list of database branches in the project.

List all CDF configurations for a Lakebase database. Each configuration maps a Postgres schema to a Unity Catalog schema where the change data feed is materialized.

List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a table's change data feed is snapshotting, streaming, or skipped.

Lists all compute instances that have been created under the specified endpoint. Note: ComputeInstances are managed via the parent Endpoint resource, and cannot be created, updated, or deleted directly.

List Databases. GET /api/2.0/postgres/{parent}/databases on Databricks. Requires parent.

Returns a paginated list of compute endpoints in the branch.

Returns a paginated list of database projects in the workspace that the user has permission to access.

Returns a paginated list of recovery branches for the project.

Returns a paginated list of replication groups for the project.

Returns a paginated list of Postgres roles in the branch.

Returns a paginated list of snapshots in the project.

Switches over the replication group to a target workspace with a coordinated failover.

Undeletes the specified database branch.

Undeletes a soft-deleted project. POST /api/2.0/postgres/{name}/undelete on Databricks. Requires name.

Updates the specified database branch. You can set this branch as the project's default branch, or protect/unprotect it.

Update Data API configuration for a database.

Update a Database. PATCH /api/2.0/postgres/{name} on Databricks. Requires name, update_mask.

Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or enable/disable the compute endpoint.

Updates the specified database project. PATCH /api/2.0/postgres/{name} on Databricks. Requires name, update_mask.

Updates the specified replication group.

Update a role for a branch. PATCH /api/2.0/postgres/{name} on Databricks. Requires name, update_mask.

Sets the snapshot schedule for a branch. The ``schedule`` field is replaced wholesale; an empty schedule disables automatic snapshots.

Add an exchange filter. POST /api/2.0/marketplace-exchange/filters on Databricks. Requires filter.

DESTRUCTIVE — Delete an exchange filter. DELETE /api/2.0/marketplace-exchange/filters/{id} on Databricks. Requires id.

List exchange filter. GET /api/2.0/marketplace-exchange/filters on Databricks. Requires exchange_id.

Update an exchange filter. PUT /api/2.0/marketplace-exchange/filters/{id} on Databricks. Requires id, filter.

Associate an exchange with a listing. POST /api/2.0/marketplace-exchange/exchanges-for-listing on Databricks. Requires listing_id, exchange_id.

Create an exchange. POST /api/2.0/marketplace-exchange/exchanges on Databricks. Requires exchange.

DESTRUCTIVE - This removes a listing from marketplace.

DESTRUCTIVE - Disassociate an exchange with a listing

Get an exchange. GET /api/2.0/marketplace-exchange/exchanges/{id} on Databricks. Requires id.

List exchanges visible to provider. GET /api/2.0/marketplace-exchange/exchanges on Databricks.

List exchanges associated with a listing

List listings associated with an exchange

Update an exchange. PUT /api/2.0/marketplace-exchange/exchanges/{id} on Databricks. Requires id, exchange.

Create a file. Currently, only provider icons and attached notebooks are supported.

DESTRUCTIVE — Delete a file. DELETE /api/2.0/marketplace-provider/files/{file_id} on Databricks. Requires file_id.

Get a file. GET /api/2.0/marketplace-provider/files/{file_id} on Databricks. Requires file_id.

List files attached to a parent entity. GET /api/2.0/marketplace-provider/files on Databricks. Requires file_parent.

Create a new listing. POST /api/2.0/marketplace-provider/listing on Databricks. Requires listing.

DESTRUCTIVE — Delete a listing. DELETE /api/2.0/marketplace-provider/listings/{id} on Databricks. Requires id.

Get a listing. GET /api/2.0/marketplace-provider/listings/{id} on Databricks. Requires id.

List listings owned by this provider. GET /api/2.0/marketplace-provider/listings on Databricks.

Update a listing. PUT /api/2.0/marketplace-provider/listings/{id} on Databricks. Requires id, listing.

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

Update personalization request. This method only permits updating the status of the request.

Create provider analytics dashboard. Returns Marketplace specific ``id``. Not to be confused with the Lakeview dashboard id.

Get provider analytics dashboard. GET /api/2.0/marketplace-provider/analytics_dashboard on Databricks.

Get latest version of provider analytics dashboard.

Update provider analytics dashboard. PUT /api/2.0/marketplace-provider/analytics_dashboard/{id} on Databricks. Requires id.

Create a provider. POST /api/2.0/marketplace-provider/provider on Databricks. Requires provider.

DESTRUCTIVE — Delete provider. DELETE /api/2.0/marketplace-provider/providers/{id} on Databricks. Requires id.

Get provider profile. GET /api/2.0/marketplace-provider/providers/{id} on Databricks. Requires id.

List provider profiles for account. GET /api/2.0/marketplace-provider/providers on Databricks.

Update provider profile. PUT /api/2.0/marketplace-provider/providers/{id} on Databricks. Requires id, provider.

Creates a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore.

DESTRUCTIVE - Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider.

Gets a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider.

Gets an array of available authentication providers. The caller must either be a metastore admin, have the **USE_PROVIDER** privilege on the providers, or be the owner of the providers. Providers not owned by the caller and for which the caller does not...

Get arrays of assets associated with a specified provider's share. The caller is the recipient of the share.

Gets an array of a specified provider's shares within the metastore where: - the caller is a metastore admin, or - the caller is the owner.

Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the provider.

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). Create a quality monitor on UC object.

DESTRUCTIVE - Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). Delete a quality monitor on UC object.

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). Read a quality monitor on UC object.

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). (Unimplemented) List quality monitors.

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). (Unimplemented) Update a quality monitor on UC object.

DESTRUCTIVE - Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Cancels an already-initiated refresh job.

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Creates a new monitor for the specified table. The caller must either: 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the table's parent schema, and...

DESTRUCTIVE - Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Deletes a monitor for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent...

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets a monitor for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an...

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets info about a specific monitor refresh using the given refresh ID. The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the...

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets an array containing the history of the most recent refreshes (up to 25) for this table. The caller must either: 1. be an owner of the table's parent catalog 2. have...

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Regenerates the monitoring dashboard for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's...

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Queues a metric refresh on the monitor for the specified table. The refresh will execute in the background. The caller must either: 1. be an owner of the table's parent...

Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Updates a monitor for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be...

Creates a query. POST /api/2.0/sql/queries on Databricks.

DESTRUCTIVE - Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days.

Gets a query. GET /api/2.0/sql/queries/{id} on Databricks. Requires id.

Creates a new query definition. Queries created with this endpoint belong to the authenticated user making the request. The ``data_source_id`` field specifies the ID of the SQL warehouse to run this query against. You can use the Data Sources API to see a...

DESTRUCTIVE - Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and they cannot be used for alerts. The trash is deleted after 30 days. **Warning**: This API is deprecated. Please use :method:queries/delete...

Retrieve a query object definition along with contextual permissions information about the currently authenticated user. **Warning**: This API is deprecated. Please use :method:queries/get instead. `Learn more `__

Gets a list of queries. Optionally, this list can be filtered by a search term. **Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban. **Warning**: This API is deprecated. Please use...

Restore a query that has been moved to the trash. A restored query appears in list views and searches. You can use restored queries for alerts. **Warning**: This API is deprecated. Please see the latest version. `Learn more `__

Modify this query definition. **Note**: You cannot undo this operation. **Warning**: This API is deprecated. Please use :method:queries/update instead. `Learn more `__

Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.

Gets a list of visualizations on a query.

Updates a query. PATCH /api/2.0/sql/queries/{id} on Databricks. Requires id, update_mask.

List the history of queries through SQL warehouses, and serverless compute. You can filter by user ID, warehouse ID, status, and time range. Most recently started queries are returned first (up to max_results in request). The pagination token returned in...

Adds a visualization to a query. POST /api/2.0/sql/visualizations on Databricks.

DESTRUCTIVE — Removes a visualization. DELETE /api/2.0/sql/visualizations/{id} on Databricks. Requires id.

Creates visualization in the query. **Warning**: This API is deprecated. Please use :method:queryvisualizations/create instead. `Learn more `__

DESTRUCTIVE - Removes a visualization from the query. **Warning**: This API is deprecated. Please use :method:queryvisualizations/delete instead. `Learn more `__

Updates visualization in the query. **Warning**: This API is deprecated. Please use :method:queryvisualizations/update instead. `Learn more `__

Updates a visualization. PATCH /api/2.0/sql/visualizations/{id} on Databricks. Requires id, update_mask.

Gets an activation URL for a share. GET /api/2.1/unity-catalog/public/data_sharing_activation_info/{activation_url} on Databricks. Requires activation_url.

Create a federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients. The caller must be the owner of the recipient. When sharing data from Databricks to non-Databricks clients, you can define a...

DESTRUCTIVE - Deletes an existing federation policy for an OIDC_FEDERATION recipient. The caller must be the owner of the recipient.

Reads an existing federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients. The caller must have read access to the recipient.

Lists federation policies for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients. The caller must have read access to the recipient.

Updates an existing federation policy for an OIDC_RECIPIENT. The caller must be the owner of the recipient.

Creates a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or have the **CREATE_RECIPIENT** privilege on the metastore.

DESTRUCTIVE - Deletes the specified recipient from the metastore. The caller must be the owner of the recipient.

Gets a share recipient from the metastore. The caller must be one of: - A user with **USE_RECIPIENT** privilege on the metastore - The owner of the share recipient - A metastore admin

Gets an array of all share recipients within the current metastore where: - the caller is a metastore admin, or - the caller is the owner. There is no guarantee of a specific ordering of the elements in the array.

Gets the share permissions for the specified Recipient. The caller must have the **USE_RECIPIENT** privilege on the metastore or be the owner of the Recipient.

Updates an existing recipient in the metastore. The caller must be a metastore admin or the owner of the recipient. If the recipient name will be updated, the user must be both a metastore admin and the owner of the recipient.

Read workspace configuration for Redash-v2.

Creates a new registered model in Unity Catalog. File storage for model versions in the registered model will be located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. For registered model creation...

DESTRUCTIVE - Deletes a registered model and all its model versions from the specified parent catalog and schema. The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the...

DESTRUCTIVE - Deletes a registered model alias. The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**...

Get a registered model. The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and...

List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore. The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able...

Set an alias on the specified registered model. The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the...

Updates the specified registered model. The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**...

Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created programmatically must be linked to a remote Git repo, unlike repos created in the browser.

DESTRUCTIVE - Deletes the specified repo.

Returns the repo with the given repo ID.

Gets the permission levels that a user can have on an object.

Gets the permissions of a repo. Repos can inherit permissions from their root object.

Returns repos that the calling user has Manage permissions on. Use ``next_page_token`` to iterate through additional pages. Deprecated: This operation does not return a complete list of the repos in the workspace, because repos with the Git CLI enabled are...

Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same branch.

The GetQuota API returns usage information for a single resource quota, defined as a child-parent pair. This API also refreshes the quota count if it is out of date. Refreshes are triggered asynchronously. The updated count might not be returned in the...

ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the counts returned. This API does not trigger a refresh of quota counts. PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results...

DESTRUCTIVE - Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in ``DELETE`` requests (as a query parameter). The etag can be retrieved by making a ``GET`` request before the DELETE request. If the...

Gets the restrict workspace admins setting.

Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in ``PATCH`` requests (as part of the setting field). The etag can be retrieved by making a GET request before the ``PATCH`` request. If the setting is...

Creates access requests for Unity Catalog permissions for a specified principal on a securable object. This Batch API can take in multiple principals, securable objects, and permissions as the input and returns the access request destinations for each...

Gets an array of access request destinations for the specified securable. Any caller can see URL destinations or the destinations on the metastore. Otherwise, only those with **BROWSE** permissions on the securable can see destinations. The supported...

Updates the access request destinations for the given securable. The caller must be a metastore admin, the owner of the securable, or a user that has the **MANAGE** privilege on the securable in order to assign destinations. A maximum of 5 emails and 5...

Creates a new schema for catalog in the Metastore. The caller must be a metastore admin, or have the **CREATE_SCHEMA** privilege in the parent catalog.

DESTRUCTIVE - Deletes the specified schema from the parent catalog. The caller must be the owner of the schema or an owner of the parent catalog.

Gets the specified schema within the metastore. The caller must be a metastore admin, the owner of the schema, or a user that has the **USE_SCHEMA** privilege on the schema.

Gets an array of schemas for a catalog in the metastore. If the caller is the metastore admin or the owner of the parent catalog, all schemas for the catalog will be retrieved. Otherwise, only schemas owned by the caller (or for which the caller has the...

Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin. If the caller is a metastore admin, only the **owner** field can be changed in the update. If the **name** field must be updated, the caller must be a metastore...

Creates a new secret scope. The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters. Example request: .. code:: { "scope": "my-simple-databricks-scope", "initial_manage_principal": "users"...

DESTRUCTIVE - Deletes the given ACL on the given scope. Users must have the ``MANAGE`` permission to invoke this API. Example request: .. code:: { "scope": "my-secret-scope", "principal": "data-scientists" } Throws ``RESOURCE_DOES_NOT_EXIST`` if no such...

DESTRUCTIVE - Deletes a secret scope. Example request: .. code:: { "scope": "my-secret-scope" } Throws ``RESOURCE_DOES_NOT_EXIST`` if the scope does not exist. Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws...

DESTRUCTIVE - Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE`` permission on the Secret Scope. Example request: .. code:: { "scope": "my-secret-scope", "key": "my-secret-key" } Throws ``RESOURCE_DOES_NOT_EXIST`` if no such...

Describes the details about the given ACL, such as the group and permission. Users must have the ``MANAGE`` permission to invoke this API. Example response: .. code:: { "principal": "data-scientists", "permission": "READ" } Throws...

Gets a secret for a given key and scope. This API can only be called from the DBUtils interface. Users need the READ permission to make this call. Example response: .. code:: { "key": "my-string-key", "value": } Note that the secret value returned is in...

Lists the ACLs set on the given scope. Users must have the ``MANAGE`` permission to invoke this API. Example response: .. code:: { "acls": [{ "principal": "admins", "permission": "MANAGE" },{ "principal": "data-scientists", "permission": "READ" }] } Throws...

Lists all secret scopes available in the workspace. Example response: .. code:: { "scopes": [{ "name": "my-databricks-scope", "backend_type": "DATABRICKS" },{ "name": "mount-points", "backend_type": "DATABRICKS" }] } Throws ``PERMISSION_DENIED`` if the user...

Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data cannot be retrieved using this API. Users need the READ permission to make this call. Example response: .. code:: { "secrets": [ { "key": "my-string-key""...

Creates or overwrites the ACL associated with the given principal (user or group) on the specified scope point. In general, a user or group will use the most powerful permission available to them, and permissions are ordered as follows: - ``MANAGE`` -...

Inserts a secret under the provided scope with the given name. If a secret already exists with the same name, this command overwrites the existing secret's value. The server encrypts the secret using the secret scope's encryption settings before storing it...

Creates a new secret in Unity Catalog. You must be the owner of the parent schema or have the **CREATE_SECRET** and **USE SCHEMA** privileges on the parent schema and **USE CATALOG** on the parent catalog. The secret is stored in the specified catalog and...

DESTRUCTIVE - Deletes a secret by its three-level (fully qualified) name. You must be the owner of the secret or a metastore admin.

Gets a secret by its three-level (fully qualified) name. You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on the secret. The secret value isn't returned by default. To retrieve it, you must also have the...

Lists secrets in Unity Catalog. You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on the secret. Both **catalog_name** and **schema_name** must be specified together to filter secrets within a specific schema. Results...

Updates an existing secret in Unity Catalog. You must be the owner of the secret or a metastore admin. If you are a metastore admin, only the **owner** field can be changed. Use the **update_mask** field to specify which fields to update. Supported...

Creates a new service principal in the Databricks workspace.

DESTRUCTIVE - Delete a single service principal in the Databricks workspace.

Gets the details for a single service principal define in the Databricks workspace.

Gets the set of service principals associated with a Databricks workspace.

Partially updates the details of a single service principal in the Databricks workspace.

Updates the details of a single service principal. This action replaces the existing service principal with the same name.

Creates a new service principal in the Databricks workspace.

DESTRUCTIVE - Delete a single service principal in the Databricks workspace.

Gets the details for a single service principal define in the Databricks workspace.

Gets the set of service principals associated with a Databricks workspace.

Partially updates the details of a single service principal in the Databricks workspace.

Updates the details of a single service principal. This action replaces the existing service principal with the same name.

Retrieves the build logs associated with the provided served model.

Create a new serving endpoint. POST /api/2.0/serving-endpoints on Databricks. Requires name.

Create a new PT serving endpoint. POST /api/2.0/serving-endpoints/pt on Databricks. Requires name, config.

DESTRUCTIVE - Delete a serving endpoint.

Retrieves the metrics associated with the provided serving endpoint in either Prometheus or OpenMetrics exposition format.

Retrieves the details for a single serving endpoint.

Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for the supported paths, input and output format and datatypes.

Gets the permission levels that a user can have on an object.

Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root object.

Make external services call using the credentials stored in UC Connection.

Get all serving endpoints. GET /api/2.0/serving-endpoints on Databricks.

Retrieves the service logs associated with the provided served model.

Used to batch add and delete tags from a serving endpoint with a single API call.

Updates the system-metrics-export state of a serving endpoint, independently of the endpoint config (does not trigger a config-version change or redeployment).

Updates the telemetry configuration of a serving endpoint.

Deprecated: Please use AI Gateway to manage rate limits instead.

Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.

Query a serving endpoint. POST /serving-endpoints/{name}/invocations on Databricks. Requires name.

Updates any combination of the serving endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. An endpoint that already has an update in progress can not be updated until the current update...

Updates the email and webhook notification settings for an endpoint.

Updates any combination of the pt endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. Updates are instantaneous and endpoint should be updated instantly

Creates a new share for data objects. Data objects can be added after creation with **update**. The caller must be a metastore admin or have the **CREATE_SHARE** privilege on the metastore.

DESTRUCTIVE - Deletes a data object share from the metastore. The caller must be an owner of the share.

Gets a data object share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share.

Gets an array of data object shares from the metastore. If the caller has the USE_SHARE privilege on the metastore, all shares are returned. Otherwise, only shares owned by the caller are returned. There is no guarantee of a specific ordering of the...

Gets the permissions for a data share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share.

Updates the share with the changes and data objects in the request. The caller must be the owner of the share or a metastore admin. When the caller is a metastore admin, only the **owner** field can be updated. In the case the share name is changed...

DESTRUCTIVE - Reverts the SQL Results Download setting to its default value.

Gets the SQL Results Download setting. GET /api/2.0/settings/types/sql_results_download/names/default on Databricks.

Updates the SQL Results Download setting.

DESTRUCTIVE - Requests that an executing statement be canceled. Callers must poll for status to see the terminal state. Cancel response is empty; receiving response indicates successful receipt.

Execute a SQL statement and optionally await its results for a specified time. **Use case: small result sets with INLINE + JSON_ARRAY** For flows that generate small and predictable result sets ( `__. StatementResponse contains ``statement_id`` and...

This request can be used to poll for the statement's status. StatementResponse contains ``statement_id`` and ``status``; other fields might be absent or present depending on context. When the ``status.state`` field is ``SUCCEEDED`` it will also return the...

After the statement execution has ``SUCCEEDED``, this request can be used to fetch any chunk by index. Whereas the first chunk with ``chunk_index=0`` is typically fetched with :method:statementexecution/executeStatement or...

Creates a new storage credential. The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on the metastore.

DESTRUCTIVE - Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.

Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have some permission on the storage credential.

Gets an array of storage credentials (as **StorageCredentialInfo** objects). The array is limited to only those storage credentials the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is...

Updates a storage credential on the metastore. The caller must be the owner of the storage credential or a metastore admin. If the caller is a metastore admin, only the **owner** field can be changed.

Validates a storage credential. At least one of **external_location_name** and **url** need to be provided. If only one of them is provided, it will be used for validation. And if both are provided, the **url** will be used for validation, and...

Creates an example for a Supervisor Agent.

Creates a new Supervisor Agent. POST /api/2.1/supervisor-agents on Databricks.

Creates a Tool under a Supervisor Agent. Specify one of "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "app", "volume", "dashboard", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "databricks_web_search"...

DESTRUCTIVE - Deletes an example from a Supervisor Agent.

DESTRUCTIVE - Deletes a Supervisor Agent.

DESTRUCTIVE — Deletes a Tool. DELETE /api/2.1/{name} on Databricks. Requires name.

Gets an example from a Supervisor Agent.

Gets the permission levels that a user can have on an object.

Gets the permissions of a supervisor agent. Supervisor agents can inherit permissions from their root object.

Gets a Supervisor Agent. GET /api/2.1/{name} on Databricks. Requires name.

Gets a Tool. GET /api/2.1/{name} on Databricks. Requires name.

Lists examples under a Supervisor Agent.

Lists Supervisor Agents. GET /api/2.1/supervisor-agents on Databricks.

Lists Tools under a Supervisor Agent. GET /api/2.1/{parent}/tools on Databricks. Requires parent.

Updates an example in a Supervisor Agent.

Updates a Supervisor Agent. The fields that are required depend on the paths specified in ``update_mask``. Only fields included in the mask will be updated.

Updates a Tool. Only the ``description`` field can be updated. To change immutable fields such as tool type, spec, or tool ID, delete the tool and recreate it.

DESTRUCTIVE - Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin.

Enables the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin.

Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin. NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. PAGINATION BEHAVIOR: When...

Creates a new table constraint. For the table constraint creation to succeed, the user must satisfy both of these conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA** privilege on the table's...

DESTRUCTIVE - Deletes a table constraint. For the table constraint deletion to succeed, the user must satisfy both of these conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA** privilege on the...

Creates a new table in the specified catalog and schema. To create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and the **EXTERNAL_USE_LOCATION** privilege on the external location. These...

DESTRUCTIVE - Deletes a table from the specified parent catalog and schema. The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema, or be the owner of the table and...

Gets if a table exists in the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: - Be a metastore admin - Be the owner of the parent catalog - Be the owner of the parent schema and have the...

Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: - Be a metastore admin - Be the owner of the parent catalog - Be the owner of the parent schema and have the **USE_CATALOG**...

Gets an array of all tables for the current metastore under the parent catalog and schema. The caller must be a metastore admin or an owner of (or have the **SELECT** privilege on) the table. For the latter case, the caller must also be the owner or have...

Gets an array of summaries for tables for a schema and catalog within the metastore. The table summaries returned are either: - summaries for tables (within the current metastore and parent catalog and schema), when the user is a metastore admin, or: -...

Change the owner of the table. The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema, or be the owner of the table and have the **USE_CATALOG** privilege on the...

Creates a new tag policy, making the associated tag key governed. For Terraform usage, see the `Tag Policy Terraform documentation `__. To manage permissions for tag policies, use the `Account Access Control Proxy API `__.

DESTRUCTIVE - Deletes a tag policy by its associated governed tag's key, leaving that tag key ungoverned. For Terraform usage, see the `Tag Policy Terraform documentation `__.

Gets a single tag policy by its associated governed tag's key. For Terraform usage, see the `Tag Policy Terraform documentation `__. To list granted permissions for tag policies, use the `Account Access Control Proxy API `__.

Lists the tag policies for all governed tags in the account. For Terraform usage, see the `Tag Policy Terraform documentation `__. To list granted permissions for tag policies, use the `Account Access Control Proxy API `__.

Updates an existing tag policy for a single governed tag. For Terraform usage, see the `Tag Policy Terraform documentation `__. To manage permissions for tag policies, use the `Account Access Control Proxy API `__.

Get a short-lived credential for directly accessing cloud storage locations registered in Databricks. The Generate Temporary Path Credentials API is only supported for external storage paths, specifically external locations and external tables. Managed...

Get a short-lived credential for directly accessing the table data on cloud storage. The metastore must have **external_access_enabled** flag set to true (default false). The caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and...

Get a short-lived credential for directly accessing the volume data on cloud storage. The metastore must have **external_access_enabled** flag set to true (default false). The caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and...

DESTRUCTIVE - Deletes a token, specified by its ID.

Gets information about a token, specified by its ID.

Gets the permission levels that a user can have on an object.

Gets the permissions of all tokens. Tokens can inherit permissions from their root object.

Lists all tokens associated with the specified workspace or user.

Updates a token, specified by its ID. PATCH /api/2.0/token-management/tokens/{token_id} on Databricks. Requires token_id, token, update_mask.

DESTRUCTIVE - Revokes an access token. If a token with the specified ID is not valid, this call returns an error **RESOURCE_DOES_NOT_EXIST**.

Lists all the valid tokens for a user-workspace pair.

Updates the comment or scopes of a token. If a token with the specified ID is not valid, this call returns an error **NOT_FOUND**.

Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account.

DESTRUCTIVE - Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user.

Gets information for a specific user in Databricks workspace.

Gets the permission levels that a user can have on an object.

Gets the permissions of all passwords. Passwords can inherit permissions from their root object.

Gets details for all the users associated with a Databricks workspace.

Partially updates a user resource by applying the supplied operations on specific user attributes.

Replaces a user's information with the data supplied in request.

Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account.

DESTRUCTIVE - Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user.

Gets information for a specific user in Databricks workspace.

Gets the permission levels that a user can have on an object.

Gets the permissions of all passwords. Passwords can inherit permissions from their root object.

Gets details for all the users associated with a Databricks workspace.

Partially updates a user resource by applying the supplied operations on specific user attributes. The ``userName`` and ``emails`` attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).

Replaces a user's information with the data supplied in request. The ``userName`` and ``emails`` attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).

Create a new endpoint. POST /api/2.0/vector-search/endpoints on Databricks. Requires name, endpoint_type.

DESTRUCTIVE - Delete an AI Search endpoint.

Get details for a single AI Search endpoint.

Gets the permission levels that a user can have on an object.

Gets the permissions of a vector search endpoint. Vector search endpoints can inherit permissions from their root object.

List all AI Search endpoints in the workspace.

Update an endpoint. PATCH /api/2.0/vector-search/endpoints/{endpoint_name} on Databricks. Requires endpoint_name.

Update the throughput (concurrency) of an endpoint

Retrieve user-visible metrics for an endpoint

Update the budget policy of an endpoint. PATCH /api/2.0/vector-search/endpoints/{endpoint_name}/budget-policy on Databricks. Requires endpoint_name, budget_policy_id.

Update the custom tags of an endpoint. PATCH /api/2.0/vector-search/endpoints/{endpoint_name}/tags on Databricks. Requires endpoint_name, custom_tags.

Create a new index. POST /api/2.0/vector-search/indexes on Databricks. Requires name, endpoint_name, primary_key, index_type.

DESTRUCTIVE - Handles the deletion of data from a specified vector index.

DESTRUCTIVE — Delete an index. DELETE /api/2.0/vector-search/indexes/{index_name} on Databricks. Requires index_name.

Returns the status of the latest autoeval run for a vector index.

Get an index. GET /api/2.0/vector-search/indexes/{index_name} on Databricks. Requires index_name.

List all indexes in the given endpoint. GET /api/2.0/vector-search/indexes on Databricks. Requires endpoint_name.

Query the specified vector index. POST /api/2.0/vector-search/indexes/{index_name}/query on Databricks. Requires index_name, columns.

Use ``next_page_token`` returned from previous ``QueryVectorIndex`` or ``QueryVectorIndexNextPage`` request to fetch next page of results.

Triggers an autoeval quality evaluation for a vector index.

Triggers reranker finetuning for a vector index.