Databricks
databricksDatabricks is the lakehouse company, helping data teams solve the world's toughest problems with unified analytics platform for big data and AI.
Acciones disponibles (447)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Member to Security GroupDATABRICKS_ADD_MEMBER_TO_SECURITY_GROUPAcciónTool to add a user or group as a member to a Databricks security group. Use when you need to grant group membership for access control.
DATABRICKS_ADD_MEMBER_TO_SECURITY_GROUPAcciónTool to add a user or group as a member to a Databricks security group. Use when you need to grant group membership for access control.
Parámetros de entrada
user_namestringThe email address of a user to add to the parent group. Either user_name or group_name must be provided (not both).
group_namestringThe name of a group to add to the parent group as a nested member. Either user_name or group_name must be provided (not both).
parent_namestringObligatorioName of the parent group to which the new member will be added.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Custom LLM AgentDATABRICKS_AGENTBRICKS_AGENT_BRICKS_DELETE_CUSTOM_LLMAcciónTool to delete a Custom LLM agent created through Agent Bricks. Use when you need to remove a custom LLM and all associated data. This operation is irreversible and deletes all data including temporary transformations, model checkpoints, and internal metadata.
DATABRICKS_AGENTBRICKS_AGENT_BRICKS_DELETE_CUSTOM_LLMAcciónTool to delete a Custom LLM agent created through Agent Bricks. Use when you need to remove a custom LLM and all associated data. This operation is irreversible and deletes all data including temporary transformations, model checkpoints, and internal metadata.
Parámetros de entrada
idstringObligatorioThe ID of the custom LLM agent to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Databricks AppDATABRICKS_APPS_APPS_CREATEAcciónTool to create a new Databricks app with specified configuration. Use when you need to create apps hosted on Databricks serverless platform to deploy secure data and AI applications. The app name must be unique within the workspace, contain only lowercase alphanumeric characters and hyphens, and cannot be changed after creation.
DATABRICKS_APPS_APPS_CREATEAcciónTool to create a new Databricks app with specified configuration. Use when you need to create apps hosted on Databricks serverless platform to deploy secure data and AI applications. The app name must be unique within the workspace, contain only lowercase alphanumeric characters and hyphens, and cannot be changed after creation.
Parámetros de entrada
namestringObligatorioThe name of the app. Must contain only lowercase alphanumeric characters and hyphens. Must be unique within the workspace. Cannot be changed after creation. Do not include sensitive information in the app name
resourcesobject[]App resources configuration including database connections, Genie Spaces, jobs, secrets, serving endpoints, SQL warehouses, and Unity Catalog securables
descriptionstringThe description of the app providing additional context about its purpose
permissionsobject[]Access control list for app users specifying CAN_MANAGE or CAN_USE access levels applicable to users, groups, or service principals
compute_sizestringenumCompute resource allocation for the app. MEDIUM for moderate workloads, LARGE for intensive workloads
MEDIUMLARGEuser_api_scopesstring[]API access permissions for the app
budget_policy_idstringAssociated budget policy identifier for cost management
source_code_pathstringWorkspace file system path of the source code used to create the app deployment. Must be a valid workspace path in the format /Workspace/Users/{user-path}/{app-directory}
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Databricks AppDATABRICKS_APPS_APPS_DELETEAcciónTool to delete a Databricks app from the workspace. Use when you need to remove an app and its associated service principal. When an app is deleted, Databricks automatically deletes the provisioned service principal.
DATABRICKS_APPS_APPS_DELETEAcciónTool to delete a Databricks app from the workspace. Use when you need to remove an app and its associated service principal. When an app is deleted, Databricks automatically deletes the provisioned service principal.
Parámetros de entrada
namestringObligatorioThe name of the app to delete. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deploy Databricks AppDATABRICKS_APPS_APPS_DEPLOYAcciónTool to create a deployment for a Databricks app. Use when you need to deploy an app with source code from a workspace path. The deployment process provisions compute resources and uploads the source code. Deployments can be in states: IN_PROGRESS, SUCCEEDED, FAILED, or CANCELLED.
DATABRICKS_APPS_APPS_DEPLOYAcciónTool to create a deployment for a Databricks app. Use when you need to deploy an app with source code from a workspace path. The deployment process provisions compute resources and uploads the source code. Deployments can be in states: IN_PROGRESS, SUCCEEDED, FAILED, or CANCELLED.
Parámetros de entrada
modestringenumThe mode which determines how the deployment will manage the source code. AUTO_SYNC automatically synchronizes source code changes. SNAPSHOT creates a point-in-time snapshot of source code. If not specified, the API will use its default mode
AUTO_SYNCSNAPSHOTapp_namestringObligatorioThe name of the app for which the deployment is created
source_code_pathstringObligatorioWorkspace file system path of the source code used to create the app deployment. Must be a valid workspace path in the format /Workspace/Users/{user-path}/{app-directory}
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks App DetailsDATABRICKS_APPS_APPS_GETAcciónTool to retrieve details about a specific Databricks app by name. Use when you need to get comprehensive information about an app including configuration, deployment status, compute resources, and metadata.
DATABRICKS_APPS_APPS_GETAcciónTool to retrieve details about a specific Databricks app by name. Use when you need to get comprehensive information about an app including configuration, deployment status, compute resources, and metadata.
Parámetros de entrada
namestringObligatorioThe name of the app. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks App Permission LevelsDATABRICKS_APPS_APPS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks app. Use when you need to understand what permission levels can be assigned to users or groups for a specific app. Returns permission levels like CAN_USE and CAN_MANAGE with their descriptions.
DATABRICKS_APPS_APPS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks app. Use when you need to understand what permission levels can be assigned to users or groups for a specific app. Returns permission levels like CAN_USE and CAN_MANAGE with their descriptions.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the Databricks app
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks App PermissionsDATABRICKS_APPS_APPS_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks app. Use when you need to check who has access to an app and their permission levels. Returns the access control list including inherited permissions from parent or root objects.
DATABRICKS_APPS_APPS_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks app. Use when you need to check who has access to an app and their permission levels. Returns the access control list including inherited permissions from parent or root objects.
Parámetros de entrada
namestringObligatorioThe name of the app. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get App Deployment UpdateDATABRICKS_APPS_APPS_GET_UPDATEAcciónTool to retrieve information about a specific app deployment update. Use when you need to track the status and details of app deployment updates, including whether the update succeeded, failed, is in progress, or was not updated.
DATABRICKS_APPS_APPS_GET_UPDATEAcciónTool to retrieve information about a specific app deployment update. Use when you need to track the status and details of app deployment updates, including whether the update succeeded, failed, is in progress, or was not updated.
Parámetros de entrada
namestringObligatorioThe name of the app. Must contain only lowercase alphanumeric characters and hyphens
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Databricks App PermissionsDATABRICKS_APPS_APPS_SET_PERMISSIONSAcciónTool to set permissions for a Databricks app, replacing all existing permissions. Use when you need to configure access control for an app. This operation replaces ALL existing permissions; for incremental updates, use the update permissions endpoint instead. Admin permissions cannot be removed.
DATABRICKS_APPS_APPS_SET_PERMISSIONSAcciónTool to set permissions for a Databricks app, replacing all existing permissions. Use when you need to configure access control for an app. This operation replaces ALL existing permissions; for incremental updates, use the update permissions endpoint instead. Admin permissions cannot be removed.
Parámetros de entrada
namestringObligatorioThe name of the app. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace
access_control_listobject[]ObligatorioArray of access control entries. This replaces ALL existing permissions. For each entry, only one of user_name, group_name, or service_principal_name should be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Start Databricks AppDATABRICKS_APPS_APPS_STARTAcciónTool to start the last active deployment of a Databricks app. Use when you need to start a stopped app, which transitions it to the ACTIVE state. The start operation is asynchronous and the app will transition to the ACTIVE state after the operation completes.
DATABRICKS_APPS_APPS_STARTAcciónTool to start the last active deployment of a Databricks app. Use when you need to start a stopped app, which transitions it to the ACTIVE state. The start operation is asynchronous and the app will transition to the ACTIVE state after the operation completes.
Parámetros de entrada
namestringObligatorioThe name of the app to start. Must contain only lowercase alphanumeric characters and hyphens
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Stop Databricks AppDATABRICKS_APPS_APPS_STOPAcciónTool to stop the active deployment of a Databricks app. Use when you need to stop a running app, which transitions it to the STOPPED state. The stop operation is asynchronous and the app will transition to the STOPPED state after the operation completes.
DATABRICKS_APPS_APPS_STOPAcciónTool to stop the active deployment of a Databricks app. Use when you need to stop a running app, which transitions it to the STOPPED state. The stop operation is asynchronous and the app will transition to the STOPPED state after the operation completes.
Parámetros de entrada
namestringObligatorioThe name of the app to stop. Must contain only lowercase alphanumeric characters and hyphens
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Databricks AppDATABRICKS_APPS_APPS_UPDATEAcciónTool to update an existing Databricks app configuration. Use when you need to modify app settings such as description, resources, compute size, budget policy, or API scopes. This is a partial update operation - only fields provided in the request will be updated, other fields retain their current values.
DATABRICKS_APPS_APPS_UPDATEAcciónTool to update an existing Databricks app configuration. Use when you need to modify app settings such as description, resources, compute size, budget policy, or API scopes. This is a partial update operation - only fields provided in the request will be updated, other fields retain their current values.
Parámetros de entrada
namestringObligatorioThe name of the app to update. Must contain only lowercase alphanumeric characters and hyphens
resourcesobject[]List of accessible system components and resources for the app. When provided, replaces the existing resources configuration
descriptionstringApplication summary or description. When provided, replaces the existing description
compute_sizestringenumSize allocation for compute resources. MEDIUM for moderate workloads, LARGE for intensive workloads. When provided, replaces the existing compute size
MEDIUMLARGEusage_policy_idstringUsage policy identifier for the application. When provided, replaces the existing usage policy
user_api_scopesstring[]API access grants for application users. List of permission scopes. When provided, replaces the existing user API scopes
budget_policy_idstringAssociated budget policy identifier for cost management. When provided, replaces the existing budget policy
default_source_code_pathstringWorkspace path tracking the last active deployment source code. When provided, replaces the existing source code path
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Databricks App PermissionsDATABRICKS_APPS_APPS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for a Databricks app. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request. For replacing all permissions, use SetPermissions instead.
DATABRICKS_APPS_APPS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for a Databricks app. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request. For replacing all permissions, use SetPermissions instead.
Parámetros de entrada
namestringObligatorioThe unique identifier or name of the app. Must contain only lowercase alphanumeric characters and hyphens
access_control_listobject[]ObligatorioList of access control entries to update. This operation updates only the specified permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Cancel Databricks Job RunDATABRICKS_CANCEL_RUNAcciónTool to cancel a Databricks job run asynchronously. Use when you need to terminate a running job. The run will be terminated shortly after the request completes. If the run is already in a terminal state (TERMINATED, SKIPPED, or INTERNAL_ERROR), this is a no-op.
DATABRICKS_CANCEL_RUNAcciónTool to cancel a Databricks job run asynchronously. Use when you need to terminate a running job. The run will be terminated shortly after the request completes. If the run is already in a terminal state (TERMINATED, SKIPPED, or INTERNAL_ERROR), this is a no-op.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier of the run to cancel. This field is required to specify which job run should be cancelled.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog Artifact AllowlistDATABRICKS_CATALOG_ARTIFACT_ALLOWLISTS_GETAcciónTool to retrieve artifact allowlist configuration for a specified artifact type in Unity Catalog. Use when you need to check which artifacts are permitted for use in your Databricks environment. Requires metastore admin privileges or MANAGE ALLOWLIST privilege on the metastore.
DATABRICKS_CATALOG_ARTIFACT_ALLOWLISTS_GETAcciónTool to retrieve artifact allowlist configuration for a specified artifact type in Unity Catalog. Use when you need to check which artifacts are permitted for use in your Databricks environment. Requires metastore admin privileges or MANAGE ALLOWLIST privilege on the metastore.
Parámetros de entrada
artifact_typestringObligatorioenumThe artifact type of the allowlist to retrieve. Supported values are INIT_SCRIPT, LIBRARY_JAR, or LIBRARY_MAVEN
INIT_SCRIPTLIBRARY_JARLIBRARY_MAVEN
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CatalogDATABRICKS_CATALOG_CATALOGS_DELETEAcciónTool to delete a catalog from Unity Catalog metastore. Use when you need to permanently remove a catalog and optionally its contents. By default, the catalog must be empty (except for information_schema). Use force=true to delete non-empty catalogs. Do not delete the main catalog as it can break existing data operations.
DATABRICKS_CATALOG_CATALOGS_DELETEAcciónTool to delete a catalog from Unity Catalog metastore. Use when you need to permanently remove a catalog and optionally its contents. By default, the catalog must be empty (except for information_schema). Use force=true to delete non-empty catalogs. Do not delete the main catalog as it can break existing data operations.
Parámetros de entrada
namestringObligatorioThe name of the catalog to delete. The caller must be a metastore admin or the owner of the catalog
forcebooleanForce deletion even if the catalog is not empty. When set to true, allows deletion of catalogs containing schemas and tables. When set to false or omitted, the catalog can only be deleted if it contains no schemas (except information_schema). Requires metastore owner/admin privileges and workspace admin privileges
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog DetailsDATABRICKS_CATALOG_CATALOGS_GETAcciónTool to retrieve details of a specific catalog in Unity Catalog. Use when you need to get information about a catalog including its metadata, owner, properties, and configuration. Requires metastore admin privileges, catalog ownership, or USE_CATALOG privilege.
DATABRICKS_CATALOG_CATALOGS_GETAcciónTool to retrieve details of a specific catalog in Unity Catalog. Use when you need to get information about a catalog including its metadata, owner, properties, and configuration. Requires metastore admin privileges, catalog ownership, or USE_CATALOG privilege.
Parámetros de entrada
namestringObligatorioThe name of the catalog to retrieve
include_browsebooleanWhether to include catalogs in the response for which the principal can only access selective metadata through the BROWSE privilege
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Catalog ConnectionDATABRICKS_CATALOG_CONNECTIONS_CREATEAcciónTool to create a new Unity Catalog connection to external data sources. Use when you need to establish connections to databases and services such as MySQL, PostgreSQL, Snowflake, etc. Requires metastore admin privileges or CREATE CONNECTION privilege on the metastore.
DATABRICKS_CATALOG_CONNECTIONS_CREATEAcciónTool to create a new Unity Catalog connection to external data sources. Use when you need to establish connections to databases and services such as MySQL, PostgreSQL, Snowflake, etc. Requires metastore admin privileges or CREATE CONNECTION privilege on the metastore.
Parámetros de entrada
namestringObligatorioName of the connection. This is the unique identifier for the connection within the metastore
commentstringUser-provided free-form text description of the connection
optionsobjectObligatorioA map of key-value properties containing connection-type specific parameters needed to establish the connection. Property keys must be unique and are case-sensitive. For example, for MYSQL connections include host, port, user, and password
read_onlybooleanIf true, the connection is read-only and cannot be used for write operations
propertiesobjectA map of key-value properties attached to the securable object for custom metadata
connection_typestringObligatorioenumThe type of connection to create. Must be one of the supported connection types
BIGQUERYDATABRICKSGA4_RAW_DATAGLUEHIVE_METASTOREHTTPMYSQLORACLEPOSTGRESQLPOWER_BIREDSHIFTSALESFORCE+7
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Catalog ConnectionDATABRICKS_CATALOG_CONNECTIONS_DELETEAcciónTool to delete a Unity Catalog connection to external data sources. Use when you need to remove connections to databases and services. Deleting a connection removes the abstraction used to connect from Databricks Compute to external data sources.
DATABRICKS_CATALOG_CONNECTIONS_DELETEAcciónTool to delete a Unity Catalog connection to external data sources. Use when you need to remove connections to databases and services. Deleting a connection removes the abstraction used to connect from Databricks Compute to external data sources.
Parámetros de entrada
namestringObligatorioThe name of the connection to delete. This is the unique identifier for the connection resource
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog ConnectionDATABRICKS_CATALOG_CONNECTIONS_GETAcciónTool to retrieve detailed information about a specific Unity Catalog connection. Use when you need to get connection metadata, configuration, and properties for external data source connections.
DATABRICKS_CATALOG_CONNECTIONS_GETAcciónTool to retrieve detailed information about a specific Unity Catalog connection. Use when you need to get connection metadata, configuration, and properties for external data source connections.
Parámetros de entrada
namestringObligatorioName of the connection to retrieve. This is the unique identifier for the connection within the metastore
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Catalog ConnectionDATABRICKS_CATALOG_CONNECTIONS_UPDATEAcciónTool to update an existing Unity Catalog connection configuration. Use when you need to modify connection properties, credentials, ownership, or metadata for external data sources.
DATABRICKS_CATALOG_CONNECTIONS_UPDATEAcciónTool to update an existing Unity Catalog connection configuration. Use when you need to modify connection properties, credentials, ownership, or metadata for external data sources.
Parámetros de entrada
ownerstringUsername of the new owner of the connection
commentstringUser-provided free-form text description of the connection
optionsobjectObligatorioA map of key-value properties containing connection-specific configuration. The exact keys depend on the connection type (e.g., for MySQL connections: host, port, user, password)
new_namestringNew name for the connection if renaming is desired
name_or_idstringObligatorioName or unique identifier of the connection to update
propertiesobjectAdditional key-value properties attached to the connection
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Catalog CredentialDATABRICKS_CATALOG_CREDENTIALS_CREATE_CREDENTIALAcciónTool to create a new credential for Unity Catalog access to cloud services. Use when you need to establish authentication for STORAGE (cloud storage) or SERVICE (external services like AWS Glue) purposes. Requires metastore admin or CREATE_STORAGE_CREDENTIAL/CREATE_SERVICE_CREDENTIAL privileges. Exactly one cloud credential type must be provided.
DATABRICKS_CATALOG_CREDENTIALS_CREATE_CREDENTIALAcciónTool to create a new credential for Unity Catalog access to cloud services. Use when you need to establish authentication for STORAGE (cloud storage) or SERVICE (external services like AWS Glue) purposes. Requires metastore admin or CREATE_STORAGE_CREDENTIAL/CREATE_SERVICE_CREDENTIAL privileges. Exactly one cloud credential type must be provided.
Parámetros de entrada
namestringObligatorioThe credential name. Must be unique among storage and service credentials within the metastore
commentstringComment associated with the credential
purposestringObligatorioenumIndicates the purpose of the credential. Valid values are SERVICE (for accessing external cloud services) or STORAGE (for accessing cloud storage locations)
SERVICESTORAGEread_onlybooleanWhether the credential is usable only for read operations. Only applicable when purpose is STORAGE
aws_iam_roleobjectAWS IAM role configuration for credential.
skip_validationbooleanSupplying true to this argument skips validation of the created credential
azure_managed_identityobjectAzure managed identity configuration for credential.
azure_service_principalobjectAzure service principal configuration for credential.
databricks_gcp_service_accountobjectGCP service account configuration for credential.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Catalog CredentialDATABRICKS_CATALOG_CREDENTIALS_DELETE_CREDENTIALAcciónTool to delete a Unity Catalog credential for cloud storage or service access. Use when you need to remove credentials that authenticate access to cloud resources. By default, deletion will fail if the credential has dependent resources. Use force=true to delete credentials with dependencies.
DATABRICKS_CATALOG_CREDENTIALS_DELETE_CREDENTIALAcciónTool to delete a Unity Catalog credential for cloud storage or service access. Use when you need to remove credentials that authenticate access to cloud resources. By default, deletion will fail if the credential has dependent resources. Use force=true to delete credentials with dependencies.
Parámetros de entrada
forcebooleanForce deletion even if there are dependent external locations or external tables (when purpose is STORAGE) or dependent services (when purpose is SERVICE). Default is false
credential_name_or_idstringObligatorioThe name or ID of the credential to delete. This is the unique identifier for the credential resource
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Temporary Service CredentialDATABRICKS_CATALOG_CREDENTIALS_GENERATE_TEMPORARY_SERVICE_CREDENTIALAcciónTool to generate temporary credentials from a service credential with admin access. Use when you need short-lived, scoped credentials for accessing cloud resources. The caller must be a metastore admin or have the ACCESS privilege on the service credential.
DATABRICKS_CATALOG_CREDENTIALS_GENERATE_TEMPORARY_SERVICE_CREDENTIALAcciónTool to generate temporary credentials from a service credential with admin access. Use when you need short-lived, scoped credentials for accessing cloud resources. The caller must be a metastore admin or have the ACCESS privilege on the service credential.
Parámetros de entrada
gcp_optionsobjectGCP-specific configuration options for temporary credential generation.
azure_optionsobjectAzure-specific configuration options for temporary credential generation.
credential_namestringObligatorioThe name of the service credential used to generate a temporary credential. The caller must be a metastore admin or have the metastore privilege ACCESS on the service credential
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog CredentialDATABRICKS_CATALOG_CREDENTIALS_GET_CREDENTIALAcciónTool to retrieve detailed information about a specific Unity Catalog credential. Use when you need to get credential metadata, configuration, and cloud provider details for storage or service credentials.
DATABRICKS_CATALOG_CREDENTIALS_GET_CREDENTIALAcciónTool to retrieve detailed information about a specific Unity Catalog credential. Use when you need to get credential metadata, configuration, and cloud provider details for storage or service credentials.
Parámetros de entrada
namestringObligatorioName of the credential to retrieve. This is the unique identifier for the credential within the metastore
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Catalog CredentialDATABRICKS_CATALOG_CREDENTIALS_UPDATE_CREDENTIALAcciónTool to update an existing Unity Catalog credential with new properties. Use when you need to modify credential configuration, ownership, or cloud provider settings. The caller must be the owner of the credential, a metastore admin, or have MANAGE permission on the credential. If the caller is a metastore admin, only the owner field can be changed.
DATABRICKS_CATALOG_CREDENTIALS_UPDATE_CREDENTIALAcciónTool to update an existing Unity Catalog credential with new properties. Use when you need to modify credential configuration, ownership, or cloud provider settings. The caller must be the owner of the credential, a metastore admin, or have MANAGE permission on the credential. If the caller is a metastore admin, only the owner field can be changed.
Parámetros de entrada
forcebooleanForce update even if there are dependent external locations or external tables
ownerstringUsername of the new owner of the credential. If the caller is a metastore admin, only this field can be changed
commentstringComment associated with the credential
new_namestringNew name for the credential
read_onlybooleanWhether the storage credential is only usable for read operations. Only applicable when purpose is STORAGE
name_or_idstringObligatorioThe name or ID of the credential to update. This is the unique identifier for the credential resource
aws_iam_roleobjectAWS IAM role configuration for credential.
isolation_modestringenumWhether the credential is accessible from all workspaces or a specific set of workspaces
ISOLATION_MODE_ISOLATEDISOLATION_MODE_OPENskip_validationbooleanSupplying true skips validation of the updated credential
cloudflare_api_tokenobjectCloudflare API token configuration for credential.
azure_managed_identityobjectAzure managed identity configuration for credential.
azure_service_principalobjectAzure service principal configuration for credential.
databricks_gcp_service_accountobjectGCP service account configuration for credential.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate Catalog CredentialDATABRICKS_CATALOG_CREDENTIALS_VALIDATE_CREDENTIALAcciónTool to validate a Unity Catalog credential for external access. Use when you need to verify that a credential can successfully perform its intended operations. For SERVICE credentials, validates cloud service access. For STORAGE credentials, tests READ, WRITE, DELETE, LIST operations on the specified location.
DATABRICKS_CATALOG_CREDENTIALS_VALIDATE_CREDENTIALAcciónTool to validate a Unity Catalog credential for external access. Use when you need to verify that a credential can successfully perform its intended operations. For SERVICE credentials, validates cloud service access. For STORAGE credentials, tests READ, WRITE, DELETE, LIST operations on the specified location.
Parámetros de entrada
urlstringThe external location URL to validate. Only applicable when purpose is STORAGE. If both url and external_location_name are provided, url takes precedence
purposestringenumThe purpose of the credential. Use SERVICE for accessing external cloud services or STORAGE for cloud storage locations. Determines which validation logic is applied
SERVICESTORAGEread_onlybooleanWhether the credential should be validated for read-only access. Only applicable when purpose is STORAGE
aws_iam_roleobjectAWS IAM role configuration for credential validation.
credential_namestringThe name of an existing credential to validate. Either this or a cloud-specific credential must be provided
cloudflare_api_tokenobjectCloudflare API token configuration for credential validation.
azure_managed_identityobjectAzure managed identity configuration for credential validation.
external_location_namestringThe name of an existing external location to validate. Only applicable when purpose is STORAGE. Either external_location_name or url must be provided for storage credentials
azure_service_principalobjectAzure service principal configuration for credential validation.
databricks_gcp_service_accountobjectGCP service account configuration for credential validation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Entity Tag AssignmentDATABRICKS_CATALOG_ENTITY_TAG_ASSIGNMENTS_GETAcciónTool to retrieve a specific tag assignment for a Unity Catalog entity by tag key. Use when you need to get details about a tag assigned to catalogs, schemas, tables, columns, or volumes. Requires USE CATALOG and USE SCHEMA permissions on parent resources, and ASSIGN or MANAGE permissions on the tag policy for governed tags.
DATABRICKS_CATALOG_ENTITY_TAG_ASSIGNMENTS_GETAcciónTool to retrieve a specific tag assignment for a Unity Catalog entity by tag key. Use when you need to get details about a tag assigned to catalogs, schemas, tables, columns, or volumes. Requires USE CATALOG and USE SCHEMA permissions on parent resources, and ASSIGN or MANAGE permissions on the tag policy for governed tags.
Parámetros de entrada
tag_keystringObligatorioThe key of the tag to retrieve
entity_namestringObligatorioThe fully qualified name of the entity to which the tag is assigned (e.g., 'samples.nyctaxi.trips' for a table)
entity_typestringObligatorioenumThe type of the entity to which the tag is assigned. Must be one of: catalogs, schemas, tables, columns, volumes
catalogsschemastablescolumnsvolumes
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create External LocationDATABRICKS_CATALOG_EXTERNAL_LOCATIONS_CREATEAcciónTool to create a new Unity Catalog external location combining a cloud storage path with a storage credential. Use when you need to establish access to cloud storage in Azure Data Lake Storage, AWS S3, or Cloudflare R2. Requires metastore admin or CREATE_EXTERNAL_LOCATION privilege on both the metastore and the associated storage credential.
DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_CREATEAcciónTool to create a new Unity Catalog external location combining a cloud storage path with a storage credential. Use when you need to establish access to cloud storage in Azure Data Lake Storage, AWS S3, or Cloudflare R2. Requires metastore admin or CREATE_EXTERNAL_LOCATION privilege on both the metastore and the associated storage credential.
Parámetros de entrada
urlstringObligatorioPath URL of the external location (e.g., s3://bucket-name/path, abfss://container@storage.dfs.core.windows.net/path, gs://bucket-name/path)
namestringObligatorioName of the external location. This is the identifier used to reference the location
commentstringUser-provided free-form text description of the external location
fallbackbooleanAllows fallback to cluster credentials when Unity Catalog credentials are insufficient. Enables support for legacy workloads
read_onlybooleanIndicates whether the external location is read-only. When true, restricts the location to read-only access. Default is false
credential_namestringObligatorioName of the storage credential to use with this location. The credential authorizes access to the cloud storage path
skip_validationbooleanSkips validation of the storage credential associated with the external location. Default is false
file_event_queueobjectFile event queue configuration.
enable_file_eventsbooleanWhether to enable file event tracking at this location. If enabled, file_event_queue must be provided
encryption_detailsobjectServer-side encryption configuration for AWS S3 communication.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete External LocationDATABRICKS_CATALOG_EXTERNAL_LOCATIONS_DELETEAcciónTool to delete an external location from Unity Catalog metastore. Use when you need to remove an external location that combines a cloud storage path with a storage credential. The caller must be the owner of the external location. Use force=true to delete even if there are dependent external tables or mounts.
DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_DELETEAcciónTool to delete an external location from Unity Catalog metastore. Use when you need to remove an external location that combines a cloud storage path with a storage credential. The caller must be the owner of the external location. Use force=true to delete even if there are dependent external tables or mounts.
Parámetros de entrada
namestringObligatorioThe name of the external location to delete. External location names are unqualified and must be unique within the metastore. The caller must be the owner of the external location to perform this operation
forcebooleanForce deletion even if there are dependent external tables or mounts. When set to true, the operation will proceed despite any dependencies. When false or omitted, the deletion will fail if dependencies exist. Default: false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get External Location DetailsDATABRICKS_CATALOG_EXTERNAL_LOCATIONS_GETAcciónTool to retrieve details of a specific Unity Catalog external location. Use when you need to get information about an external location including its URL, storage credential, and configuration. Requires metastore admin privileges, external location ownership, or appropriate privileges on the external location.
DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_GETAcciónTool to retrieve details of a specific Unity Catalog external location. Use when you need to get information about an external location including its URL, storage credential, and configuration. Requires metastore admin privileges, external location ownership, or appropriate privileges on the external location.
Parámetros de entrada
namestringObligatorioName or identifier of the external location to retrieve
include_browsebooleanWhether to include external locations in the response for which the principal can only access selective metadata through the BROWSE privilege
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update External LocationDATABRICKS_CATALOG_EXTERNAL_LOCATIONS_UPDATEAcciónTool to update an existing Unity Catalog external location properties. Use when you need to modify the cloud storage path, credentials, ownership, or configuration of an external location. The caller must be the owner of the external location or a metastore admin. Use force parameter to update even if URL changes invalidate dependencies.
DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_UPDATEAcciónTool to update an existing Unity Catalog external location properties. Use when you need to modify the cloud storage path, credentials, ownership, or configuration of an external location. The caller must be the owner of the external location or a metastore admin. Use force parameter to update even if URL changes invalidate dependencies.
Parámetros de entrada
urlstringCloud storage path URL (e.g., s3://bucket-name/path, abfss://container@storage.dfs.core.windows.net/path, gs://bucket-name/path)
namestringObligatorioName or identifier of the external location to update
forcebooleanForce update even if changing URL invalidates dependent external tables or mounts. Use with caution as this may break existing dependencies
ownerstringUsername, group name, or service principal name/ID for ownership assignment
commentstringUser-provided free-form text description
fallbackbooleanEnable fallback to cluster credentials for access when Unity Catalog credentials are insufficient
new_namestringNew name for the external location if renaming is desired
read_onlybooleanWhether the external location is read-only. When true, restricts write access to the location
isolation_modestringIsolation configuration. Use 'ISOLATION_MODE_ISOLATED' for isolated mode or 'ISOLATION_MODE_OPEN' for open mode
credential_namestringName of the storage credential to use with this location
skip_validationbooleanSuppress validation errors and force save the external location. Bypasses storage credential validation during update
file_event_queueobjectFile event queue configuration.
enable_file_eventsbooleanActivate managed file events for this location. If enabled, file_event_queue must be provided
encryption_detailsobjectServer-side encryption configuration for AWS S3 communication.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update External MetadataDATABRICKS_CATALOG_EXTERNAL_METADATA_UPDATE_EXTERNAL_METADATAAcciónTool to update an external metadata object in Unity Catalog. Use when you need to modify metadata about external systems registered within Unity Catalog. The user must have metastore admin status, own the object, or possess the MODIFY privilege. Note that changing ownership requires the MANAGE privilege, and callers cannot update both the owner and other metadata in a single request.
DATABRICKS_CATALOG_EXTERNAL_METADATA_UPDATE_EXTERNAL_METADATAAcciónTool to update an external metadata object in Unity Catalog. Use when you need to modify metadata about external systems registered within Unity Catalog. The user must have metastore admin status, own the object, or possess the MODIFY privilege. Note that changing ownership requires the MANAGE privilege, and callers cannot update both the owner and other metadata in a single request.
Parámetros de entrada
idstringObligatorioUnique identifier of the external metadata object to be modified
urlstringURL associated with the external metadata object
namestringName of the external metadata object
ownerstringOwner of the external metadata object. Cannot be updated with other fields in the same request
columnsstring[]List of columns associated with the external metadata object
propertiesobjectKey-value properties attached to the external metadata object
descriptionstringUser-provided free-form text description
entity_typestringType of entity within the external system
system_typestringType of external system (e.g., DATABRICKS, SNOWFLAKE, BIGQUERY)
update_maskstringObligatorioA comma-separated list of field names to update (e.g., 'name', 'description', 'properties'). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). A wildcard (*) signals complete replacement, though explicit field listing is recommended to prevent unintended changes if the API evolves
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Catalog FunctionDATABRICKS_CATALOG_FUNCTIONS_UPDATEAcciónTool to update function owner in Unity Catalog. Use when you need to change the ownership of a catalog function. Only the owner of the function can be updated via this endpoint. The caller must be a metastore admin, the owner of the function's parent catalog, the owner of the parent schema with USE_CATALOG privilege, or the owner of the function with both USE_CATALOG and USE_SCHEMA privileges.
DATABRICKS_CATALOG_FUNCTIONS_UPDATEAcciónTool to update function owner in Unity Catalog. Use when you need to change the ownership of a catalog function. Only the owner of the function can be updated via this endpoint. The caller must be a metastore admin, the owner of the function's parent catalog, the owner of the parent schema with USE_CATALOG privilege, or the owner of the function with both USE_CATALOG and USE_SCHEMA privileges.
Parámetros de entrada
namestringObligatorioThe fully-qualified name of the function in the form catalog_name.schema_name.function_name
ownerstringUsername of the new owner of the function. This is the only field that can be updated via this endpoint
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog GrantsDATABRICKS_CATALOG_GRANTS_GETAcciónTool to get permissions (grants) for a securable in Unity Catalog without inherited permissions. Use when you need to see direct privilege assignments on a catalog or other securable object. Returns only privileges directly assigned to principals, excluding inherited permissions from parent securables. For inherited permissions, use the get-effective endpoint instead.
DATABRICKS_CATALOG_GRANTS_GETAcciónTool to get permissions (grants) for a securable in Unity Catalog without inherited permissions. Use when you need to see direct privilege assignments on a catalog or other securable object. Returns only privileges directly assigned to principals, excluding inherited permissions from parent securables. For inherited permissions, use the get-effective endpoint instead.
Parámetros de entrada
full_namestringObligatorioFull name of the securable. For catalog: 'my_catalog', for table: 'catalog.schema.table'
principalstringIf provided, only the permissions for the specified principal (user email, group name, or service principal) are returned
page_tokenstringOpaque token for retrieving the next page of results
max_resultsintegerMaximum number of privileges to return per page. Must be 0 or >= 150. Values between 1-149 are invalid. Default: 0 (server-determined page size). Using pagination is recommended as unpaginated calls will be deprecated
securable_typestringObligatorioType of securable object. For catalogs, use 'catalog'. Valid values: catalog, schema, table, metastore, volume, function, model, connection, share, recipient, provider, storage_credential, external_location
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Effective Catalog PermissionsDATABRICKS_CATALOG_GRANTS_GET_EFFECTIVEAcciónTool to get effective permissions for a securable in Unity Catalog, including inherited permissions from parent securables. Use when you need to understand what privileges are granted to principals through direct assignments or inheritance. Returns privileges conveyed to each principal through the Unity Catalog hierarchy (metastore → catalog → schema → table/view/volume).
DATABRICKS_CATALOG_GRANTS_GET_EFFECTIVEAcciónTool to get effective permissions for a securable in Unity Catalog, including inherited permissions from parent securables. Use when you need to understand what privileges are granted to principals through direct assignments or inheritance. Returns privileges conveyed to each principal through the Unity Catalog hierarchy (metastore → catalog → schema → table/view/volume).
Parámetros de entrada
full_namestringObligatorioFull name of the securable. For catalog: 'my_catalog', for table: 'catalog.schema.table'
principalstringIf provided, only the effective permissions for the specified principal (user email or group name) are returned
page_tokenstringOpaque token for retrieving the next page of results
max_resultsintegerMaximum number of privileges to return per page. Set to 0 to use server default. Valid values >= 150. Using pagination is recommended as unpaginated calls will be deprecated
securable_typestringObligatorioType of securable object. Valid values: CATALOG, SCHEMA, TABLE, METASTORE, VOLUME, FUNCTION, MODEL, CONNECTION, SHARE, RECIPIENT, PROVIDER, STORAGE_CREDENTIAL, EXTERNAL_LOCATION
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Catalog GrantsDATABRICKS_CATALOG_GRANTS_UPDATEAcciónTool to update permissions for Unity Catalog securables by adding or removing privileges for principals. Use when you need to grant or revoke permissions on catalogs, schemas, tables, or other Unity Catalog objects. Only metastore admins, object owners, users with MANAGE privilege, or parent catalog/schema owners can update permissions.
DATABRICKS_CATALOG_GRANTS_UPDATEAcciónTool to update permissions for Unity Catalog securables by adding or removing privileges for principals. Use when you need to grant or revoke permissions on catalogs, schemas, tables, or other Unity Catalog objects. Only metastore admins, object owners, users with MANAGE privilege, or parent catalog/schema owners can update permissions.
Parámetros de entrada
changesobject[]ObligatorioArray of permission changes to apply. Each change specifies a principal and which privileges to add or remove for that principal
full_namestringObligatorioFull name of the securable. For catalog: 'my_catalog', for schema: 'catalog.schema', for table: 'catalog.schema.table'
securable_typestringObligatorioType of securable object. Valid values: CATALOG, SCHEMA, TABLE, VIEW, MATERIALIZED_VIEW, VOLUME, FUNCTION, PROCEDURE, METASTORE, CONNECTION, CLEAN_ROOM, EXTERNAL_LOCATION, EXTERNAL_METADATA, STORAGE_CREDENTIAL, SERVICE_CREDENTIAL, SHARE
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Assign Metastore to WorkspaceDATABRICKS_CATALOG_METASTORES_ASSIGNAcciónTool to assign a Unity Catalog metastore to a workspace. Use when you need to link a workspace to a Unity Catalog metastore, enabling shared data access with consistent governance policies. Requires account admin privileges. If an assignment for the same workspace_id exists, it will be overwritten by the new metastore_id and default_catalog_name.
DATABRICKS_CATALOG_METASTORES_ASSIGNAcciónTool to assign a Unity Catalog metastore to a workspace. Use when you need to link a workspace to a Unity Catalog metastore, enabling shared data access with consistent governance policies. Requires account admin privileges. If an assignment for the same workspace_id exists, it will be overwritten by the new metastore_id and default_catalog_name.
Parámetros de entrada
metastore_idstringObligatorioThe unique ID of the metastore to assign. Unique identifier of the parent metastore to assign to the workspace
workspace_idintegerObligatorioThe unique workspace identifier. The ID of the workspace to assign the metastore to
default_catalog_namestringThe name of the default catalog in the metastore. DEPRECATED: Use the Default Namespace API (databricks.DefaultNamespaceSetting) to configure the default catalog for a Databricks workspace instead
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create MetastoreDATABRICKS_CATALOG_METASTORES_CREATEAcciónTool to create a new Unity Catalog metastore. Use when you need to establish a top-level container for data in Unity Catalog, registering metadata about securable objects (tables, volumes, external locations, shares) and access permissions. Requires account admin privileges. By default, the owner is the user calling the API; setting owner to empty string assigns ownership to System User.
DATABRICKS_CATALOG_METASTORES_CREATEAcciónTool to create a new Unity Catalog metastore. Use when you need to establish a top-level container for data in Unity Catalog, registering metadata about securable objects (tables, volumes, external locations, shares) and access permissions. Requires account admin privileges. By default, the owner is the user calling the API; setting owner to empty string assigns ownership to System User.
Parámetros de entrada
namestringObligatorioThe user-specified name of the metastore. Must be unique within the region
cloudstringCloud provider identifier
ownerstringUsername/groupname/service principal application_id of the metastore owner. Empty string assigns to System User
regionstringCloud region which the metastore serves (e.g., us-west-2, westus)
storage_rootstringThe storage root URL for metastore (supports S3, Azure Blob, GCS paths)
delta_sharing_scopestringenumScope of Delta Sharing enabled for the metastore
INTERNALINTERNAL_AND_EXTERNALstorage_root_credential_idstringUUID of the storage credential used to access the metastore storage root
default_data_access_config_idstringDefault data access configuration ID
delta_sharing_organization_namestringOrganization name of a Delta Sharing entity for Databricks-to-Databricks Delta Sharing. Cannot be removed once set
delta_sharing_recipient_token_lifetime_in_secondsintegerLifetime of delta sharing recipient token in seconds. Set to 0 for unlimited
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Current Metastore AssignmentDATABRICKS_CATALOG_METASTORES_CURRENTAcciónTool to retrieve the current metastore assignment for the workspace being accessed. Use when you need to determine which metastore is assigned to the current workspace context.
DATABRICKS_CATALOG_METASTORES_CURRENTAcciónTool to retrieve the current metastore assignment for the workspace being accessed. Use when you need to determine which metastore is assigned to the current workspace context.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete MetastoreDATABRICKS_CATALOG_METASTORES_DELETEAcciónTool to delete a Unity Catalog metastore. Use when you need to permanently remove a metastore and its managed data. Before deletion, you must delete or unlink any workspaces using the metastore. All objects managed by the metastore will become inaccessible. Requires metastore admin privileges.
DATABRICKS_CATALOG_METASTORES_DELETEAcciónTool to delete a Unity Catalog metastore. Use when you need to permanently remove a metastore and its managed data. Before deletion, you must delete or unlink any workspaces using the metastore. All objects managed by the metastore will become inaccessible. Requires metastore admin privileges.
Parámetros de entrada
idstringObligatorioUnique identifier of the metastore to delete. The caller must be a metastore admin
forcebooleanForce deletion even if the metastore is not empty. When set to true, allows deletion of metastores containing data assets like tables and views, bypassing the default safety check. Default is false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Metastore DetailsDATABRICKS_CATALOG_METASTORES_GETAcciónTool to retrieve detailed information about a specific Unity Catalog metastore by its ID. Use when you need to get metastore configuration, ownership, storage settings, and Delta Sharing details. Requires metastore admin permissions.
DATABRICKS_CATALOG_METASTORES_GETAcciónTool to retrieve detailed information about a specific Unity Catalog metastore by its ID. Use when you need to get metastore configuration, ownership, storage settings, and Delta Sharing details. Requires metastore admin permissions.
Parámetros de entrada
idstringObligatorioUnique identifier of the metastore to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Metastore SummaryDATABRICKS_CATALOG_METASTORES_SUMMARYAcciónTool to retrieve summary information about the metastore associated with the current workspace. Use when you need metastore configuration overview including cloud vendor, region, storage, and Delta Sharing details.
DATABRICKS_CATALOG_METASTORES_SUMMARYAcciónTool to retrieve summary information about the metastore associated with the current workspace. Use when you need metastore configuration overview including cloud vendor, region, storage, and Delta Sharing details.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unassign Metastore from WorkspaceDATABRICKS_CATALOG_METASTORES_UNASSIGNAcciónTool to unassign a Unity Catalog metastore from a workspace. Use when you need to remove the association between a workspace and its assigned metastore, leaving the workspace with no metastore. The metastore itself is not deleted, only the workspace assignment is removed. Requires account admin privileges.
DATABRICKS_CATALOG_METASTORES_UNASSIGNAcciónTool to unassign a Unity Catalog metastore from a workspace. Use when you need to remove the association between a workspace and its assigned metastore, leaving the workspace with no metastore. The metastore itself is not deleted, only the workspace assignment is removed. Requires account admin privileges.
Parámetros de entrada
metastore_idstringObligatorioThe unique identifier of the Unity Catalog metastore to unassign from the workspace. This identifies which metastore assignment to remove
workspace_idintegerObligatorioThe unique identifier of the workspace from which to unassign the metastore. This is the ID of the workspace to remove the metastore assignment from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update MetastoreDATABRICKS_CATALOG_METASTORES_UPDATEAcciónTool to update configuration settings for an existing Unity Catalog metastore. Use when you need to modify metastore properties like name, owner, Delta Sharing settings, or storage credentials. Requires metastore admin permissions.
DATABRICKS_CATALOG_METASTORES_UPDATEAcciónTool to update configuration settings for an existing Unity Catalog metastore. Use when you need to modify metastore properties like name, owner, Delta Sharing settings, or storage credentials. Requires metastore admin permissions.
Parámetros de entrada
idstringObligatorioUnique identifier of the metastore to update
ownerstringThe owner of the metastore. If set to empty string, ownership is updated to the System User
new_namestringNew name for the metastore
delta_sharing_scopestringenumThe scope of Delta Sharing enabled for the metastore
INTERNALINTERNAL_AND_EXTERNALexternal_access_enabledbooleanControls external data access on the metastore
privilege_model_versionstringPrivilege model version of the metastore, of the form major.minor (e.g., 1.0)
storage_root_credential_idstringUUID of storage credential to access the metastore storage_root
delta_sharing_organization_namestringThe organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name
delta_sharing_recipient_token_lifetime_in_secondsintegerThe lifetime of delta sharing recipient token in seconds
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Metastore AssignmentDATABRICKS_CATALOG_METASTORES_UPDATE_ASSIGNMENTAcciónTool to update a metastore assignment for a workspace. Use when you need to update the metastore_id or default_catalog_name for a workspace that already has a metastore assigned. Account admin privileges are required to update metastore_id, while workspace admin can update default_catalog_name.
DATABRICKS_CATALOG_METASTORES_UPDATE_ASSIGNMENTAcciónTool to update a metastore assignment for a workspace. Use when you need to update the metastore_id or default_catalog_name for a workspace that already has a metastore assigned. Account admin privileges are required to update metastore_id, while workspace admin can update default_catalog_name.
Parámetros de entrada
metastore_idstringThe unique ID of the metastore to assign. Updates the metastore assigned to the workspace. The caller must be an account admin to update this field
workspace_idintegerObligatorioThe unique workspace identifier. A workspace ID to update the metastore assignment for
default_catalog_namestringThe name of the default catalog in the metastore. DEPRECATED: Use the Default Namespace API to configure the default catalog for a Databricks workspace instead
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Model VersionDATABRICKS_CATALOG_MODEL_VERSIONS_GETAcciónTool to retrieve detailed information about a specific version of a registered model in Unity Catalog. Use when you need to get metadata, status, source location, and configuration of a model version. Requires metastore admin privileges, model ownership, or EXECUTE privilege on the registered model with appropriate catalog and schema privileges.
DATABRICKS_CATALOG_MODEL_VERSIONS_GETAcciónTool to retrieve detailed information about a specific version of a registered model in Unity Catalog. Use when you need to get metadata, status, source location, and configuration of a model version. Requires metastore admin privileges, model ownership, or EXECUTE privilege on the registered model with appropriate catalog and schema privileges.
Parámetros de entrada
versionintegerObligatorioThe integer version number of the model version to retrieve
full_namestringObligatorioThe three-level (fully qualified) name of the model (format: catalog.schema.model_name)
include_browsebooleanWhether to include model versions for which the principal can only access selective metadata
include_aliasesbooleanWhether to include aliases associated with the model version
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Model VersionDATABRICKS_CATALOG_MODEL_VERSIONS_UPDATEAcciónTool to update a Unity Catalog model version. Use when you need to modify the comment of a specific model version. Currently only the comment field can be updated. The caller must be a metastore admin or owner of the parent registered model with appropriate catalog and schema privileges.
DATABRICKS_CATALOG_MODEL_VERSIONS_UPDATEAcciónTool to update a Unity Catalog model version. Use when you need to modify the comment of a specific model version. Currently only the comment field can be updated. The caller must be a metastore admin or owner of the parent registered model with appropriate catalog and schema privileges.
Parámetros de entrada
commentstringThe comment attached to the model version. Currently this is the only field that can be updated
versionintegerObligatorioThe integer version number of the model version to update
full_namestringObligatorioThe three-level (fully qualified) name of the model (e.g., 'catalog.schema.model_name')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Online TableDATABRICKS_CATALOG_ONLINE_TABLES_DELETEAcciónTool to delete an online table by name. Use when you need to permanently remove an online table and stop data synchronization. This operation deletes all data in the online table permanently and releases all resources. Note: online tables are deprecated and will not be accessible after January 15, 2026.
DATABRICKS_CATALOG_ONLINE_TABLES_DELETEAcciónTool to delete an online table by name. Use when you need to permanently remove an online table and stop data synchronization. This operation deletes all data in the online table permanently and releases all resources. Note: online tables are deprecated and will not be accessible after January 15, 2026.
Parámetros de entrada
namestringObligatorioFull three-part (catalog, schema, table) name of the online table to delete. Format: 'catalog.schema.table_name'. The user must be the owner of both the offline table and online table to perform this operation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Quality MonitorDATABRICKS_CATALOG_QUALITY_MONITORS_GETAcciónTool to retrieve quality monitor configuration for a Unity Catalog table. Use when you need to get monitor status, metrics tables, custom metrics, notifications, scheduling, and monitoring configuration details. Requires catalog and schema privileges plus SELECT on the table.
DATABRICKS_CATALOG_QUALITY_MONITORS_GETAcciónTool to retrieve quality monitor configuration for a Unity Catalog table. Use when you need to get monitor status, metrics tables, custom metrics, notifications, scheduling, and monitoring configuration details. Requires catalog and schema privileges plus SELECT on the table.
Parámetros de entrada
table_namestringObligatorioUnity Catalog table name in format 'catalog.schema.table_name'. Case insensitive, spaces disallowed
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Quality Monitor RefreshesDATABRICKS_CATALOG_QUALITY_MONITORS_LIST_REFRESHESAcciónTool to retrieve the refresh history for a quality monitor on a Unity Catalog table. Use when you need to check the status and history of monitor refresh operations. Returns up to 25 most recent refreshes including their state, timing, and status messages.
DATABRICKS_CATALOG_QUALITY_MONITORS_LIST_REFRESHESAcciónTool to retrieve the refresh history for a quality monitor on a Unity Catalog table. Use when you need to check the status and history of monitor refresh operations. Returns up to 25 most recent refreshes including their state, timing, and status messages.
Parámetros de entrada
table_namestringObligatorioFull name of the table in Unity Catalog format (catalog.schema.table_name). This is the table that has a quality monitor attached. Example: 'samples.nyctaxi.trips'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Registered ModelDATABRICKS_CATALOG_REGISTERED_MODELS_GETAcciónTool to retrieve detailed information about a registered model in Unity Catalog. Use when you need to get metadata, owner, storage location, and configuration of a registered model. Requires metastore admin privileges, model ownership, or EXECUTE privilege on the registered model with appropriate catalog and schema privileges.
DATABRICKS_CATALOG_REGISTERED_MODELS_GETAcciónTool to retrieve detailed information about a registered model in Unity Catalog. Use when you need to get metadata, owner, storage location, and configuration of a registered model. Requires metastore admin privileges, model ownership, or EXECUTE privilege on the registered model with appropriate catalog and schema privileges.
Parámetros de entrada
full_namestringObligatorioThe three-level (fully qualified) name of the registered model in the format catalog.schema.model_name
include_browsebooleanWhether to include models where the principal has selective metadata access through the BROWSE privilege
include_aliasesbooleanWhether to include registered model aliases in the response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Resource Quota InformationDATABRICKS_CATALOG_RESOURCE_QUOTAS_GET_QUOTAAcciónTool to retrieve usage information for a Unity Catalog resource quota defined by a child-parent pair. Use when you need to check quota usage for a specific resource type (tables per metastore, schemas per catalog, etc.). The API also triggers an asynchronous refresh if the count is out of date. Requires account admin authentication with OAuth.
DATABRICKS_CATALOG_RESOURCE_QUOTAS_GET_QUOTAAcciónTool to retrieve usage information for a Unity Catalog resource quota defined by a child-parent pair. Use when you need to check quota usage for a specific resource type (tables per metastore, schemas per catalog, etc.). The API also triggers an asynchronous refresh if the count is out of date. Requires account admin authentication with OAuth.
Parámetros de entrada
quota_namestringObligatorioName of the quota. Follows the pattern of the quota type, with '-quota' added as a suffix. The child object (table, schema, share, etc.) suffixed by '-quota'.
parent_full_namestringObligatorioFull name of the parent resource. For example, the 'main.default' schema or 'samples' catalog. If the parent is a metastore, use the metastore ID.
parent_securable_typestringObligatorioenumSecurable type of the quota parent. Type of the parent object. Valid values include: CATALOG, SCHEMA, METASTORE.
CATALOGSCHEMAMETASTORE
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Batch Create Access RequestsDATABRICKS_CATALOG_RFA_BATCH_CREATE_ACCESS_REQUESTSAcciónTool to batch create access requests for Unity Catalog permissions. Use when you need to request access to catalogs, schemas, tables, or other Unity Catalog securables. Maximum 30 requests per API call, and maximum 30 securables per principal per call.
DATABRICKS_CATALOG_RFA_BATCH_CREATE_ACCESS_REQUESTSAcciónTool to batch create access requests for Unity Catalog permissions. Use when you need to request access to catalogs, schemas, tables, or other Unity Catalog securables. Maximum 30 requests per API call, and maximum 30 securables per principal per call.
Parámetros de entrada
requestsobject[]ObligatorioList of individual access requests. Maximum 30 requests per API call
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Access Request DestinationsDATABRICKS_CATALOG_RFA_GET_ACCESS_REQUEST_DESTINATIONSAcciónTool to retrieve access request destinations for a Unity Catalog securable. Use when you need to find where notifications are sent when users request access to catalogs, schemas, tables, or other securables. Any caller can see URL destinations or destinations on the metastore. For other securables, only those with BROWSE permissions can see destinations.
DATABRICKS_CATALOG_RFA_GET_ACCESS_REQUEST_DESTINATIONSAcciónTool to retrieve access request destinations for a Unity Catalog securable. Use when you need to find where notifications are sent when users request access to catalogs, schemas, tables, or other securables. Any caller can see URL destinations or destinations on the metastore. For other securables, only those with BROWSE permissions can see destinations.
Parámetros de entrada
full_namestringObligatorioThe complete identifier path of the securable resource. For a catalog, this is the catalog name (e.g., 'samples'). For a schema, it's 'catalog_name.schema_name'. For a table, it's 'catalog_name.schema_name.table_name'
securable_typestringObligatorioenumThe type of the securable object. Supported values: metastore, catalog, schema, table, external_location, connection, credential, function, registered_model, volume
metastorecatalogschematableexternal_locationconnectioncredentialfunctionregistered_modelvolume
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Access Request DestinationsDATABRICKS_CATALOG_RFA_UPDATE_ACCESS_REQUEST_DESTINATIONSAcciónTool to update access request notification destinations for Unity Catalog securables. Use when you need to configure where access request notifications are sent for catalogs, schemas, or external locations. Requires metastore admin, owner privileges, or MANAGE permission on the securable. Maximum 5 emails and 5 external destinations allowed per securable.
DATABRICKS_CATALOG_RFA_UPDATE_ACCESS_REQUEST_DESTINATIONSAcciónTool to update access request notification destinations for Unity Catalog securables. Use when you need to configure where access request notifications are sent for catalogs, schemas, or external locations. Requires metastore admin, owner privileges, or MANAGE permission on the securable. Maximum 5 emails and 5 external destinations allowed per securable.
Parámetros de entrada
securableobjectObligatorioThe securable object for which to update access request destinations
update_maskstringField mask indicating which fields to update. Use 'destinations' to update the destinations list
destinationsobject[]ObligatorioThe list of notification destinations for access requests. Maximum 5 emails and 5 external notification destinations. If a URL destination is assigned, no other destinations can be set
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog SchemaDATABRICKS_CATALOG_SCHEMAS_GETAcciónTool to retrieve details of a specific schema from Unity Catalog metastore. Use when you need to get schema metadata, ownership, storage configuration, and properties. Requires metastore admin privileges, schema ownership, or USE_SCHEMA privilege.
DATABRICKS_CATALOG_SCHEMAS_GETAcciónTool to retrieve details of a specific schema from Unity Catalog metastore. Use when you need to get schema metadata, ownership, storage configuration, and properties. Requires metastore admin privileges, schema ownership, or USE_SCHEMA privilege.
Parámetros de entrada
full_namestringObligatorioFull name of the schema in the format 'catalog_name.schema_name' (e.g., 'main.analytics' or 'samples.nyctaxi')
include_browsebooleanWhether to include schemas in the response for which the principal can only access selective metadata via BROWSE privilege
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Storage CredentialDATABRICKS_CATALOG_STORAGE_CREDENTIALS_CREATEAcciónTool to create a new storage credential in Unity Catalog for cloud data access. Use when you need to establish authentication for accessing cloud storage paths. Requires metastore admin or CREATE_STORAGE_CREDENTIAL privilege on the metastore. Exactly one cloud credential type must be provided.
DATABRICKS_CATALOG_STORAGE_CREDENTIALS_CREATEAcciónTool to create a new storage credential in Unity Catalog for cloud data access. Use when you need to establish authentication for accessing cloud storage paths. Requires metastore admin or CREATE_STORAGE_CREDENTIAL privilege on the metastore. Exactly one cloud credential type must be provided.
Parámetros de entrada
namestringObligatorioThe credential name. Must be unique among storage and service credentials within the metastore
commentstringComment associated with the credential
read_onlybooleanWhether the credential is usable only for read operations. Only applicable when purpose is STORAGE
aws_iam_roleobjectAWS IAM role configuration for storage credential.
skip_validationbooleanSupplying true skips validation of the created credential
cloudflare_api_tokenobjectCloudflare API token configuration for storage credential.
azure_managed_identityobjectAzure managed identity configuration for storage credential.
azure_service_principalobjectAzure service principal configuration for storage credential.
databricks_gcp_service_accountobjectGCP service account configuration for storage credential.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Storage CredentialDATABRICKS_CATALOG_STORAGE_CREDENTIALS_DELETEAcciónTool to delete a storage credential from the Unity Catalog metastore. Use when you need to remove storage credentials that provide authentication to cloud storage. The caller must be the owner of the storage credential. Use force=true to delete even if there are dependent external locations, tables, or services.
DATABRICKS_CATALOG_STORAGE_CREDENTIALS_DELETEAcciónTool to delete a storage credential from the Unity Catalog metastore. Use when you need to remove storage credentials that provide authentication to cloud storage. The caller must be the owner of the storage credential. Use force=true to delete even if there are dependent external locations, tables, or services.
Parámetros de entrada
namestringObligatorioThe name of the storage credential to delete. The caller must be the owner of the storage credential to perform this operation
forcebooleanForce deletion even if there are dependent external locations or external tables (when purpose is STORAGE) or dependent services (when purpose is SERVICE). When set to true, the operation will proceed despite any dependencies. When false or omitted, the deletion will fail if dependencies exist. Default: false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Storage CredentialDATABRICKS_CATALOG_STORAGE_CREDENTIALS_GETAcciónTool to retrieve storage credential details from Unity Catalog metastore by name. Use when you need to get information about a storage credential's configuration and properties. Requires metastore admin privileges, credential ownership, or appropriate permissions on the storage credential.
DATABRICKS_CATALOG_STORAGE_CREDENTIALS_GETAcciónTool to retrieve storage credential details from Unity Catalog metastore by name. Use when you need to get information about a storage credential's configuration and properties. Requires metastore admin privileges, credential ownership, or appropriate permissions on the storage credential.
Parámetros de entrada
namestringObligatorioName of the storage credential to retrieve. Must be unique within the metastore
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Storage CredentialDATABRICKS_CATALOG_STORAGE_CREDENTIALS_UPDATEAcciónTool to update an existing storage credential in Unity Catalog. Use when you need to modify credential properties, cloud provider configuration, or ownership. The caller must be the owner of the storage credential or a metastore admin. Metastore admins can only modify the owner field.
DATABRICKS_CATALOG_STORAGE_CREDENTIALS_UPDATEAcciónTool to update an existing storage credential in Unity Catalog. Use when you need to modify credential properties, cloud provider configuration, or ownership. The caller must be the owner of the storage credential or a metastore admin. Metastore admins can only modify the owner field.
Parámetros de entrada
namestringObligatorioThe name of the storage credential to update. This is used in the path parameter to identify the credential
forcebooleanForce update even if there are dependent external locations, external tables (when purpose is STORAGE), or dependent services (when purpose is SERVICE)
ownerstringUsername, group name, or service principal application_id of the storage credential owner. Metastore admins can only change this field
commentstringComment associated with the credential
new_namestringNew name for the storage credential if renaming is desired
read_onlybooleanWhether the credential is usable only for read operations. Only applicable when purpose is STORAGE
aws_iam_roleobjectAWS IAM role configuration for storage credential.
isolation_modestringWhether the current securable is accessible from all workspaces or a specific set. Use 'ISOLATION_MODE_ISOLATED' or 'ISOLATION_MODE_OPEN'
skip_validationbooleanSkip validation of the updated credential
cloudflare_api_tokenobjectCloudflare API token configuration for storage credential.
azure_managed_identityobjectAzure managed identity configuration for storage credential.
azure_service_principalobjectAzure service principal configuration for storage credential.
databricks_gcp_service_accountobjectGCP service account configuration for storage credential.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate Storage CredentialDATABRICKS_CATALOG_STORAGE_CREDENTIALS_VALIDATEAcciónTool to validate a storage credential configuration for Unity Catalog. Use when you need to verify that a storage credential can successfully access a cloud storage location. Requires metastore admin, storage credential owner, or CREATE_EXTERNAL_LOCATION privilege.
DATABRICKS_CATALOG_STORAGE_CREDENTIALS_VALIDATEAcciónTool to validate a storage credential configuration for Unity Catalog. Use when you need to verify that a storage credential can successfully access a cloud storage location. Requires metastore admin, storage credential owner, or CREATE_EXTERNAL_LOCATION privilege.
Parámetros de entrada
urlstringThe external location URL to validate. At least one of external_location_name or url must be provided. If both are provided, url will be used for validation
read_onlybooleanWhether the storage credential is usable only for read operations
aws_iam_roleobjectAWS IAM role configuration for storage credential validation.
cloudflare_api_tokenobjectCloudflare API token configuration for storage credential validation.
azure_managed_identityobjectAzure managed identity configuration for storage credential validation.
external_location_namestringName of an existing external location to validate. At least one of external_location_name or url must be provided
azure_service_principalobjectAzure service principal configuration for storage credential validation.
storage_credential_namestringName of an existing storage credential to validate. Either this or a cloud-specific credential must be provided
databricks_gcp_service_accountobjectGCP service account configuration for storage credential validation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Disable System SchemaDATABRICKS_CATALOG_SYSTEM_SCHEMAS_DISABLEAcciónTool to disable a system schema in Unity Catalog metastore. Use when you need to remove a system schema from the system catalog. System schemas store information about customer usage patterns such as audit logs, billing information, and lineage data. Requires account admin or metastore admin privileges.
DATABRICKS_CATALOG_SYSTEM_SCHEMAS_DISABLEAcciónTool to disable a system schema in Unity Catalog metastore. Use when you need to remove a system schema from the system catalog. System schemas store information about customer usage patterns such as audit logs, billing information, and lineage data. Requires account admin or metastore admin privileges.
Parámetros de entrada
schema_namestringObligatorioFull name of the system schema to disable. Valid system schema names include: access, billing, compute, storage, lineage, marketplace
metastore_idstringObligatorioThe metastore ID under which the system schema lives. This is the unique identifier for the Unity Catalog metastore. The caller must be an account admin or metastore admin
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enable System SchemaDATABRICKS_CATALOG_SYSTEM_SCHEMAS_ENABLEAcciónTool to enable a system schema in Unity Catalog metastore. Use when you need to activate a system schema to track customer usage patterns. System schemas store information about audit logs, billing, compute usage, storage, lineage, and marketplace data. Requires account admin or metastore admin privileges.
DATABRICKS_CATALOG_SYSTEM_SCHEMAS_ENABLEAcciónTool to enable a system schema in Unity Catalog metastore. Use when you need to activate a system schema to track customer usage patterns. System schemas store information about audit logs, billing, compute usage, storage, lineage, and marketplace data. Requires account admin or metastore admin privileges.
Parámetros de entrada
schema_namestringObligatorioFull name of the system schema to enable. Valid system schema names include: access, billing, compute, storage, lineage, marketplace, information_schema, operational_data
catalog_namestringThe catalog for which the system schema is to be enabled in. Optional parameter to specify a particular catalog
metastore_idstringObligatorioThe metastore ID under which the system schema lives. This is the unique identifier for the Unity Catalog metastore. The caller must be an account admin or metastore admin
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Catalog TableDATABRICKS_CATALOG_TABLES_DELETEAcciónTool to delete a table from Unity Catalog. Use when you need to permanently remove a table from its parent catalog and schema. The operation requires appropriate permissions on the parent catalog, schema, and table.
DATABRICKS_CATALOG_TABLES_DELETEAcciónTool to delete a table from Unity Catalog. Use when you need to permanently remove a table from its parent catalog and schema. The operation requires appropriate permissions on the parent catalog, schema, and table.
Parámetros de entrada
full_namestringObligatorioFull three-level namespace name of the table to delete. Must follow the format: catalog_name.schema_name.table_name. The caller must be the parent catalog owner, have USE_CATALOG privilege on parent catalog AND be parent schema owner, or be the table owner AND have USE_CATALOG on parent catalog AND USE_SCHEMA on parent schema
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Check Table ExistsDATABRICKS_CATALOG_TABLES_EXISTSAcciónTool to check if a table exists in Unity Catalog metastore. Use when you need to verify table existence before performing operations. Requires metastore admin privileges, table ownership with SELECT privilege, or USE_CATALOG and USE_SCHEMA privileges on parent objects.
DATABRICKS_CATALOG_TABLES_EXISTSAcciónTool to check if a table exists in Unity Catalog metastore. Use when you need to verify table existence before performing operations. Requires metastore admin privileges, table ownership with SELECT privilege, or USE_CATALOG and USE_SCHEMA privileges on parent objects.
Parámetros de entrada
full_namestringObligatorioThe complete three-level name of the table in the format 'catalog_name.schema_name.table_name' (e.g., 'samples.nyctaxi.trips'). The caller must be a metastore admin, table owner with SELECT privilege, or have USE_CATALOG and USE_SCHEMA privileges
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog Table DetailsDATABRICKS_CATALOG_TABLES_GETAcciónTool to retrieve comprehensive metadata about a table from Unity Catalog metastore. Use when you need detailed table information including columns, type, storage, constraints, and governance metadata. Requires metastore admin privileges, table ownership, or SELECT privilege on the table, plus USE_CATALOG and USE_SCHEMA privileges on parent objects.
DATABRICKS_CATALOG_TABLES_GETAcciónTool to retrieve comprehensive metadata about a table from Unity Catalog metastore. Use when you need detailed table information including columns, type, storage, constraints, and governance metadata. Requires metastore admin privileges, table ownership, or SELECT privilege on the table, plus USE_CATALOG and USE_SCHEMA privileges on parent objects.
Parámetros de entrada
full_namestringObligatorioThe three-level (fully qualified) name of the table in the format 'catalog_name.schema_name.table_name' (e.g., 'samples.nyctaxi.trips'). The caller must be a metastore admin, table owner, or have SELECT privilege on the table, plus USE_CATALOG and USE_SCHEMA privileges
include_browsebooleanWhether to include tables in the response for which the principal can only access selective metadata through the BROWSE privilege
include_delta_metadatabooleanWhether delta metadata should be included in the response. Delta metadata includes information about table version, data files, and statistics
include_manifest_capabilitiesbooleanWhether to include a manifest containing table capabilities in the response. Capabilities describe what operations are supported on the table
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Catalog TableDATABRICKS_CATALOG_TABLES_UPDATEAcciónTool to update Unity Catalog table properties. Use when you need to change the owner or comment of a 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 parent catalog and the USE_SCHEMA privilege on the parent schema.
DATABRICKS_CATALOG_TABLES_UPDATEAcciónTool to update Unity Catalog table properties. Use when you need to change the owner or comment of a 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 parent catalog and the USE_SCHEMA privilege on the parent schema.
Parámetros de entrada
ownerstringUsername of the new owner of the table. This is the primary field that can be updated via this endpoint
commentstringUser-provided free-form text description for the table
full_namestringObligatorioThe three-level (fully qualified) name of the table in the format 'catalog_name.schema_name.table_name' (e.g., 'samples.nyctaxi.trips')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Temporary Path CredentialsDATABRICKS_CATALOG_TEMPORARY_PATH_CREDENTIALS_GENERATE_TEMPORARY_PATH_CREDENTIALSAcciónTool to generate short-lived, scoped temporary credentials for accessing external storage locations registered in Unity Catalog. Use when you need temporary access to cloud storage paths with specific read/write permissions. The credentials inherit the privileges of the requesting principal and are valid for a limited time. The requesting principal must have EXTERNAL USE LOCATION privilege on the external location.
DATABRICKS_CATALOG_TEMPORARY_PATH_CREDENTIALS_GENERATE_TEMPORARY_PATH_CREDENTIALSAcciónTool to generate short-lived, scoped temporary credentials for accessing external storage locations registered in Unity Catalog. Use when you need temporary access to cloud storage paths with specific read/write permissions. The credentials inherit the privileges of the requesting principal and are valid for a limited time. The requesting principal must have EXTERNAL USE LOCATION privilege on the external location.
Parámetros de entrada
urlstringObligatorioThe cloud storage path URL for which temporary credentials are requested. Supports s3:// for AWS S3, abfss:// for Azure Data Lake Storage, gs:// for GCP Cloud Storage, and r2:// for Cloudflare R2
dry_runbooleanWhen set to true, the service will not validate that the generated credentials can perform write operations. Default is false
operationstringObligatorioenumThe type of operation to be performed on the path. PATH_READ provides read-only access, PATH_READ_WRITE provides read and write access, PATH_CREATE_TABLE provides permission to create tables at the specified path
PATH_READPATH_READ_WRITEPATH_CREATE_TABLE
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Catalog Volume DetailsDATABRICKS_CATALOG_VOLUMES_READAcciónTool to retrieve detailed information about a specific Unity Catalog volume. Use when you need to get volume metadata including type, storage location, owner, and timestamps. Requires metastore admin privileges or volume ownership with appropriate USE_CATALOG and USE_SCHEMA privileges on parent objects.
DATABRICKS_CATALOG_VOLUMES_READAcciónTool to retrieve detailed information about a specific Unity Catalog volume. Use when you need to get volume metadata including type, storage location, owner, and timestamps. Requires metastore admin privileges or volume ownership with appropriate USE_CATALOG and USE_SCHEMA privileges on parent objects.
Parámetros de entrada
namestringObligatorioThe three-level (fully qualified) name of the volume in the format 'catalog_name.schema_name.volume_name' (e.g., 'samples.nyctaxi.test_volume'). The caller must be a metastore admin or own the volume (and have USE_CATALOG privilege on the parent catalog and USE_SCHEMA privilege on the parent schema)
include_browsebooleanWhether to include volumes in the response for which the principal can only access selective metadata through the BROWSE privilege
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Catalog Workspace BindingsDATABRICKS_CATALOG_WORKSPACE_BINDINGS_UPDATE_BINDINGSAcciónTool to update workspace bindings for a Unity Catalog securable (catalog). Use when you need to control which workspaces can access a catalog. Allows adding or removing workspace bindings with read-write or read-only access. Caller must be a metastore admin or owner of the catalog.
DATABRICKS_CATALOG_WORKSPACE_BINDINGS_UPDATE_BINDINGSAcciónTool to update workspace bindings for a Unity Catalog securable (catalog). Use when you need to control which workspaces can access a catalog. Allows adding or removing workspace bindings with read-write or read-only access. Caller must be a metastore admin or owner of the catalog.
Parámetros de entrada
addobject[]List of workspace bindings to add or update. Each binding specifies a workspace ID and the access level (read-write or read-only)
namestringObligatorioThe name of the catalog to update workspace bindings for
removeobject[]List of workspace bindings to remove. Each binding specifies a workspace ID and the access level to remove
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Clean Room AssetDATABRICKS_CLEANROOMS_CLEAN_ROOM_ASSETS_GETAcciónTool to retrieve detailed information about a specific asset within a Databricks Clean Room. Use when you need to get metadata and configuration for clean room assets such as tables, views, notebooks, volumes, or foreign tables.
DATABRICKS_CLEANROOMS_CLEAN_ROOM_ASSETS_GETAcciónTool to retrieve detailed information about a specific asset within a Databricks Clean Room. Use when you need to get metadata and configuration for clean room assets such as tables, views, notebooks, volumes, or foreign tables.
Parámetros de entrada
asset_namestringObligatorioThe fully qualified name of the asset. For Unity Catalog assets, format is: shared_catalog.shared_schema.asset_name
asset_typestringObligatorioenumThe type of the asset. Supported values: FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME
FOREIGN_TABLENOTEBOOK_FILETABLEVIEWVOLUMEclean_room_namestringObligatorioName of the clean room
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Clean Room Auto-Approval RuleDATABRICKS_CLEANROOMS_CLEAN_ROOM_AUTO_APPROVAL_RULES_CREATEAcciónTool to create a new auto-approval rule for a Databricks Clean Room. Use when you need to automatically approve notebooks shared by other collaborators that meet specific criteria. In 2-person clean rooms, auto-approve notebooks from the other collaborator using author_collaborator_alias. In multi-collaborator clean rooms, use author_scope=ANY_AUTHOR to auto-approve from any author.
DATABRICKS_CLEANROOMS_CLEAN_ROOM_AUTO_APPROVAL_RULES_CREATEAcciónTool to create a new auto-approval rule for a Databricks Clean Room. Use when you need to automatically approve notebooks shared by other collaborators that meet specific criteria. In 2-person clean rooms, auto-approve notebooks from the other collaborator using author_collaborator_alias. In multi-collaborator clean rooms, use author_scope=ANY_AUTHOR to auto-approve from any author.
Parámetros de entrada
author_scopestringScope of authors whose notebooks will be auto-approved. Valid value: ANY_AUTHOR. Only one of author_collaborator_alias and author_scope can be set. Use this in clean rooms with more than two collaborators to auto-approve notebooks from any author
clean_room_namestringObligatorioThe name of the clean room where the auto-approval rule will be created
author_collaborator_aliasstringCollaborator alias of the author whose notebooks will be auto-approved. Only one of author_collaborator_alias and author_scope can be set. Use this for 2-person clean rooms or to auto-approve notebooks from a specific collaborator
runner_collaborator_aliasstringCollaborator alias of the runner who will execute the auto-approved notebooks. This designates a single runner for the approved notebook
rule_owner_collaborator_aliasstringThe owner of the rule to whom the rule applies. This identifies the collaborator who owns this auto-approval rule
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Clean RoomDATABRICKS_CLEANROOMS_CLEAN_ROOMS_CREATEAcciónTool to create a new Databricks Clean Room for secure data collaboration with specified collaborators. Use when you need to establish a collaborative environment for multi-party data analysis. This is an asynchronous operation; the clean room starts in PROVISIONING state and becomes ACTIVE when ready. Requires metastore admin privileges or CREATE_CLEAN_ROOM privilege on the metastore.
DATABRICKS_CLEANROOMS_CLEAN_ROOMS_CREATEAcciónTool to create a new Databricks Clean Room for secure data collaboration with specified collaborators. Use when you need to establish a collaborative environment for multi-party data analysis. This is an asynchronous operation; the clean room starts in PROVISIONING state and becomes ACTIVE when ready. Requires metastore admin privileges or CREATE_CLEAN_ROOM privilege on the metastore.
Parámetros de entrada
namestringObligatorioThe name of the clean room. Cannot include spaces, periods, or forward slashes. Cannot be changed after creation
commentstringUser-provided free-form text description of the clean room
remote_detailed_infoobjectObligatorioCentral clean room configuration including cloud provider, region, and collaborator details
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Compute Cluster PolicyDATABRICKS_COMPUTE_CLUSTER_POLICIES_CREATEAcciónTool to create a new cluster policy with prescribed settings for controlling cluster creation. Use when you need to establish policies that govern cluster configurations. Only admin users can create cluster policies.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_CREATEAcciónTool to create a new cluster policy with prescribed settings for controlling cluster creation. Use when you need to establish policies that govern cluster configurations. Only admin users can create cluster policies.
Parámetros de entrada
namestringObligatorioCluster Policy name requested by the user. Must be unique within the workspace. Length must be between 1 and 100 characters
librariesobject[]List of libraries to be automatically installed on clusters using this policy. Libraries are installed on next cluster restart. Maximum of 500 libraries allowed
definitionstringObligatorioPolicy definition document expressed in Databricks Cluster Policy Definition Language (JSON string). Cannot be used together with policy_family_id
descriptionstringAdditional human-readable description of the cluster policy
policy_family_idstringID of the policy family. The cluster policy's definition inherits from the policy family's definition. Cannot be used together with definition parameter
max_clusters_per_userintegerMaximum number of clusters per user that can be active using this policy. If not present, there is no maximum limit. If specified, value must be greater than zero
policy_family_definition_overridesstringPolicy definition JSON document expressed in Databricks Policy Definition Language. Allows customization of the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Compute Cluster PolicyDATABRICKS_COMPUTE_CLUSTER_POLICIES_DELETEAcciónTool to delete a cluster policy. Use when you need to remove a cluster policy from the workspace. Clusters governed by this policy can still run, but cannot be edited. Only workspace admin users can delete policies. This operation is permanent and cannot be undone.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_DELETEAcciónTool to delete a cluster policy. Use when you need to remove a cluster policy from the workspace. Clusters governed by this policy can still run, but cannot be edited. Only workspace admin users can delete policies. This operation is permanent and cannot be undone.
Parámetros de entrada
policy_idstringObligatorioThe ID of the policy to delete. Canonical unique identifier for the cluster policy
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Compute Cluster PolicyDATABRICKS_COMPUTE_CLUSTER_POLICIES_EDITAcciónTool to update an existing Databricks cluster policy. Use when you need to modify policy settings like name, definition, or restrictions. Note that this operation may make some clusters governed by the previous policy invalid.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_EDITAcciónTool to update an existing Databricks cluster policy. Use when you need to modify policy settings like name, definition, or restrictions. Note that this operation may make some clusters governed by the previous policy invalid.
Parámetros de entrada
namestringCluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100 characters
librariesobject[]A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500
policy_idstringObligatorioThe ID of the policy to update. This is a required parameter
definitionstringPolicy definition document expressed in Databricks Cluster Policy Definition Language (JSON string). Cannot be used with policy_family_id
descriptionstringAdditional human-readable description of the cluster policy
policy_family_idstringID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition
max_clusters_per_userintegerMax number of clusters per user that can be active using this policy. If not present, there is no max limit
policy_family_definition_overridesstringPolicy definition JSON document for customizing inherited policy family definitions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Compute Cluster PolicyDATABRICKS_COMPUTE_CLUSTER_POLICIES_GETAcciónTool to retrieve detailed information about a specific cluster policy by its ID. Use when you need to view the configuration and settings of an existing cluster policy.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_GETAcciónTool to retrieve detailed information about a specific cluster policy by its ID. Use when you need to view the configuration and settings of an existing cluster policy.
Parámetros de entrada
policy_idstringObligatorioCanonical unique identifier for the cluster policy to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Compute Cluster Policy Permission LevelsDATABRICKS_COMPUTE_CLUSTER_POLICIES_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks cluster policy. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific cluster policy. Returns permission levels like CAN_USE with their descriptions.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks cluster policy. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific cluster policy. Returns permission levels like CAN_USE with their descriptions.
Parámetros de entrada
cluster_policy_idstringObligatorioThe unique identifier of the cluster policy for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Compute Cluster Policy PermissionsDATABRICKS_COMPUTE_CLUSTER_POLICIES_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks cluster policy. Use when you need to check who has access to a specific cluster policy and their permission levels. Returns the access control list with user, group, and service principal permissions, including inherited permissions from parent objects.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks cluster policy. Use when you need to check who has access to a specific cluster policy and their permission levels. Returns the access control list with user, group, and service principal permissions, including inherited permissions from parent objects.
Parámetros de entrada
cluster_policy_idstringObligatorioThe unique identifier of the cluster policy for which to retrieve permissions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Compute Cluster Policy PermissionsDATABRICKS_COMPUTE_CLUSTER_POLICIES_SET_PERMISSIONSAcciónTool to set permissions for a Databricks cluster policy, replacing all existing permissions. Use when you need to configure access control for a cluster policy. This operation replaces ALL existing permissions; non-admin users must be granted permissions to access the policy. Workspace admins always have permissions on all policies.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_SET_PERMISSIONSAcciónTool to set permissions for a Databricks cluster policy, replacing all existing permissions. Use when you need to configure access control for a cluster policy. This operation replaces ALL existing permissions; non-admin users must be granted permissions to access the policy. Workspace admins always have permissions on all policies.
Parámetros de entrada
cluster_policy_idstringObligatorioThe unique identifier of the cluster policy for which to set permissions
access_control_listobject[]ObligatorioArray of access control entries. This replaces ALL existing permissions. For each entry, only one of user_name, group_name, or service_principal_name should be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Cluster Policy PermissionsDATABRICKS_COMPUTE_CLUSTER_POLICIES_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks cluster policy. Use when you need to modify permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
DATABRICKS_COMPUTE_CLUSTER_POLICIES_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks cluster policy. Use when you need to modify permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
Parámetros de entrada
cluster_policy_idstringObligatorioThe cluster policy resource identifier for which permissions are being modified
access_control_listobject[]ObligatorioCollection of access control entries defining permissions to assign. This operation updates permissions incrementally without replacing existing permissions. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_DELETEAcciónTool to terminate a Databricks compute cluster. Use when you need to stop and delete a cluster. The cluster configuration is retained for 30 days after termination, after which it is permanently deleted.
DATABRICKS_COMPUTE_CLUSTERS_DELETEAcciónTool to terminate a Databricks compute cluster. Use when you need to stop and delete a cluster. The cluster configuration is retained for 30 days after termination, after which it is permanently deleted.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to terminate. This can be found in the Databricks workspace URL when viewing a cluster configuration
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_EDITAcciónTool to update the configuration of a Databricks cluster. Use when you need to modify cluster settings like size, Spark version, or cloud-specific attributes. The cluster must be in RUNNING or TERMINATED state. Running clusters will restart to apply changes.
DATABRICKS_COMPUTE_CLUSTERS_EDITAcciónTool to update the configuration of a Databricks cluster. Use when you need to modify cluster settings like size, Spark version, or cloud-specific attributes. The cluster must be in RUNNING or TERMINATED state. Running clusters will restart to apply changes.
Parámetros de entrada
autoscaleobjectAutoscaling configuration for cluster workers.
policy_idstringReferences cluster policy for validation and defaults
cluster_idstringObligatorioThe ID of the cluster to edit
spark_confobjectSpark configuration key-value pairs
custom_tagsobjectAdditional tags for cluster resources (max 45 tags)
num_workersintegerNumber of worker nodes. Required unless using autoscale. Use 0 for single-node clusters
cluster_namestringCluster name requested by the user
docker_imageobjectDocker container configuration.
init_scriptsobject[]Scripts executing during cluster startup
node_type_idstringInstance type for worker nodes. Required unless using instance_pool_id
spark_versionstringObligatorioThe Spark version of the cluster (e.g., '11.3.x-scala2.12', '12.2.x-scala2.12')
workload_typeobjectWorkload type restrictions for cluster usage.
aws_attributesobjectAWS-specific cluster configuration.
gcp_attributesobjectGCP-specific cluster configuration.
runtime_enginestringenumRuntime engine type
STANDARDPHOTONspark_env_varsobjectEnvironment variables for Spark processes
ssh_public_keysstring[]List of SSH public keys (up to 10)
azure_attributesobjectAzure-specific cluster configuration.
cluster_log_confobjectCluster log delivery configuration.
instance_pool_idstringInstance pool identifier for worker nodes (alternative to node_type_id)
single_user_namestringRequired when using SINGLE_USER security mode
idempotency_tokenstringRequest deduplication token (max 64 characters)
data_security_modestringenumAccess control mode for the cluster
SINGLE_USERUSER_ISOLATIONLEGACY_TABLE_ACLLEGACY_PASSTHROUGHLEGACY_SINGLE_USERdriver_node_type_idstringThe node type of the Spark driver (defaults to node_type_id if unspecified)
enable_elastic_diskbooleanEnables autoscaling storage, monitors free disk space
autotermination_minutesintegerAutomatically terminate the cluster after it is inactive for this time in minutes
driver_instance_pool_idstringInstance pool identifier for driver node
apply_policy_default_valuesbooleanWhen true, fixed and default values from the policy will be used for omitted fields
enable_local_disk_encryptionbooleanEncrypts temporary cluster storage using LUKS
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Compute Cluster Permission LevelsDATABRICKS_COMPUTE_CLUSTERS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks compute cluster. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific cluster. Returns permission levels like CAN_ATTACH_TO, CAN_RESTART, and CAN_MANAGE with their descriptions.
DATABRICKS_COMPUTE_CLUSTERS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks compute cluster. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific cluster. Returns permission levels like CAN_ATTACH_TO, CAN_RESTART, and CAN_MANAGE with their descriptions.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Compute Cluster Node TypesDATABRICKS_COMPUTE_CLUSTERS_LIST_NODE_TYPESAcciónTool to list all supported Spark node types available for cluster launch in the workspace region. Use when you need to determine which instance types are available for creating or configuring clusters. Returns detailed specifications including compute resources, storage capabilities, and cloud-specific attributes for each node type.
DATABRICKS_COMPUTE_CLUSTERS_LIST_NODE_TYPESAcciónTool to list all supported Spark node types available for cluster launch in the workspace region. Use when you need to determine which instance types are available for creating or configuring clusters. Returns detailed specifications including compute resources, storage capabilities, and cloud-specific attributes for each node type.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Compute Cluster Availability ZonesDATABRICKS_COMPUTE_CLUSTERS_LIST_ZONESAcciónTool to list availability zones where Databricks clusters can be created. Use when you need to determine available zones for cluster deployment or planning redundancy. Returns the default zone and a list of all zones available in the workspace's cloud region. This endpoint is available for AWS workspaces.
DATABRICKS_COMPUTE_CLUSTERS_LIST_ZONESAcciónTool to list availability zones where Databricks clusters can be created. Use when you need to determine available zones for cluster deployment or planning redundancy. Returns the default zone and a list of all zones available in the workspace's cloud region. This endpoint is available for AWS workspaces.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Permanently Delete Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_PERMANENT_DELETEAcciónTool to permanently delete a Databricks compute cluster. Use when you need to irreversibly remove a cluster and its resources. After permanent deletion, the cluster will no longer appear in the cluster list and cannot be recovered.
DATABRICKS_COMPUTE_CLUSTERS_PERMANENT_DELETEAcciónTool to permanently delete a Databricks compute cluster. Use when you need to irreversibly remove a cluster and its resources. After permanent deletion, the cluster will no longer appear in the cluster list and cannot be recovered.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to permanently delete. This operation is irreversible and will asynchronously remove all cluster resources
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Pin Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_PINAcciónTool to pin a Databricks compute cluster configuration. Use when you need to preserve a cluster's configuration beyond the standard 30-day retention period. This operation is idempotent - pinning an already-pinned cluster has no effect. Requires workspace administrator privileges.
DATABRICKS_COMPUTE_CLUSTERS_PINAcciónTool to pin a Databricks compute cluster configuration. Use when you need to preserve a cluster's configuration beyond the standard 30-day retention period. This operation is idempotent - pinning an already-pinned cluster has no effect. Requires workspace administrator privileges.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to pin. Pinning a cluster ensures its configuration is retained beyond the standard 30-day period for terminated clusters and is always returned by the List Clusters API
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Compute Cluster Spark VersionsDATABRICKS_COMPUTE_CLUSTERS_SPARK_VERSIONSAcciónTool to list all available Databricks Runtime Spark versions for cluster creation. Use when you need to determine which Spark versions are available for creating or configuring clusters. The 'key' field from the response should be used as the 'spark_version' parameter when creating clusters.
DATABRICKS_COMPUTE_CLUSTERS_SPARK_VERSIONSAcciónTool to list all available Databricks Runtime Spark versions for cluster creation. Use when you need to determine which Spark versions are available for creating or configuring clusters. The 'key' field from the response should be used as the 'spark_version' parameter when creating clusters.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Start Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_STARTAcciónTool to start a terminated Databricks compute cluster asynchronously. Use when you need to restart a stopped cluster. The cluster transitions through PENDING state before reaching RUNNING. Poll cluster status to verify when fully started.
DATABRICKS_COMPUTE_CLUSTERS_STARTAcciónTool to start a terminated Databricks compute cluster asynchronously. Use when you need to restart a stopped cluster. The cluster transitions through PENDING state before reaching RUNNING. Poll cluster status to verify when fully started.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to start. This cluster must be in a TERMINATED state. The cluster will preserve its previous configuration and cluster ID when started.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unpin Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_UNPINAcciónTool to unpin a Databricks compute cluster configuration. Use when you need to allow a cluster's configuration to be removed after termination. This operation is idempotent - unpinning an already-unpinned cluster has no effect. Requires workspace administrator privileges.
DATABRICKS_COMPUTE_CLUSTERS_UNPINAcciónTool to unpin a Databricks compute cluster configuration. Use when you need to allow a cluster's configuration to be removed after termination. This operation is idempotent - unpinning an already-unpinned cluster has no effect. Requires workspace administrator privileges.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to unpin. Unpinning a cluster allows it to be automatically removed from the List Clusters API after termination and eventual deletion after 30 days
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Compute ClusterDATABRICKS_COMPUTE_CLUSTERS_UPDATEAcciónTool to partially update a Databricks compute cluster configuration using field masks. Use when you need to update specific cluster attributes without providing a full configuration. The update_mask specifies which fields to modify. Running clusters restart to apply changes; terminated clusters apply changes on next startup.
DATABRICKS_COMPUTE_CLUSTERS_UPDATEAcciónTool to partially update a Databricks compute cluster configuration using field masks. Use when you need to update specific cluster attributes without providing a full configuration. The update_mask specifies which fields to modify. Running clusters restart to apply changes; terminated clusters apply changes on next startup.
Parámetros de entrada
autoscaleobjectAutoscaling configuration for cluster workers.
policy_idstringReferences cluster policy for validation and defaults. Only applied if 'policy_id' is in update_mask.
cluster_idstringObligatorioThe unique identifier of the cluster to update. The cluster must be in RUNNING or TERMINATED state.
spark_confobjectSpark configuration key-value pairs. Only applied if 'spark_conf' is in update_mask.
custom_tagsobjectAdditional tags for cluster resources (max 45 tags). Only applied if 'custom_tags' is in update_mask.
num_workersintegerNumber of worker nodes. Use 0 for single-node clusters. Only applied if 'num_workers' is in update_mask.
update_maskstringObligatorioComma-separated list of field paths to update (e.g., 'cluster_name', 'num_workers,autotermination_minutes'). Use dot notation for nested fields. Field paths are relative to the cluster resource.
cluster_namestringCluster name requested by the user. Only applied if 'cluster_name' is in update_mask.
docker_imageobjectDocker container configuration.
init_scriptsobject[]Scripts executing during cluster startup. Only applied if 'init_scripts' is in update_mask.
node_type_idstringInstance type for worker nodes. Only applied if 'node_type_id' is in update_mask.
spark_versionstringThe Spark version of the cluster (e.g., '11.3.x-scala2.12', '12.2.x-scala2.12'). Only applied if 'spark_version' is in update_mask.
workload_typeobjectWorkload type restrictions for cluster usage.
aws_attributesobjectAWS-specific cluster configuration.
gcp_attributesobjectGCP-specific cluster configuration.
runtime_enginestringenumRuntime engine type. Only applied if 'runtime_engine' is in update_mask.
STANDARDPHOTONspark_env_varsobjectEnvironment variables for Spark processes. Only applied if 'spark_env_vars' is in update_mask.
ssh_public_keysstring[]List of SSH public keys (up to 10). Only applied if 'ssh_public_keys' is in update_mask.
azure_attributesobjectAzure-specific cluster configuration.
cluster_log_confobjectCluster log delivery configuration.
instance_pool_idstringInstance pool identifier for worker nodes. Only applied if 'instance_pool_id' is in update_mask.
single_user_namestringRequired when using SINGLE_USER security mode. Only applied if 'single_user_name' is in update_mask.
data_security_modestringenumAccess control mode for the cluster. Only applied if 'data_security_mode' is in update_mask.
SINGLE_USERUSER_ISOLATIONLEGACY_TABLE_ACLLEGACY_PASSTHROUGHLEGACY_SINGLE_USERdriver_node_type_idstringThe node type of the Spark driver. Only applied if 'driver_node_type_id' is in update_mask.
enable_elastic_diskbooleanEnables autoscaling storage, monitors free disk space. Only applied if 'enable_elastic_disk' is in update_mask.
autotermination_minutesintegerAutomatically terminate the cluster after it is inactive for this time in minutes. Only applied if 'autotermination_minutes' is in update_mask.
driver_instance_pool_idstringInstance pool identifier for driver node. Only applied if 'driver_instance_pool_id' is in update_mask.
apply_policy_default_valuesbooleanWhen true, fixed and default values from the policy will be used for omitted fields. Only applied if 'apply_policy_default_values' is in update_mask.
enable_local_disk_encryptionbooleanEncrypts temporary cluster storage using LUKS. Only applied if 'enable_local_disk_encryption' is in update_mask.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Global Init ScriptDATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_CREATEAcciónTool to create a new global initialization script in Databricks workspace. Use when you need to run scripts on every node in every cluster. Global init scripts run on all cluster nodes and only workspace admins can create them. Scripts execute in position order and clusters must restart to apply changes. The script cannot exceed 64KB when decoded.
DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_CREATEAcciónTool to create a new global initialization script in Databricks workspace. Use when you need to run scripts on every node in every cluster. Global init scripts run on all cluster nodes and only workspace admins can create them. Scripts execute in position order and clusters must restart to apply changes. The script cannot exceed 64KB when decoded.
Parámetros de entrada
namestringObligatorioThe name of the script. Must be provided and should be descriptive of the script's purpose
scriptstringObligatorioThe Base64-encoded content of the script. The decoded script content must not exceed 64KB in size
enabledbooleanSpecifies whether the script is enabled. The script runs only if enabled. If not specified, the default behavior applies
positionintegerThe position of a global init script, where 0 represents the first script to run, 1 is the second script to run, in ascending order. If omitted, defaults to last position (will run after all current scripts). Setting any value greater than the position of the last script is equivalent to the last position. If an explicit position value conflicts with an existing script value, the request succeeds, but the original script at that position and all later scripts have their positions incremented by 1
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Global Init ScriptDATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_DELETEAcciónTool to delete a global initialization script from Databricks workspace. Use when you need to remove a script that runs on every cluster node. Requires workspace administrator privileges. Clusters must restart to reflect the removal of the script.
DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_DELETEAcciónTool to delete a global initialization script from Databricks workspace. Use when you need to remove a script that runs on every cluster node. Requires workspace administrator privileges. Clusters must restart to reflect the removal of the script.
Parámetros de entrada
script_idstringObligatorioThe unique identifier of the global init script to delete. This is the ID returned when the script was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Global Init ScriptDATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_GETAcciónTool to retrieve complete details of a global initialization script in Databricks workspace. Use when you need to view script configuration, Base64-encoded content, or metadata. Returns all script details including creation/update timestamps and whether the script is enabled.
DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_GETAcciónTool to retrieve complete details of a global initialization script in Databricks workspace. Use when you need to view script configuration, Base64-encoded content, or metadata. Returns all script details including creation/update timestamps and whether the script is enabled.
Parámetros de entrada
script_idstringObligatorioThe unique identifier of the global init script to retrieve. This is the ID returned when the script was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Global Init ScriptDATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_UPDATEAcciónTool to update a global initialization script in Databricks workspace. Use when you need to modify script content, name, enabled status, or execution order. All fields are optional; unspecified fields retain their current value. Existing clusters must be restarted to pick up changes.
DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_UPDATEAcciónTool to update a global initialization script in Databricks workspace. Use when you need to modify script content, name, enabled status, or execution order. All fields are optional; unspecified fields retain their current value. Existing clusters must be restarted to pick up changes.
Parámetros de entrada
namestringThe name of the script. It should be unique
scriptstringThe Base64-encoded content of the script
enabledbooleanSpecifies whether the script is enabled. The script runs only if enabled
positionintegerThe position of a script, where 0 represents the first script to run, 1 is the second script to run, in ascending order. If position is >= the position of the last script, the script will be placed at the end
script_idstringObligatorioThe unique identifier of the global init script to update. This is the ID returned when the script was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Compute Instance PoolDATABRICKS_COMPUTE_INSTANCE_POOLS_CREATEAcciónTool to create a new Databricks instance pool with specified configuration. Use when you need to set up a pool that reduces cluster start and auto-scaling times by maintaining idle, ready-to-use cloud instances. When attached to a pool, a cluster allocates driver and worker nodes from the pool.
DATABRICKS_COMPUTE_INSTANCE_POOLS_CREATEAcciónTool to create a new Databricks instance pool with specified configuration. Use when you need to set up a pool that reduces cluster start and auto-scaling times by maintaining idle, ready-to-use cloud instances. When attached to a pool, a cluster allocates driver and worker nodes from the pool.
Parámetros de entrada
disk_specobjectSpecification of disks attached to all spark containers.
custom_tagsobjectAdditional tags for pool resources. Databricks will tag all pool resources with these tags in addition to default_tags. Currently allows at most 43-45 custom tags
max_capacityintegerMaximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances. Clusters that require further instance provisioning will fail during upsize requests
node_type_idstringObligatorioEncodes the resources available to each Spark node (e.g., i3.xlarge, m5.large). A list of available node types can be retrieved using the List Node Types API
aws_attributesobjectAWS-specific attributes for the instance pool.
gcp_attributesobjectGCP-specific attributes for the instance pool.
azure_attributesobjectAzure-specific attributes for the instance pool.
instance_pool_namestringObligatorioPool name requested by the user. Pool name must be unique. Length must be between 1 and 100 characters
min_idle_instancesintegerMinimum number of idle instances to keep in the instance pool. This is in addition to any instances in use by active clusters
enable_elastic_diskbooleanAutoscaling Local Storage: when enabled, instances in this pool will dynamically acquire additional disk space when Spark workers are running low on disk space. In AWS, requires specific AWS permissions
remote_disk_throughputintegerGCP HYPERDISK throughput in Mb/s
preloaded_docker_imagesobject[]Custom Docker Image BYOC. Pool-backed clusters can use one of the preloaded images if it matches the docker_image specified in the create-cluster request
preloaded_spark_versionsstring[]A list of preloaded Spark image versions for the pool. Pool-backed clusters started with the preloaded Spark version will start faster. Up to one runtime version can be pre-installed on instances
instance_pool_fleet_attributesobjectFleet-related settings to power the instance pool.
total_initial_remote_disk_sizeintegerInitial remote disk volume size in GB
idle_instance_autotermination_minutesintegerObligatorioAutomatically terminates extra instances in the pool after they are inactive for this time in minutes if min_idle_instances requirement is met. Threshold must be between 0 and 10000 minutes. If 0, excess idle instances are removed as soon as possible
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Compute Instance PoolDATABRICKS_COMPUTE_INSTANCE_POOLS_DELETEAcciónTool to delete a Databricks compute instance pool. Use when you need to permanently remove an instance pool. The idle instances in the pool are terminated asynchronously after deletion.
DATABRICKS_COMPUTE_INSTANCE_POOLS_DELETEAcciónTool to delete a Databricks compute instance pool. Use when you need to permanently remove an instance pool. The idle instances in the pool are terminated asynchronously after deletion.
Parámetros de entrada
instance_pool_idstringObligatorioThe unique identifier of the instance pool to delete. The idle instances in the pool are terminated asynchronously
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Compute Instance PoolDATABRICKS_COMPUTE_INSTANCE_POOLS_EDITAcciónTool to modify the configuration of an existing Databricks instance pool. Use when you need to update pool settings like capacity, termination minutes, or preloaded images. Note that the pool's node type cannot be changed after creation, though it must still be provided with the same value.
DATABRICKS_COMPUTE_INSTANCE_POOLS_EDITAcciónTool to modify the configuration of an existing Databricks instance pool. Use when you need to update pool settings like capacity, termination minutes, or preloaded images. Note that the pool's node type cannot be changed after creation, though it must still be provided with the same value.
Parámetros de entrada
disk_specobjectSpecification of disks attached to all spark containers.
custom_tagsobjectAdditional tags for pool resources. Maximum 45 custom tags allowed
max_capacityintegerMaximum number of outstanding instances (active + idle) to keep in the pool
node_type_idstringObligatorioEncodes resources available to each Spark node (e.g., i3.xlarge). Must match existing node type as it cannot be changed after pool creation
aws_attributesobjectAWS-specific attributes for the instance pool.
gcp_attributesobjectGCP-specific attributes for the instance pool.
azure_attributesobjectAzure-specific attributes for the instance pool.
instance_pool_idstringObligatorioInstance pool ID that identifies the pool to be modified
instance_pool_namestringObligatorioPool name requested by the user. Must be unique, non-empty, length between 1-100 characters
min_idle_instancesintegerMinimum number of idle instances to keep in the pool. Default: 0
enable_elastic_diskbooleanWhen enabled, instances dynamically acquire additional disk space when running low
preloaded_docker_imagesobject[]Custom Docker images to preload on pool instances
preloaded_spark_versionsstring[]List of Spark versions to preload for faster cluster starts
instance_pool_fleet_attributesobjectFleet-related settings to power the instance pool.
idle_instance_autotermination_minutesintegerAutomatically terminates extra idle instances after inactive for this time in minutes. Range: 0-10000. Value of 0 instantly removes idle instances
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Instance Pool DetailsDATABRICKS_COMPUTE_INSTANCE_POOLS_GETAcciónTool to retrieve detailed information about a Databricks instance pool by its ID. Use when you need to get instance pool configuration, capacity settings, preloaded images, and usage statistics. Instance pools reduce cluster start and auto-scaling times by maintaining idle, ready-to-use cloud instances.
DATABRICKS_COMPUTE_INSTANCE_POOLS_GETAcciónTool to retrieve detailed information about a Databricks instance pool by its ID. Use when you need to get instance pool configuration, capacity settings, preloaded images, and usage statistics. Instance pools reduce cluster start and auto-scaling times by maintaining idle, ready-to-use cloud instances.
Parámetros de entrada
instance_pool_idstringObligatorioThe canonical unique identifier for the instance pool
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Instance Pool Permission LevelsDATABRICKS_COMPUTE_INSTANCE_POOLS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks instance pool. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific instance pool. Returns permission levels like CAN_ATTACH_TO and CAN_MANAGE with their descriptions.
DATABRICKS_COMPUTE_INSTANCE_POOLS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks instance pool. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific instance pool. Returns permission levels like CAN_ATTACH_TO and CAN_MANAGE with their descriptions.
Parámetros de entrada
instance_pool_idstringObligatorioThe canonical unique identifier for the instance pool for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Instance Pool PermissionsDATABRICKS_COMPUTE_INSTANCE_POOLS_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks instance pool. Use when you need to check who has access to a specific instance pool and their permission levels. Returns the access control list with user, group, and service principal permissions, including inherited permissions from parent objects.
DATABRICKS_COMPUTE_INSTANCE_POOLS_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks instance pool. Use when you need to check who has access to a specific instance pool and their permission levels. Returns the access control list with user, group, and service principal permissions, including inherited permissions from parent objects.
Parámetros de entrada
instance_pool_idstringObligatorioThe unique identifier of the instance pool for which to retrieve permissions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Compute Instance Pool PermissionsDATABRICKS_COMPUTE_INSTANCE_POOLS_SET_PERMISSIONSAcciónTool to set permissions for a Databricks instance pool, replacing all existing permissions. Use when you need to configure access control for an instance pool. This operation replaces ALL existing permissions. You must have CAN_MANAGE permission on a pool to configure its permissions.
DATABRICKS_COMPUTE_INSTANCE_POOLS_SET_PERMISSIONSAcciónTool to set permissions for a Databricks instance pool, replacing all existing permissions. Use when you need to configure access control for an instance pool. This operation replaces ALL existing permissions. You must have CAN_MANAGE permission on a pool to configure its permissions.
Parámetros de entrada
instance_pool_idstringObligatorioThe unique identifier of the instance pool for which to set permissions
access_control_listobject[]ObligatorioArray of access control entries. This replaces ALL existing permissions. For each entry, only one of user_name, group_name, or service_principal_name should be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Instance Pool PermissionsDATABRICKS_COMPUTE_INSTANCE_POOLS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks instance pool. Use when you need to modify permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
DATABRICKS_COMPUTE_INSTANCE_POOLS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks instance pool. Use when you need to modify permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
Parámetros de entrada
instance_pool_idstringObligatorioThe instance pool resource identifier for which permissions are being modified
access_control_listobject[]ObligatorioCollection of access control entries defining permissions to assign. This operation updates permissions incrementally without replacing existing permissions. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Compute Instance ProfileDATABRICKS_COMPUTE_INSTANCE_PROFILES_ADDAcciónTool to register an instance profile in Databricks for cluster launches. Use when administrators need to grant users permission to launch clusters using that profile. Requires admin access. Successfully registered profiles enable clusters to use the associated IAM role.
DATABRICKS_COMPUTE_INSTANCE_PROFILES_ADDAcciónTool to register an instance profile in Databricks for cluster launches. Use when administrators need to grant users permission to launch clusters using that profile. Requires admin access. Successfully registered profiles enable clusters to use the associated IAM role.
Parámetros de entrada
iam_role_arnstringThe AWS IAM role ARN of the role associated with the instance profile, formatted as 'arn:aws:iam::<account-id>:role/<name>'. Required if your role name and instance profile name do not match AND you want to use the instance profile with Databricks SQL Serverless
skip_validationbooleanBy default, Databricks validates that it has sufficient permissions to launch instances with the instance profile using AWS dry-run mode for the RunInstances API. If validation fails with an error message that does not indicate an IAM related permission issue, you can pass this flag to skip the validation and forcibly add the instance profile
instance_profile_arnstringObligatorioThe AWS ARN of the instance profile to register with Databricks. This is the ARN attribute of the EC2 instance profile association to AWS IAM role
is_meta_instance_profilebooleanFlag indicating whether the instance profile should only be used in credential passthrough scenarios. When true, this means the instance profile contains a meta IAM role which could assume a wide range of roles, and therefore should always be used with authorization. Defaults to false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Compute Instance ProfileDATABRICKS_COMPUTE_INSTANCE_PROFILES_EDITAcciónTool to modify an existing AWS EC2 instance profile registered with Databricks. Use when you need to update the IAM role ARN associated with an instance profile. This operation is only available to admin users. The IAM role ARN is required if both of the following are true: your role name and instance profile name do not match, and you want to use the instance profile with Databricks SQL Serverless.
DATABRICKS_COMPUTE_INSTANCE_PROFILES_EDITAcciónTool to modify an existing AWS EC2 instance profile registered with Databricks. Use when you need to update the IAM role ARN associated with an instance profile. This operation is only available to admin users. The IAM role ARN is required if both of the following are true: your role name and instance profile name do not match, and you want to use the instance profile with Databricks SQL Serverless.
Parámetros de entrada
iam_role_arnstringThe AWS IAM role ARN of the role associated with the instance profile. This field is required if your role name and instance profile name do not match and you want to use the instance profile with Databricks SQL Serverless. Otherwise, this field is optional
instance_profile_arnstringObligatorioThe AWS ARN of the instance profile to edit. This identifies which instance profile to modify
is_meta_instance_profilebooleanBoolean flag indicating whether the instance profile should only be used in credential passthrough scenarios. If true, it means the instance profile contains a meta IAM role which could assume a wide range of roles. Therefore it should always be used with authorization. This field is optional, the default value is false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Compute Instance ProfileDATABRICKS_COMPUTE_INSTANCE_PROFILES_REMOVEAcciónTool to remove an instance profile from Databricks. Use when you need to unregister an AWS instance profile ARN from Databricks. This operation is only accessible to admin users. Existing clusters with this instance profile will continue to function normally after removal.
DATABRICKS_COMPUTE_INSTANCE_PROFILES_REMOVEAcciónTool to remove an instance profile from Databricks. Use when you need to unregister an AWS instance profile ARN from Databricks. This operation is only accessible to admin users. Existing clusters with this instance profile will continue to function normally after removal.
Parámetros de entrada
instance_profile_arnstringObligatorioThe AWS ARN of the instance profile to remove from Databricks. This field is required. Must be a valid AWS IAM instance profile ARN. Existing clusters with this instance profile will continue to function normally after removal
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enforce Cluster Policy ComplianceDATABRICKS_COMPUTE_POLICY_COMPLIANCE_FOR_CLUSTERS_ENFORCE_COMPLIANCEAcciónTool to update a cluster to be compliant with the current version of its policy. Use when you need to enforce policy compliance on a cluster. The cluster can be updated if it is in a RUNNING or TERMINATED state. Note: Clusters created by Databricks Jobs, DLT, or Models cannot be enforced by this API.
DATABRICKS_COMPUTE_POLICY_COMPLIANCE_FOR_CLUSTERS_ENFORCE_COMPLIANCEAcciónTool to update a cluster to be compliant with the current version of its policy. Use when you need to enforce policy compliance on a cluster. The cluster can be updated if it is in a RUNNING or TERMINATED state. Note: Clusters created by Databricks Jobs, DLT, or Models cannot be enforced by this API.
Parámetros de entrada
cluster_idstringObligatorioThe ID of the cluster you want to enforce policy compliance on. The cluster must be in a RUNNING or TERMINATED state. If RUNNING, the cluster will be restarted to apply changes. If TERMINATED, changes will take effect on next startup.
validate_onlybooleanIf set to true, previews the changes that would be made to enforce compliance without actually updating the cluster. This allows you to see what changes would occur without applying them. Defaults to false.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Cluster Policy ComplianceDATABRICKS_COMPUTE_POLICY_COMPLIANCE_FOR_CLUSTERS_GET_COMPLIANCEAcciónTool to retrieve policy compliance status for a specific cluster. Use when you need to check whether a cluster meets the requirements of its assigned policy and identify any policy violations. Clusters could be out of compliance if their policy was updated after the cluster was last edited.
DATABRICKS_COMPUTE_POLICY_COMPLIANCE_FOR_CLUSTERS_GET_COMPLIANCEAcciónTool to retrieve policy compliance status for a specific cluster. Use when you need to check whether a cluster meets the requirements of its assigned policy and identify any policy violations. Clusters could be out of compliance if their policy was updated after the cluster was last edited.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster for which to retrieve compliance status
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Compute Policy FamiliesDATABRICKS_COMPUTE_POLICY_FAMILIES_GETAcciónTool to retrieve information for a policy family by identifier and optional version. Use when you need to view Databricks-provided templates for configuring clusters for a particular use case. Policy families cannot be created, edited, or deleted by users.
DATABRICKS_COMPUTE_POLICY_FAMILIES_GETAcciónTool to retrieve information for a policy family by identifier and optional version. Use when you need to view Databricks-provided templates for configuring clusters for a particular use case. Policy families cannot be created, edited, or deleted by users.
Parámetros de entrada
versionintegerThe version number for the family to fetch. Defaults to the latest version if not specified
policy_family_idstringObligatorioThe unique identifier for the policy family to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Databricks ClusterDATABRICKS_CREATE_CLUSTERAcciónTool to create a new Databricks Spark cluster with specified configuration. Use when you need to provision compute resources for data processing. This is an asynchronous operation that returns a cluster_id immediately with the cluster in PENDING state. The cluster transitions through states until reaching RUNNING.
DATABRICKS_CREATE_CLUSTERAcciónTool to create a new Databricks Spark cluster with specified configuration. Use when you need to provision compute resources for data processing. This is an asynchronous operation that returns a cluster_id immediately with the cluster in PENDING state. The cluster transitions through states until reaching RUNNING.
Parámetros de entrada
autoscaleobjectAutoscaling configuration for cluster workers.
policy_idstringCluster policy ID for validation and defaults
clone_fromstringSource cluster ID to clone libraries from
spark_confobjectSpark configuration key-value pairs
custom_tagsobjectAdditional tags for cluster resources. Maximum 45 tags
num_workersintegerNumber of worker nodes. Mutually exclusive with autoscale. Use 0 for single-node clusters
cluster_namestringCluster name requested by the user. Does not need to be unique
docker_imageobjectDocker container configuration.
init_scriptsobject[]Initialization scripts executed sequentially during cluster startup
node_type_idstringInstance type for worker nodes. Required unless using instance_pool_id
spark_versionstringObligatorioThe Spark version of the cluster. Retrieve available versions via clusters/spark-versions API
workload_typeobjectWorkload type restrictions for cluster usage.
aws_attributesobjectAWS-specific cluster configuration.
cluster_sourcestringCluster creation source (UI, JOB, API)
gcp_attributesobjectGCP-specific cluster configuration.
runtime_enginestringenumRuntime engine type
STANDARDPHOTONspark_env_varsobjectEnvironment variables for Spark driver and worker processes
ssh_public_keysstring[]SSH public keys for ubuntu user access on port 2200. Maximum 10 keys
azure_attributesobjectAzure-specific cluster configuration.
cluster_log_confobjectCluster log delivery configuration.
instance_pool_idstringInstance pool identifier for worker nodes. Alternative to node_type_id
single_user_namestringUsername when using SINGLE_USER security mode
idempotency_tokenstringOptional token for creation idempotency. Maximum 64 characters
data_security_modestringenumData governance model for the cluster
SINGLE_USERUSER_ISOLATIONLEGACY_TABLE_ACLLEGACY_PASSTHROUGHLEGACY_SINGLE_USERNONEdriver_node_type_idstringThe node type of the Spark driver. Defaults to node_type_id if unspecified
enable_elastic_diskbooleanAutoscale EBS/disk volumes when low on space
autotermination_minutesintegerAutomatically terminate the cluster after it is inactive for this time in minutes. Must be between 10-10000 minutes, or 0 to disable
driver_instance_pool_idstringInstance pool identifier for driver node
apply_policy_default_valuesbooleanWhen true, fixed and default values from the policy will be used for omitted fields
enable_local_disk_encryptionbooleanEnable LUKS encryption on local disks for temporary cluster storage
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Genie MessageDATABRICKS_DASHBOARDS_GENIE_CREATE_MESSAGEAcciónTool to create a message in a Genie conversation and get AI-generated responses. Use when you need to ask questions or send messages to Genie for data analysis. The response initially has status 'IN_PROGRESS' and should be polled every 1-5 seconds until reaching COMPLETED, FAILED, or CANCELLED status. Subject to 5 queries-per-minute rate limit during Public Preview.
DATABRICKS_DASHBOARDS_GENIE_CREATE_MESSAGEAcciónTool to create a message in a Genie conversation and get AI-generated responses. Use when you need to ask questions or send messages to Genie for data analysis. The response initially has status 'IN_PROGRESS' and should be polled every 1-5 seconds until reaching COMPLETED, FAILED, or CANCELLED status. Subject to 5 queries-per-minute rate limit during Public Preview.
Parámetros de entrada
contentstringObligatorioUser message content - the question or message to send to Genie
space_idstringObligatorioThe ID associated with the Genie space where the conversation exists
conversation_idstringObligatorioThe ID associated with the conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Genie SpaceDATABRICKS_DASHBOARDS_GENIE_CREATE_SPACEAcciónTool to create a new Genie space from a serialized payload for programmatic space management. Use when you need to create a Genie workspace for AI-powered data analysis with predefined sample questions and data sources. The space requires a SQL warehouse ID and a serialized configuration that includes sample questions, instructions, and data source tables.
DATABRICKS_DASHBOARDS_GENIE_CREATE_SPACEAcciónTool to create a new Genie space from a serialized payload for programmatic space management. Use when you need to create a Genie workspace for AI-powered data analysis with predefined sample questions and data sources. The space requires a SQL warehouse ID and a serialized configuration that includes sample questions, instructions, and data source tables.
Parámetros de entrada
descriptionstringOptional description of the Genie space to provide context about its purpose and contents.
parent_pathstringParent folder path where the space will be registered in the workspace. If not specified, defaults to the user's home directory.
display_namestringDisplay name for the Genie space. This will be shown in the UI.
warehouse_idstringObligatorioThe ID of the SQL warehouse to associate with the new Genie space. This warehouse will be used to execute queries in the space.
serialized_spacestringObligatorioThe contents of the Genie Space in serialized JSON string form. Must include: version (currently 1), config object with sample_questions (array of objects with id and question fields, minimum 5 recommended) and instructions (string providing context about data and business rules), and data_sources with tables (array of table identifiers in catalog.schema.table format).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Genie ConversationDATABRICKS_DASHBOARDS_GENIE_DELETE_CONVERSATIONAcciónTool to delete a conversation from a Genie space programmatically. Use when you need to remove conversations to manage the Genie space limits (10,000 conversations per space). Useful for deleting older or test conversations that are no longer needed.
DATABRICKS_DASHBOARDS_GENIE_DELETE_CONVERSATIONAcciónTool to delete a conversation from a Genie space programmatically. Use when you need to remove conversations to manage the Genie space limits (10,000 conversations per space). Useful for deleting older or test conversations that are no longer needed.
Parámetros de entrada
space_idstringObligatorioThe unique identifier of the Genie space containing the conversation to delete
conversation_idstringObligatorioThe unique identifier of the conversation to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Genie Conversation MessageDATABRICKS_DASHBOARDS_GENIE_DELETE_CONVERSATION_MESSAGEAcciónTool to delete a specific message from a Genie conversation. Use when you need to remove individual messages from conversations. This operation permanently deletes the message and cannot be undone.
DATABRICKS_DASHBOARDS_GENIE_DELETE_CONVERSATION_MESSAGEAcciónTool to delete a specific message from a Genie conversation. Use when you need to remove individual messages from conversations. This operation permanently deletes the message and cannot be undone.
Parámetros de entrada
space_idstringObligatorioThe ID associated with the Genie space where the message is located
message_idstringObligatorioThe ID associated with the message to delete
conversation_idstringObligatorioThe ID associated with the conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute Message Attachment QueryDATABRICKS_DASHBOARDS_GENIE_EXECUTE_MESSAGE_ATTACHMENT_QUERYAcciónTool to execute SQL query for an expired message attachment in a Genie space. Use when a query attachment has expired and needs to be re-executed to retrieve fresh results. Returns SQL statement execution results with schema, metadata, and data.
DATABRICKS_DASHBOARDS_GENIE_EXECUTE_MESSAGE_ATTACHMENT_QUERYAcciónTool to execute SQL query for an expired message attachment in a Genie space. Use when a query attachment has expired and needs to be re-executed to retrieve fresh results. Returns SQL statement execution results with schema, metadata, and data.
Parámetros de entrada
space_idstringObligatorioGenie space ID - The unique identifier for the Genie space
message_idstringObligatorioMessage ID - The unique identifier for the message within the conversation
attachment_idstringObligatorioAttachment ID - The unique identifier for the query attachment associated with the message
conversation_idstringObligatorioConversation ID - The unique identifier for the conversation within the space
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute Genie Message QueryDATABRICKS_DASHBOARDS_GENIE_EXECUTE_MESSAGE_QUERYAcciónTool to execute the SQL query associated with a Genie message. Use when you need to run the query generated by Genie and retrieve result data. Note: This endpoint is deprecated in favor of ExecuteMessageAttachmentQuery.
DATABRICKS_DASHBOARDS_GENIE_EXECUTE_MESSAGE_QUERYAcciónTool to execute the SQL query associated with a Genie message. Use when you need to run the query generated by Genie and retrieve result data. Note: This endpoint is deprecated in favor of ExecuteMessageAttachmentQuery.
Parámetros de entrada
space_idstringObligatorioThe ID associated with the Genie space where the conversation is located
message_idstringObligatorioThe ID associated with the message containing the query to execute
conversation_idstringObligatorioThe ID associated with the target conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Genie MessageDATABRICKS_DASHBOARDS_GENIE_GET_MESSAGEAcciónTool to retrieve details of a specific message from a Genie conversation. Use when you need to get message content, status, attachments, or check processing status of a previously created message.
DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGEAcciónTool to retrieve details of a specific message from a Genie conversation. Use when you need to get message content, status, attachments, or check processing status of a previously created message.
Parámetros de entrada
space_idstringObligatorioThe ID associated with the Genie space where the target conversation is located
message_idstringObligatorioThe ID associated with the target message from the identified conversation
conversation_idstringObligatorioThe ID associated with the target conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Genie Message Attachment Query ResultDATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_ATTACHMENT_QUERY_RESULTAcciónTool to retrieve SQL query results from a Genie message attachment. Use when the message status is EXECUTING_QUERY or COMPLETED and you need to fetch the actual query execution results. Returns statement execution details including query data, schema, and metadata with a maximum of 5000 rows.
DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_ATTACHMENT_QUERY_RESULTAcciónTool to retrieve SQL query results from a Genie message attachment. Use when the message status is EXECUTING_QUERY or COMPLETED and you need to fetch the actual query execution results. Returns statement execution details including query data, schema, and metadata with a maximum of 5000 rows.
Parámetros de entrada
space_idstringObligatorioThe Genie space ID
message_idstringObligatorioThe message ID
attachment_idstringObligatorioThe query attachment ID from the message response
conversation_idstringObligatorioThe conversation ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Genie Message Query ResultDATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_QUERY_RESULTAcciónTool to retrieve SQL query execution results for a Genie message (up to 5000 rows). Use when message status is EXECUTING_QUERY or COMPLETED and the message has a query attachment. Returns query results with schema, metadata, and data in inline or external link format.
DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_QUERY_RESULTAcciónTool to retrieve SQL query execution results for a Genie message (up to 5000 rows). Use when message status is EXECUTING_QUERY or COMPLETED and the message has a query attachment. Returns query results with schema, metadata, and data in inline or external link format.
Parámetros de entrada
space_idstringObligatorioThe ID associated with the Genie space where the conversation is located
message_idstringObligatorioThe ID associated with the message that has a query attachment
conversation_idstringObligatorioThe ID associated with the conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Genie Message Query ResultDATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_QUERY_RESULT_BY_ATTACHMENTAcciónTool to retrieve SQL query execution results for a message attachment in a Genie space conversation. Use when you need to fetch query results from a Genie conversation message. Note: This endpoint is deprecated; consider using GetMessageAttachmentQueryResult instead. Returns results only when message status is EXECUTING_QUERY or COMPLETED. Maximum 5,000 rows per result.
DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_QUERY_RESULT_BY_ATTACHMENTAcciónTool to retrieve SQL query execution results for a message attachment in a Genie space conversation. Use when you need to fetch query results from a Genie conversation message. Note: This endpoint is deprecated; consider using GetMessageAttachmentQueryResult instead. Returns results only when message status is EXECUTING_QUERY or COMPLETED. Maximum 5,000 rows per result.
Parámetros de entrada
space_idstringObligatorioThe Genie space ID
message_idstringObligatorioThe message ID containing the query attachment
attachment_idstringObligatorioThe attachment ID referencing the query results
conversation_idstringObligatorioThe conversation ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Genie Space DetailsDATABRICKS_DASHBOARDS_GENIE_GET_SPACEAcciónTool to retrieve detailed information about a specific Databricks Genie space by ID. Use when you need to get configuration details, metadata, and optionally the serialized space content for backup or promotion across workspaces. Requires at least CAN EDIT permission to retrieve the serialized space content.
DATABRICKS_DASHBOARDS_GENIE_GET_SPACEAcciónTool to retrieve detailed information about a specific Databricks Genie space by ID. Use when you need to get configuration details, metadata, and optionally the serialized space content for backup or promotion across workspaces. Requires at least CAN EDIT permission to retrieve the serialized space content.
Parámetros de entrada
space_idstringObligatorioThe unique identifier for the Genie space to retrieve
include_serialized_spacebooleanWhen set to true, includes the serialized string representation of the Genie space in the response, including instructions, benchmarks, joins, and other configuration details. Requires at least CAN EDIT permission on the space. Default: false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Genie Conversation MessagesDATABRICKS_DASHBOARDS_GENIE_LIST_CONVERSATION_MESSAGESAcciónTool to retrieve all messages from a specific conversation thread in a Genie space. Use when you need to view the complete message history of a conversation including user queries and AI responses. Supports pagination for conversations with many messages.
DATABRICKS_DASHBOARDS_GENIE_LIST_CONVERSATION_MESSAGESAcciónTool to retrieve all messages from a specific conversation thread in a Genie space. Use when you need to view the complete message history of a conversation including user queries and AI responses. Supports pagination for conversations with many messages.
Parámetros de entrada
space_idstringObligatorioThe unique identifier of the Genie space where the conversation is located
page_sizeintegerMaximum number of messages to return per page. Use for pagination to limit the number of results returned.
page_tokenstringToken to get the next page of results. Use the next_page_token from a previous response to retrieve subsequent pages.
conversation_idstringObligatorioThe unique identifier of the conversation thread to list messages from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Genie ConversationsDATABRICKS_DASHBOARDS_GENIE_LIST_CONVERSATIONSAcciónTool to retrieve all existing conversation threads within a Genie space. Use when you need to view conversations in a Genie space, either for the current user or all users if you have CAN MANAGE permission. Supports pagination for spaces with many conversations.
DATABRICKS_DASHBOARDS_GENIE_LIST_CONVERSATIONSAcciónTool to retrieve all existing conversation threads within a Genie space. Use when you need to view conversations in a Genie space, either for the current user or all users if you have CAN MANAGE permission. Supports pagination for spaces with many conversations.
Parámetros de entrada
space_idstringObligatorioThe unique identifier of the Genie space containing the conversations to retrieve
page_sizeintegerMaximum number of conversations to return per page. Use for pagination to limit the number of results returned.
page_tokenstringToken to get the next page of results. Use the next_page_token from a previous response to retrieve the next page.
include_allbooleanInclude all conversations in the space across all users. Requires at least CAN MANAGE permission on the space. If not set, only returns conversations created by the requesting user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Genie SpacesDATABRICKS_DASHBOARDS_GENIE_LIST_SPACESAcciónTool to retrieve all Genie spaces in the workspace that the authenticated user has access to. Use when you need to list available Genie spaces, their metadata, and warehouse associations. Supports pagination for workspaces with many spaces.
DATABRICKS_DASHBOARDS_GENIE_LIST_SPACESAcciónTool to retrieve all Genie spaces in the workspace that the authenticated user has access to. Use when you need to list available Genie spaces, their metadata, and warehouse associations. Supports pagination for workspaces with many spaces.
Parámetros de entrada
page_sizeintegerMaximum number of spaces to return per page. Used for pagination to control the number of results returned in a single request.
page_tokenstringPagination token for getting the next page of results. Use the next_page_token value from the previous response to retrieve the next page.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send Genie Message FeedbackDATABRICKS_DASHBOARDS_GENIE_SEND_MESSAGE_FEEDBACKAcciónTool to send feedback for a Genie message. Use when you need to provide positive, negative, or no feedback rating for AI-generated messages in Genie conversations. Positive feedback on responses that join tables or use SQL expressions can prompt Genie to suggest new SQL snippets to space managers for review and approval.
DATABRICKS_DASHBOARDS_GENIE_SEND_MESSAGE_FEEDBACKAcciónTool to send feedback for a Genie message. Use when you need to provide positive, negative, or no feedback rating for AI-generated messages in Genie conversations. Positive feedback on responses that join tables or use SQL expressions can prompt Genie to suggest new SQL snippets to space managers for review and approval.
Parámetros de entrada
ratingstringObligatorioenumThe feedback rating. POSITIVE indicates a positive feedback rating, NEGATIVE indicates a negative feedback rating, NONE indicates no feedback rating provided
POSITIVENEGATIVENONEspace_idstringObligatorioThe ID associated with the Genie space where the message is located
message_idstringObligatorioThe ID associated with the message to provide feedback for
conversation_idstringObligatorioThe ID associated with the conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Start Genie ConversationDATABRICKS_DASHBOARDS_GENIE_START_CONVERSATIONAcciónTool to start a new Genie conversation in a Databricks space for natural language data queries. Use when you need to ask questions about data using natural language. The message processes asynchronously, so initial status will be IN_PROGRESS. Poll the message status to get the completed response with query results.
DATABRICKS_DASHBOARDS_GENIE_START_CONVERSATIONAcciónTool to start a new Genie conversation in a Databricks space for natural language data queries. Use when you need to ask questions about data using natural language. The message processes asynchronously, so initial status will be IN_PROGRESS. Poll the message status to get the completed response with query results.
Parámetros de entrada
contentstringObligatorioThe text of the message that starts the conversation. This is the user's initial question or prompt
space_idstringObligatorioThe ID of the Genie space where you want to start a conversation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trash Genie SpaceDATABRICKS_DASHBOARDS_GENIE_TRASH_SPACEAcciónTool to move a Genie space to trash instead of permanently deleting it. Use when you need to remove a Genie space while retaining recovery options. Trashed spaces follow standard Databricks trash behavior with 30-day retention before permanent deletion. Requires CAN MANAGE permission on the space.
DATABRICKS_DASHBOARDS_GENIE_TRASH_SPACEAcciónTool to move a Genie space to trash instead of permanently deleting it. Use when you need to remove a Genie space while retaining recovery options. Trashed spaces follow standard Databricks trash behavior with 30-day retention before permanent deletion. Requires CAN MANAGE permission on the space.
Parámetros de entrada
space_idstringObligatorioThe unique identifier of the Genie space to move to trash. This ID uniquely identifies the Genie space within the workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Genie SpaceDATABRICKS_DASHBOARDS_GENIE_UPDATE_SPACEAcciónTool to update an existing Genie space configuration. Use when you need to modify a Genie space's title, description, warehouse assignment, or complete serialized configuration. Supports partial updates (only provide fields you want to change) or full replacement via serialized_space. Useful for CI/CD pipelines, version control, and automated space management.
DATABRICKS_DASHBOARDS_GENIE_UPDATE_SPACEAcciónTool to update an existing Genie space configuration. Use when you need to modify a Genie space's title, description, warehouse assignment, or complete serialized configuration. Supports partial updates (only provide fields you want to change) or full replacement via serialized_space. Useful for CI/CD pipelines, version control, and automated space management.
Parámetros de entrada
idstringObligatorioThe unique identifier for the Genie space to update. This is the space_id from the list spaces API response.
titlestringUpdated title/display name for the Genie Space. If provided, this will override the existing title.
descriptionstringUpdated description of the Genie Space. Describes the space's purpose, data sources, and intended use cases.
warehouse_idstringUpdated SQL warehouse ID to associate with the Genie Space. If provided, this warehouse will be used for executing queries in this space.
serialized_spacestringThe complete serialized configuration of the Genie Space in JSON string format. This allows for full replacement of the space configuration including sample queries, instructions, and data sources. Retrieved from Get Genie Space API with include_serialized_space=true parameter.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Lakeview DashboardDATABRICKS_DASHBOARDS_LAKEVIEW_CREATEAcciónTool to create a new Lakeview dashboard in Databricks. Use when you need to create AI/BI dashboards for data visualization and analytics. Only the display_name parameter is required to create a blank dashboard, or you can provide serialized_dashboard to duplicate an existing dashboard.
DATABRICKS_DASHBOARDS_LAKEVIEW_CREATEAcciónTool to create a new Lakeview dashboard in Databricks. Use when you need to create AI/BI dashboards for data visualization and analytics. Only the display_name parameter is required to create a blank dashboard, or you can provide serialized_dashboard to duplicate an existing dashboard.
Parámetros de entrada
parent_pathstringThe workspace path of the folder where the dashboard should be stored
display_namestringObligatorioThe name to display for the dashboard. This is the only required parameter
warehouse_idstringThe UUID of the warehouse to use as the default warehouse for the dashboard. Can be omitted to use workspace defaults
serialized_dashboardstringJSON string containing the dashboard configuration and content. Can be copied from an existing dashboard to duplicate it, or omitted to create a blank dashboard
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Lakeview Dashboard ScheduleDATABRICKS_DASHBOARDS_LAKEVIEW_DELETE_SCHEDULEAcciónTool to delete a dashboard schedule from a Lakeview dashboard. Use when you need to remove scheduled refreshes or updates for a dashboard. Provide the etag parameter to ensure the schedule hasn't been modified since last retrieval (optimistic concurrency control).
DATABRICKS_DASHBOARDS_LAKEVIEW_DELETE_SCHEDULEAcciónTool to delete a dashboard schedule from a Lakeview dashboard. Use when you need to remove scheduled refreshes or updates for a dashboard. Provide the etag parameter to ensure the schedule hasn't been modified since last retrieval (optimistic concurrency control).
Parámetros de entrada
etagstringThe etag for the schedule. Can be provided to verify that the schedule has not been modified from its last retrieval. Used for optimistic concurrency control
schedule_idstringObligatorioUUID identifying the schedule to delete. This is a 32-digit alphanumeric value
dashboard_idstringObligatorioUUID identifying the dashboard to which the schedule belongs. This is a 32-digit alphanumeric value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Published Dashboard Token InfoDATABRICKS_DASHBOARDS_LAKEVIEW_EMBEDDED_GET_PUBLISHED_DASHBOARD_TOKEN_INFOAcciónTool to retrieve authorization info for generating downscoped tokens to access published Lakeview dashboards. Use when you need to generate OAuth tokens for dashboard embedding for external users, ensuring tokens are properly scoped to prevent leaking privileged access.
DATABRICKS_DASHBOARDS_LAKEVIEW_EMBEDDED_GET_PUBLISHED_DASHBOARD_TOKEN_INFOAcciónTool to retrieve authorization info for generating downscoped tokens to access published Lakeview dashboards. Use when you need to generate OAuth tokens for dashboard embedding for external users, ensuring tokens are properly scoped to prevent leaking privileged access.
Parámetros de entrada
dashboard_idstringObligatorioThe UUID identifier for the published dashboard
external_valuestringObligatorioA value used for data filtering in queries. Can include personally identifiable information
external_viewer_idstringObligatorioA unique identifier for the external user. Must not include personally identifiable information (PII)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Lakeview Dashboard DetailsDATABRICKS_DASHBOARDS_LAKEVIEW_GETAcciónTool to retrieve details about a draft AI/BI Lakeview dashboard from the workspace. Use when you need to get comprehensive information about a dashboard including metadata, configuration, state, and serialized dashboard content.
DATABRICKS_DASHBOARDS_LAKEVIEW_GETAcciónTool to retrieve details about a draft AI/BI Lakeview dashboard from the workspace. Use when you need to get comprehensive information about a dashboard including metadata, configuration, state, and serialized dashboard content.
Parámetros de entrada
dashboard_idstringObligatorioThe UUID identifier for the dashboard. This is a 32-digit alphanumeric value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Published Lakeview DashboardDATABRICKS_DASHBOARDS_LAKEVIEW_GET_PUBLISHEDAcciónTool to retrieve the current published version of a Lakeview dashboard. Use when you need to get information about the published dashboard including its display name, embedded credentials status, warehouse configuration, and last revision timestamp.
DATABRICKS_DASHBOARDS_LAKEVIEW_GET_PUBLISHEDAcciónTool to retrieve the current published version of a Lakeview dashboard. Use when you need to get information about the published dashboard including its display name, embedded credentials status, warehouse configuration, and last revision timestamp.
Parámetros de entrada
dashboard_idstringObligatorioThe UUID identifier for the published dashboard. This is a 32-digit alphanumeric value that uniquely identifies the dashboard
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Lakeview Dashboard ScheduleDATABRICKS_DASHBOARDS_LAKEVIEW_GET_SCHEDULEAcciónTool to retrieve a specific schedule for a Databricks AI/BI Lakeview dashboard. Use when you need to get schedule details including cron expressions, pause status, warehouse configuration, and subscription information. Each dashboard can have up to 10 schedules, with each schedule supporting up to 100 subscriptions.
DATABRICKS_DASHBOARDS_LAKEVIEW_GET_SCHEDULEAcciónTool to retrieve a specific schedule for a Databricks AI/BI Lakeview dashboard. Use when you need to get schedule details including cron expressions, pause status, warehouse configuration, and subscription information. Each dashboard can have up to 10 schedules, with each schedule supporting up to 100 subscriptions.
Parámetros de entrada
schedule_idstringObligatorioUUID identifying the schedule to retrieve. This is a 32-digit alphanumeric value
dashboard_idstringObligatorioUUID identifying the dashboard to which the schedule belongs. This is a 32-digit alphanumeric value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Publish Lakeview DashboardDATABRICKS_DASHBOARDS_LAKEVIEW_PUBLISHAcciónTool to publish an AI/BI Lakeview dashboard making it accessible via public link. Use when you need to publish a draft dashboard with embedded credentials and assign a warehouse for query execution. After successful publication, the dashboard becomes accessible at https://<deployment-url>/dashboardsv3/<resource_id>/published.
DATABRICKS_DASHBOARDS_LAKEVIEW_PUBLISHAcciónTool to publish an AI/BI Lakeview dashboard making it accessible via public link. Use when you need to publish a draft dashboard with embedded credentials and assign a warehouse for query execution. After successful publication, the dashboard becomes accessible at https://<deployment-url>/dashboardsv3/<resource_id>/published.
Parámetros de entrada
dashboard_idstringObligatorioThe UUID identifier of the dashboard to publish. This is a 32-digit alphanumeric value
warehouse_idstringThe UUID of the warehouse to be used for running the published dashboard. This overrides any warehouse specified in the draft dashboard. If omitted, the published dashboard uses the same warehouse assigned to the draft dashboard
embed_credentialsbooleanFlag to indicate if the publisher's credentials should be embedded in the published dashboard. When true, the publisher's credentials are embedded and will be used to execute the published dashboard's queries. The publisher cannot embed different user's credentials. Defaults to true
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trash Lakeview DashboardDATABRICKS_DASHBOARDS_LAKEVIEW_TRASHAcciónTool to move a Lakeview dashboard to trash instead of permanently deleting it. Use when you need to remove a dashboard while retaining recovery options. Trashed dashboards can be recovered within 30 days before permanent deletion.
DATABRICKS_DASHBOARDS_LAKEVIEW_TRASHAcciónTool to move a Lakeview dashboard to trash instead of permanently deleting it. Use when you need to remove a dashboard while retaining recovery options. Trashed dashboards can be recovered within 30 days before permanent deletion.
Parámetros de entrada
dashboard_idstringObligatorioThe UUID identifier for the dashboard to be trashed. This is a 32-digit alphanumeric value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unpublish Lakeview DashboardDATABRICKS_DASHBOARDS_LAKEVIEW_UNPUBLISHAcciónTool to unpublish an AI/BI Lakeview dashboard while preserving its draft version. Use when you need to remove the published version of a dashboard. The draft version remains available and can be republished later if needed.
DATABRICKS_DASHBOARDS_LAKEVIEW_UNPUBLISHAcciónTool to unpublish an AI/BI Lakeview dashboard while preserving its draft version. Use when you need to remove the published version of a dashboard. The draft version remains available and can be republished later if needed.
Parámetros de entrada
dashboard_idstringObligatorioThe UUID identifier of the dashboard to unpublish. This is a 32-digit alphanumeric value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Lakeview DashboardDATABRICKS_DASHBOARDS_LAKEVIEW_UPDATEAcciónTool to update a draft Lakeview dashboard configuration and metadata. Use when you need to modify dashboard properties such as display name, warehouse, location, or content. This is a partial update operation - only provided fields will be updated. The etag field can be used for optimistic concurrency control to prevent conflicts from concurrent modifications.
DATABRICKS_DASHBOARDS_LAKEVIEW_UPDATEAcciónTool to update a draft Lakeview dashboard configuration and metadata. Use when you need to modify dashboard properties such as display name, warehouse, location, or content. This is a partial update operation - only provided fields will be updated. The etag field can be used for optimistic concurrency control to prevent conflicts from concurrent modifications.
Parámetros de entrada
etagstringThe etag for the dashboard. Used for optimistic concurrency control. If the version specified in the etag does not match the current version, the update is rejected
parent_pathstringThe workspace path of the folder containing the dashboard (with leading slash). When provided, moves the dashboard to a new location
dashboard_idstringObligatorioUUID identifying the dashboard to update. This is required to identify which dashboard to modify
display_namestringThe display name of the dashboard. When provided, updates the dashboard name
warehouse_idstringThe warehouse ID used to run the dashboard. When provided, updates the default warehouse
dataset_schemastringSets the default schema for all datasets in this dashboard. When provided, updates the default schema
dataset_catalogstringSets the default catalog for all datasets in this dashboard. When provided, updates the default catalog
serialized_dashboardstringThe contents of the dashboard in serialized string form. This field provides the structure of the JSON string that represents the dashboard's layout and components
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Database CatalogDATABRICKS_DATABASE_DATABASE_CREATE_DATABASE_CATALOGAcciónTool to create a new database catalog in Databricks. Use when you need to establish a catalog for organizing database objects within a specific database instance. Requires appropriate database permissions.
DATABRICKS_DATABASE_DATABASE_CREATE_DATABASE_CATALOGAcciónTool to create a new database catalog in Databricks. Use when you need to establish a catalog for organizing database objects within a specific database instance. Requires appropriate database permissions.
Parámetros de entrada
namestringObligatorioThe name of the catalog to create. Must be unique within the database instance
database_namestringObligatorioThe name of the database to associate with this catalog
instance_namestringObligatorioThe name of the database instance where the catalog will be created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Database InstanceDATABRICKS_DATABASE_DATABASE_CREATE_DATABASE_INSTANCEAcciónTool to create a Lakebase database instance with specified configuration. Use when you need to provision a new database instance in Databricks with database owner and superuser role. The creator receives full administrative capabilities on the instance.
DATABRICKS_DATABASE_DATABASE_CREATE_DATABASE_INSTANCEAcciónTool to create a Lakebase database instance with specified configuration. Use when you need to provision a new database instance in Databricks with database owner and superuser role. The creator receives full administrative capabilities on the instance.
Parámetros de entrada
namestringObligatorioDatabase instance identifier. Must be 1-63 characters, containing only letters and hyphens
capacitystringObligatorioenumCompute capacity units allocated to the instance. CU_1 for minimal workloads, CU_2 for light workloads, CU_4 for moderate workloads, CU_8 for intensive workloads
CU_1CU_2CU_4CU_8custom_tagsobject[]List of custom key-value pair tags to associate with the instance
usage_policy_idstringAssociated usage policy identifier for governing instance usage
enable_pg_native_loginbooleanWhether to enable PostgreSQL native password login on the instance
retention_window_in_daysintegerPoint-in-time recovery window. Valid range: 2-35 days. Default: 7 days. Determines how far back data can be restored
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Database InstanceDATABRICKS_DATABASE_DATABASE_DELETE_DATABASE_INSTANCEAcciónTool to delete a Lakebase Postgres database instance. Use when you need to permanently remove a database instance and all associated data. The instance should be stopped before deletion, and users must have CAN MANAGE permissions. This operation cannot be undone.
DATABRICKS_DATABASE_DATABASE_DELETE_DATABASE_INSTANCEAcciónTool to delete a Lakebase Postgres database instance. Use when you need to permanently remove a database instance and all associated data. The instance should be stopped before deletion, and users must have CAN MANAGE permissions. This operation cannot be undone.
Parámetros de entrada
idstringObligatorioThe name of the database instance to delete. Must be 1-63 characters, containing only lowercase letters and hyphens
forcebooleanWhen set to true, deletes child instances along with the parent instance. Useful for deleting instances with descendant instances created via PITR (Point-in-Time Recovery)
purgebooleanObligatorioMust be set to true to delete the database instance. This is a mandatory safety parameter to confirm intentional deletion
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Synced Database TableDATABRICKS_DATABASE_DATABASE_DELETE_SYNCED_DATABASE_TABLEAcciónTool to delete a synced table from Unity Catalog and stop data refreshes. Use when you need to deregister a synced table connection between Unity Catalog and a database instance. Note: The underlying Postgres table remains and must be manually dropped to free space.
DATABRICKS_DATABASE_DATABASE_DELETE_SYNCED_DATABASE_TABLEAcciónTool to delete a synced table from Unity Catalog and stop data refreshes. Use when you need to deregister a synced table connection between Unity Catalog and a database instance. Note: The underlying Postgres table remains and must be manually dropped to free space.
Parámetros de entrada
synced_table_namestringObligatorioFull three-part name (catalog.schema.table) of the synced table to delete from Unity Catalog. Deleting stops data refreshes and deregisters the table, but the underlying Postgres table must be manually dropped to free space
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Find Database Instance By UIDDATABRICKS_DATABASE_DATABASE_FIND_DATABASE_INSTANCE_BY_UIDAcciónTool to find a database instance by its unique identifier (UID). Use when you need to retrieve instance details using the immutable UUID instead of the instance name.
DATABRICKS_DATABASE_DATABASE_FIND_DATABASE_INSTANCE_BY_UIDAcciónTool to find a database instance by its unique identifier (UID). Use when you need to retrieve instance details using the immutable UUID instead of the instance name.
Parámetros de entrada
uidstringObligatorioUID of the database instance to retrieve. An immutable UUID identifier for the instance
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Database CredentialDATABRICKS_DATABASE_DATABASE_GENERATE_DATABASE_CREDENTIALAcciónTool to generate OAuth token for database instance authentication. Use when you need to authenticate to Databricks database instances. The generated token is workspace-scoped and expires after one hour, though open connections remain active past expiration.
DATABRICKS_DATABASE_DATABASE_GENERATE_DATABASE_CREDENTIALAcciónTool to generate OAuth token for database instance authentication. Use when you need to authenticate to Databricks database instances. The generated token is workspace-scoped and expires after one hour, though open connections remain active past expiration.
Parámetros de entrada
claimsstringAdditional claims for the credential request. Added in SDK v0.58.0 for extending token capabilities
request_idstringObligatorioA unique request identifier, typically generated as a UUID. This identifier helps track the credential generation request
instance_namesstring[]ObligatorioList of database instance names for which credentials should be generated. These are the names of database instances that will be accessible with the generated token
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Database InstanceDATABRICKS_DATABASE_DATABASE_GET_DATABASE_INSTANCEAcciónTool to retrieve detailed information about a specific database instance by its name identifier. Use when you need to get comprehensive configuration details including capacity, state, retention settings, and connection endpoints for a PostgreSQL database instance managed by Databricks Lakebase.
DATABRICKS_DATABASE_DATABASE_GET_DATABASE_INSTANCEAcciónTool to retrieve detailed information about a specific database instance by its name identifier. Use when you need to get comprehensive configuration details including capacity, state, retention settings, and connection endpoints for a PostgreSQL database instance managed by Databricks Lakebase.
Parámetros de entrada
namestringObligatorioThe name of the database instance to retrieve. This is the unique identifier for the instance (1-63 characters, letters and hyphens only)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Data Quality MonitorDATABRICKS_DATAQUALITY_DATA_QUALITY_CREATE_MONITORAcciónTool to create a data quality monitor for a Unity Catalog Delta table. Use when you need to set up monitoring for table quality, track data drift, or monitor ML model inference logs. Supports snapshot, time series, and inference log monitoring types. Only one monitor can be created per table.
DATABRICKS_DATAQUALITY_DATA_QUALITY_CREATE_MONITORAcciónTool to create a data quality monitor for a Unity Catalog Delta table. Use when you need to set up monitoring for table quality, track data drift, or monitor ML model inference logs. Supports snapshot, time series, and inference log monitoring types. Only one monitor can be created per table.
Parámetros de entrada
scheduleobjectSchedule configuration for auto-refresh.
snapshotobjectSnapshot table monitoring configuration. Use empty object for snapshot monitoring.
assets_dirstringObligatorioAbsolute path to directory for storing monitoring assets (e.g., /Workspace/Users/{user}/databricks_lakehouse_monitoring/{catalog}.{schema}.{table_name})
table_namestringObligatorioFully qualified Unity Catalog table name in format {catalog}.{schema}.{table_name}. Must be a managed or external Delta table.
time_seriesobjectTime series monitoring configuration.
warehouse_idstringWarehouse ID for dashboard creation
inference_logobjectInference log monitoring configuration for ML models.
notificationsobjectNotification settings for quality monitor.
slicing_exprsstring[]Column expressions for data slicing
custom_metricsobject[]Custom metric definitions
output_schema_namestringObligatorioSchema for output metric tables in format {catalog}.{schema}
baseline_table_namestringBaseline table for drift metrics. Must match monitored table schema.
skip_builtin_dashboardbooleanSkip default dashboard creation
data_classification_configobjectData classification configuration.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DBFS Directory ContentsDATABRICKS_DBFS_LISTAcciónTool to list the contents of a directory or get details of a file in DBFS. Use when you need to browse DBFS directories or check file details. Note: Recommended for directories with less than 10,000 files due to ~60 second timeout limitation. Throws RESOURCE_DOES_NOT_EXIST error if path doesn't exist.
DATABRICKS_DBFS_LISTAcciónTool to list the contents of a directory or get details of a file in DBFS. Use when you need to browse DBFS directories or check file details. Note: Recommended for directories with less than 10,000 files due to ~60 second timeout limitation. Throws RESOURCE_DOES_NOT_EXIST error if path doesn't exist.
Parámetros de entrada
pathstringObligatorioThe absolute DBFS path of the file or directory to list. Must be an absolute path starting with '/'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Databricks ClusterDATABRICKS_DELETE_CLUSTERAcciónTool to terminate a Databricks Spark cluster asynchronously. Use when you need to stop and remove a cluster. The cluster is terminated asynchronously and removed after completion. Cluster configuration is retained for 30 days after termination.
DATABRICKS_DELETE_CLUSTERAcciónTool to terminate a Databricks Spark cluster asynchronously. Use when you need to stop and remove a cluster. The cluster is terminated asynchronously and removed after completion. Cluster configuration is retained for 30 days after termination.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to terminate. This can be found in the Databricks workspace URL when viewing a cluster configuration
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Databricks Job RunDATABRICKS_DELETE_RUN_OUTPUTAcciónTool to delete a non-active Databricks job run from the system. Use when you need to manually remove completed runs before the 60-day auto-deletion. Returns an error if the run is still active. Only non-active runs can be deleted.
DATABRICKS_DELETE_RUN_OUTPUTAcciónTool to delete a non-active Databricks job run from the system. Use when you need to manually remove completed runs before the 60-day auto-deletion. Returns an error if the run is still active. Only non-active runs can be deleted.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier of the run to delete. This must be a non-active run. Active runs cannot be deleted and will result in an error
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete User by IDDATABRICKS_DELETE_USER_BY_IDAcciónTool to delete a user from the Databricks workspace by their ID. Use when you need to remove a user resource from the workspace. A user that does not own or belong to a workspace is automatically purged after 30 days. Only workspace admins can deactivate users at the workspace level.
DATABRICKS_DELETE_USER_BY_IDAcciónTool to delete a user from the Databricks workspace by their ID. Use when you need to remove a user resource from the workspace. A user that does not own or belong to a workspace is automatically purged after 30 days. Only workspace admins can deactivate users at the workspace level.
Parámetros de entrada
user_idstringObligatorioThe unique identifier of the user to delete from the Databricks workspace. This is the SCIM user ID that can be obtained from user listing or creation operations
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Databricks ClusterDATABRICKS_EDIT_CLUSTERAcciónTool to edit an existing Databricks cluster configuration. Use when you need to modify cluster settings such as size, Spark version, node types, or cloud-specific attributes. The cluster must be in RUNNING or TERMINATED state. If updated while RUNNING, it will restart to apply changes.
DATABRICKS_EDIT_CLUSTERAcciónTool to edit an existing Databricks cluster configuration. Use when you need to modify cluster settings such as size, Spark version, node types, or cloud-specific attributes. The cluster must be in RUNNING or TERMINATED state. If updated while RUNNING, it will restart to apply changes.
Parámetros de entrada
autoscaleobjectAutoscaling configuration for cluster workers.
policy_idstringCluster policy ID to validate configuration and preset defaults
cluster_idstringObligatorioUnique identifier of the cluster to edit. The cluster must be in RUNNING or TERMINATED state
spark_confobjectCustom Spark configuration key-value pairs
custom_tagsobjectUser-defined resource tags (max 45 tags). Serverless clusters should have ResourceClass=Serverless tag
num_workersintegerNumber of worker nodes. Total Spark nodes = num_workers + 1 (driver). Use 0 for single-node clusters. Required unless using autoscale
cluster_namestringUser-defined name for the cluster; does not need to be unique
docker_imageobjectDocker container configuration.
init_scriptsobject[]Initialization scripts executed sequentially at cluster startup
node_type_idstringNode type for worker nodes (e.g., 'i3.xlarge' for AWS, 'Standard_DS3_v2' for Azure, 'n2-highmem-4' for GCP). Not needed if instance_pool_id is specified
spark_versionstringObligatorioRuntime version of the cluster (e.g., '11.3.x-scala2.12', '12.2.x-scala2.12', '13.x-scala2.12')
workload_typeobjectWorkload type restrictions for cluster usage.
aws_attributesobjectAWS-specific cluster configuration.
gcp_attributesobjectGCP-specific cluster configuration.
is_single_nodebooleanWhen true, automatically configures single-node settings (sets num_workers to 0)
runtime_enginestringenumRuntime engine type. Defaults to STANDARD unless spark_version contains '-photon-'
STANDARDPHOTONspark_env_varsobjectEnvironment variables for Spark clusters
ssh_public_keysstring[]SSH public keys to add to each Spark node (max 10 keys). Login with username 'ubuntu' on port 2200
azure_attributesobjectAzure-specific cluster configuration.
cluster_log_confobjectCluster log delivery configuration.
instance_pool_idstringInstance pool identifier for worker nodes (alternative to node_type_id)
single_user_namestringUsername to assign to an interactive cluster (required for SINGLE_USER mode)
idempotency_tokenstringToken to guarantee idempotency (max 64 characters)
data_security_modestringenumSecurity features of the cluster. Unity Catalog requires SINGLE_USER or USER_ISOLATION mode
NONESINGLE_USERUSER_ISOLATIONLEGACY_TABLE_ACLLEGACY_PASSTHROUGHLEGACY_SINGLE_USERcluster_mount_infosobject[]Remote storage mount configurations
driver_node_type_idstringNode type for the Spark driver. Defaults to node_type_id if not specified
enable_elastic_diskbooleanEnables autoscaling local storage instead of fixed EBS volumes
autotermination_minutesintegerAutomatically terminate after inactivity. Valid range: 10-10000 minutes
driver_instance_pool_idstringInstance pool identifier for driver node
apply_policy_default_valuesbooleanWhether to apply policy default values
enable_local_disk_encryptionbooleanEnables encryption for locally attached disk data
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Block to DBFS StreamDATABRICKS_FILES_DBFS_ADD_BLOCKAcciónTool to append a block of data to an open DBFS stream. Use when uploading large files in chunks as part of the DBFS streaming upload workflow: 1) create a stream handle, 2) add blocks, 3) close the stream. Each block is limited to 1 MB of base64-encoded data.
DATABRICKS_FILES_DBFS_ADD_BLOCKAcciónTool to append a block of data to an open DBFS stream. Use when uploading large files in chunks as part of the DBFS streaming upload workflow: 1) create a stream handle, 2) add blocks, 3) close the stream. Each block is limited to 1 MB of base64-encoded data.
Parámetros de entrada
datastringObligatorioThe base64-encoded data to append to the stream. This has a limit of 1 MB. If the block of data exceeds 1 MB, throws MAX_BLOCK_SIZE_EXCEEDED exception
handleintegerObligatorioThe handle on an open stream. Must reference an existing open stream obtained from the create endpoint. If the handle does not exist, throws RESOURCE_DOES_NOT_EXIST exception
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create DBFS File StreamDATABRICKS_FILES_DBFS_CREATEAcciónTool to open a stream to write to a DBFS file and returns a handle. Use when uploading files to DBFS using the streaming workflow: 1) create a stream handle, 2) add blocks of data, 3) close the stream. The returned handle has a 10-minute idle timeout and must be used within that period.
DATABRICKS_FILES_DBFS_CREATEAcciónTool to open a stream to write to a DBFS file and returns a handle. Use when uploading files to DBFS using the streaming workflow: 1) create a stream handle, 2) add blocks of data, 3) close the stream. The returned handle has a 10-minute idle timeout and must be used within that period.
Parámetros de entrada
pathstringObligatorioThe path of the new file. The path should be the absolute DBFS path (e.g., /path/to/file.txt). If a file or directory already exists on the given path and overwrite is set to false, throws RESOURCE_ALREADY_EXISTS exception
overwritebooleanThe flag that specifies whether to overwrite existing file/files. If a file already exists and overwrite is false, throws RESOURCE_ALREADY_EXISTS exception. Defaults to false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DBFS File or DirectoryDATABRICKS_FILES_DBFS_DELETEAcciónTool to delete a file or directory from DBFS. Use when you need to remove files or directories from the Databricks File System. For large deletions (>10K files), use dbutils.fs in a cluster context instead of the REST API. Operation may return 503 PARTIAL_DELETE for large deletions and should be re-invoked until completion.
DATABRICKS_FILES_DBFS_DELETEAcciónTool to delete a file or directory from DBFS. Use when you need to remove files or directories from the Databricks File System. For large deletions (>10K files), use dbutils.fs in a cluster context instead of the REST API. Operation may return 503 PARTIAL_DELETE for large deletions and should be re-invoked until completion.
Parámetros de entrada
pathstringObligatorioThe absolute DBFS path of the file or directory to delete
recursivebooleanWhether to recursively delete the directory's contents. Deleting empty directories can be done without this flag. Defaults to false. Throws IO_ERROR if attempting to delete a non-empty directory without this flag enabled
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DBFS File StatusDATABRICKS_FILES_DBFS_GET_STATUSAcciónTool to get the information of a file or directory in DBFS. Use when you need to check if a file or directory exists, retrieve its size, type, or last modification time. Throws RESOURCE_DOES_NOT_EXIST exception if the file or directory does not exist.
DATABRICKS_FILES_DBFS_GET_STATUSAcciónTool to get the information of a file or directory in DBFS. Use when you need to check if a file or directory exists, retrieve its size, type, or last modification time. Throws RESOURCE_DOES_NOT_EXIST exception if the file or directory does not exist.
Parámetros de entrada
pathstringObligatorioThe absolute DBFS path of the file or directory. The path should be the absolute DBFS path (e.g., '/FileStore/wheels/test_packages')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Move DBFS File or DirectoryDATABRICKS_FILES_DBFS_MOVEAcciónTool to move a file or directory from one location to another within DBFS. Use when you need to relocate files or directories in Databricks File System. Recursively moves all files if source is a directory. Not recommended for large-scale operations (>10k files) as it may timeout after ~60 seconds.
DATABRICKS_FILES_DBFS_MOVEAcciónTool to move a file or directory from one location to another within DBFS. Use when you need to relocate files or directories in Databricks File System. Recursively moves all files if source is a directory. Not recommended for large-scale operations (>10k files) as it may timeout after ~60 seconds.
Parámetros de entrada
source_pathstringObligatorioThe source path of the file or directory to move. Must be an absolute DBFS path (e.g., /path/to/source/file). Throws RESOURCE_DOES_NOT_EXIST if the source path does not exist
destination_pathstringObligatorioThe destination path where the file or directory should be moved. Must be an absolute DBFS path (e.g., /path/to/destination/file). Throws RESOURCE_ALREADY_EXISTS if a file or directory already exists at the destination path
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read DBFS File ContentsDATABRICKS_FILES_DBFS_READAcciónTool to read the contents of a file from DBFS. Returns base64-encoded file data with maximum read size of 1 MB per request. Use when you need to retrieve file contents from Databricks File System. Throws RESOURCE_DOES_NOT_EXIST if file does not exist, INVALID_PARAMETER_VALUE if path is a directory, MAX_READ_SIZE_EXCEEDED if read length exceeds 1 MB.
DATABRICKS_FILES_DBFS_READAcciónTool to read the contents of a file from DBFS. Returns base64-encoded file data with maximum read size of 1 MB per request. Use when you need to retrieve file contents from Databricks File System. Throws RESOURCE_DOES_NOT_EXIST if file does not exist, INVALID_PARAMETER_VALUE if path is a directory, MAX_READ_SIZE_EXCEEDED if read length exceeds 1 MB.
Parámetros de entrada
pathstringObligatorioThe absolute DBFS path of the file to read. Must be a valid file path (not a directory). Throws RESOURCE_DOES_NOT_EXIST if file does not exist, INVALID_PARAMETER_VALUE if path is a directory
lengthintegerThe number of bytes to read starting from the offset. Maximum limit: 1 MB (1,048,576 bytes). Default: 0.5 MB (524,288 bytes). Must be non-negative. Throws MAX_READ_SIZE_EXCEEDED if read length exceeds 1 MB
offsetintegerThe offset to read from in bytes. Default is 0. Must be non-negative
Parámetros de salida
datastringBase64-encoded contents of the file read. Must be decoded to retrieve actual file contents
errorstringError if any occurred during the execution of the action
bytes_readintegerThe number of bytes read (in the unencoded version), which could be less than the requested length if end of file is reached
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Library StatusesDATABRICKS_GET_ALL_LIBRARY_STATUSESAcciónTool to retrieve status of all libraries across all Databricks clusters. Use when you need to check library installation status on all clusters, including libraries set to be installed on all clusters via the API or libraries UI. Returns detailed status information for each library on each cluster.
DATABRICKS_GET_ALL_LIBRARY_STATUSESAcciónTool to retrieve status of all libraries across all Databricks clusters. Use when you need to check library installation status on all clusters, including libraries set to be installed on all clusters via the API or libraries UI. Returns detailed status information for each library on each cluster.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Cluster InformationDATABRICKS_GET_CLUSTERAcciónTool to retrieve comprehensive metadata and configuration details for a Databricks cluster by its unique identifier. Use when you need to check cluster state, configuration, resources, or operational details. Returns cluster information including state, compute configuration, cloud-specific settings, and resource allocations.
DATABRICKS_GET_CLUSTERAcciónTool to retrieve comprehensive metadata and configuration details for a Databricks cluster by its unique identifier. Use when you need to check cluster state, configuration, resources, or operational details. Returns cluster information including state, compute configuration, cloud-specific settings, and resource allocations.
Parámetros de entrada
cluster_idstringObligatorioThe unique identifier of the cluster to retrieve information about
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group by IDDATABRICKS_GET_GROUP_BY_IDAcciónTool to retrieve information for a specific group in Databricks workspace by its ID. Use when you need to get complete group details including members, roles, entitlements, and metadata. Implements the SCIM 2.0 protocol standard for retrieving Group resources.
DATABRICKS_GET_GROUP_BY_IDAcciónTool to retrieve information for a specific group in Databricks workspace by its ID. Use when you need to get complete group details including members, roles, entitlements, and metadata. Implements the SCIM 2.0 protocol standard for retrieving Group resources.
Parámetros de entrada
idstringObligatorioUnique ID for the group in the Databricks workspace. This is the Databricks group identifier.
attributesstringComma-separated list of attribute names to return, overriding the default set of attributes returned.
excludedAttributesstringComma-separated list of attribute names to exclude from the response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User by IDDATABRICKS_GET_USER_BY_IDAcciónTool to retrieve information for a specific user in Databricks workspace by their ID. Use when you need to get complete user details including identity, contact information, group memberships, roles, and entitlements. Implements the SCIM 2.0 protocol standard for retrieving User resources.
DATABRICKS_GET_USER_BY_IDAcciónTool to retrieve information for a specific user in Databricks workspace by their ID. Use when you need to get complete user details including identity, contact information, group memberships, roles, and entitlements. Implements the SCIM 2.0 protocol standard for retrieving User resources.
Parámetros de entrada
user_idstringObligatorioThe unique Databricks user identifier. This is the SCIM user ID that can be obtained from user listing or creation operations.
attributesstringComma-separated list of attribute names to return, overriding the default set of attributes returned.
excludedAttributesstringComma-separated list of attribute names to exclude from the response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update IAM Account Access Control Rule SetDATABRICKS_IAM_ACCOUNT_ACCESS_CONTROL_UPDATE_RULE_SETAcciónTool to update account-level access control rule set for service principals, groups, or budget policies. Use when you need to replace the entire set of access control rules for a resource. This is a PUT operation that replaces all existing roles - to preserve existing roles, they must be included in the grant_rules array.
DATABRICKS_IAM_ACCOUNT_ACCESS_CONTROL_UPDATE_RULE_SETAcciónTool to update account-level access control rule set for service principals, groups, or budget policies. Use when you need to replace the entire set of access control rules for a resource. This is a PUT operation that replaces all existing roles - to preserve existing roles, they must be included in the grant_rules array.
Parámetros de entrada
namestringObligatorioUnique identifier of the rule set in format 'accounts/{account_id}/servicePrincipals/{application_id}/ruleSets/default' or 'accounts/{account_id}/groups/{group_id}/ruleSets/default' or 'accounts/{account_id}/budgetPolicies/{budget_policy_id}/ruleSets/default'
rule_setobjectObligatorioContainer object for the access control rules. This is a PUT method that replaces the entire rule set - all existing roles are overwritten. To preserve existing roles, they must be included in the grant_rules array
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IAM Account Group V2DATABRICKS_IAM_ACCOUNT_GROUPS_V2_GETAcciónTool to retrieve a specific group resource by its unique identifier from a Databricks account using SCIM v2 protocol. Use when you need to get complete group details including members, roles, and entitlements.
DATABRICKS_IAM_ACCOUNT_GROUPS_V2_GETAcciónTool to retrieve a specific group resource by its unique identifier from a Databricks account using SCIM v2 protocol. Use when you need to get complete group details including members, roles, and entitlements.
Parámetros de entrada
idstringObligatorioThe unique identifier for the group resource
account_idstringObligatorioThe Databricks account identifier
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Current User InformationDATABRICKS_IAM_CURRENT_USER_MEAcciónTool to retrieve details about the currently authenticated user or service principal making the API request. Use when you need to get information about the current user's identity, groups, roles, and entitlements within the Databricks workspace.
DATABRICKS_IAM_CURRENT_USER_MEAcciónTool to retrieve details about the currently authenticated user or service principal making the API request. Use when you need to get information about the current user's identity, groups, roles, and entitlements within the Databricks workspace.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create IAM Group V2DATABRICKS_IAM_GROUPS_V2_CREATEAcciónTool to create a new group in Databricks workspace using SCIM v2 protocol. Use when you need to create a new security group with a unique display name, optionally with initial members, entitlements, and roles.
DATABRICKS_IAM_GROUPS_V2_CREATEAcciónTool to create a new group in Databricks workspace using SCIM v2 protocol. Use when you need to create a new security group with a unique display name, optionally with initial members, entitlements, and roles.
Parámetros de entrada
rolesobject[]Roles assigned to the group. Corresponds to AWS instance profile/ARN role.
groupsobject[]Parent groups this group belongs to.
membersobject[]Array of member objects to add to the group. Each object contains a 'value' field with the user or group ID.
externalIdstringExternal identifier from an identity provider for SCIM synchronization.
displayNamestringObligatorioHuman-readable group name. Must be unique within the workspace.
entitlementsobject[]Permissions/entitlements assigned to the group (e.g., workspace-access, allow-cluster-create, databricks-sql-access).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete IAM Group V2DATABRICKS_IAM_GROUPS_V2_DELETEAcciónTool to delete a group from Databricks workspace using SCIM v2 protocol. Use when you need to permanently remove a security group. Requires appropriate permissions to delete the group.
DATABRICKS_IAM_GROUPS_V2_DELETEAcciónTool to delete a group from Databricks workspace using SCIM v2 protocol. Use when you need to permanently remove a security group. Requires appropriate permissions to delete the group.
Parámetros de entrada
idstringObligatorioUnique identifier of the group to delete. This is the Databricks-generated group ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace IAM Group V2DATABRICKS_IAM_GROUPS_V2_GETAcciónTool to retrieve details of a specific group by ID from Databricks workspace using SCIM v2 protocol. Use when you need to get complete group information including members, roles, entitlements, and metadata.
DATABRICKS_IAM_GROUPS_V2_GETAcciónTool to retrieve details of a specific group by ID from Databricks workspace using SCIM v2 protocol. Use when you need to get complete group information including members, roles, entitlements, and metadata.
Parámetros de entrada
idstringObligatorioUnique identifier for the group in the Databricks workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch IAM Group V2DATABRICKS_IAM_GROUPS_V2_PATCHAcciónTool to partially update a Databricks workspace group using SCIM 2.0 PATCH operations. Use when you need to modify group attributes like displayName, add/remove members, or update entitlements/roles. All operations in a single request are atomic.
DATABRICKS_IAM_GROUPS_V2_PATCHAcciónTool to partially update a Databricks workspace group using SCIM 2.0 PATCH operations. Use when you need to modify group attributes like displayName, add/remove members, or update entitlements/roles. All operations in a single request are atomic.
Parámetros de entrada
idstringObligatorioUnique ID of the group in the Databricks workspace to update
Operationsobject[]ObligatorioArray of one or more PATCH operation objects. All operations in a single PATCH request are atomic - if any operation fails, the entire request is rolled back.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update IAM Group V2DATABRICKS_IAM_GROUPS_V2_UPDATEAcciónTool to update an existing group in Databricks workspace using SCIM v2 protocol. This performs a complete replacement of the group resource. Use when you need to update group properties, members, entitlements, or roles. For partial updates, consider using PATCH instead.
DATABRICKS_IAM_GROUPS_V2_UPDATEAcciónTool to update an existing group in Databricks workspace using SCIM v2 protocol. This performs a complete replacement of the group resource. Use when you need to update group properties, members, entitlements, or roles. For partial updates, consider using PATCH instead.
Parámetros de entrada
idstringObligatorioUnique identifier of the group to update. This is the Databricks-generated group ID
rolesobject[]Roles assigned to the group. Corresponds to AWS instance profile/ARN role. This replaces the entire role list.
groupsobject[]Parent groups this group belongs to. This replaces the entire parent group list.
membersobject[]Array of member objects. This replaces the entire member list. Each object contains a 'value' field with the user or group ID.
externalIdstringExternal identifier from an identity provider for SCIM synchronization.
displayNamestringObligatorioHuman-readable group name. Must be unique within the workspace. Note: Databricks does not support updating group names after creation in some configurations.
entitlementsobject[]Permissions/entitlements assigned to the group. This replaces the entire entitlement list.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Migrate PermissionsDATABRICKS_IAM_PERMISSION_MIGRATION_MIGRATE_PERMISSIONSAcciónTool to migrate ACL permissions from workspace groups to account groups. Use when adopting Unity Catalog and migrating permissions from workspace-level groups to account-level groups. Primarily used by the Unity Catalog Migration (UCX) tool. Supports batch processing with configurable size limits.
DATABRICKS_IAM_PERMISSION_MIGRATION_MIGRATE_PERMISSIONSAcciónTool to migrate ACL permissions from workspace groups to account groups. Use when adopting Unity Catalog and migrating permissions from workspace-level groups to account-level groups. Primarily used by the Unity Catalog Migration (UCX) tool. Supports batch processing with configurable size limits.
Parámetros de entrada
sizeintegerMaximum number of permissions to migrate. Allows for batch processing by limiting the number of permissions migrated in a single request.
workspace_idintegerObligatorioWorkspace ID where the permission migration occurs. The identifier of the Databricks workspace containing the permissions to migrate.
to_account_group_namestringObligatorioName of the account group permissions migrate to. The target account-level group that will receive the migrated permissions.
from_workspace_group_namestringObligatorioName of the workspace group permissions migrate from. The source workspace-level group whose permissions will be migrated.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IAM PermissionsDATABRICKS_IAM_PERMISSIONS_GETAcciónTool to retrieve IAM permissions for a Databricks workspace object. Use when you need to check who has access to a specific resource and their permission levels. Returns the access control list (ACL) including user, group, and service principal permissions with inheritance information.
DATABRICKS_IAM_PERMISSIONS_GETAcciónTool to retrieve IAM permissions for a Databricks workspace object. Use when you need to check who has access to a specific resource and their permission levels. Returns the access control list (ACL) including user, group, and service principal permissions with inheritance information.
Parámetros de entrada
object_idstringObligatorioThe unique identifier for the specific resource instance. This is typically a 32-character string or a resource_id depending on the object type
object_typestringObligatorioThe category of workspace object. Acceptable values include: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, warehouses
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IAM Permission LevelsDATABRICKS_IAM_PERMISSIONS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks workspace object. Use when you need to understand what permission levels can be assigned to users or groups for a specific object type. Returns permission levels like CAN_READ, CAN_RUN, CAN_EDIT, CAN_MANAGE with their descriptions. Available levels vary by object type.
DATABRICKS_IAM_PERMISSIONS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks workspace object. Use when you need to understand what permission levels can be assigned to users or groups for a specific object type. Returns permission levels like CAN_READ, CAN_RUN, CAN_EDIT, CAN_MANAGE with their descriptions. Available levels vary by object type.
Parámetros de entrada
object_idstringObligatorioThe unique identifier of the workspace object. Format varies by object type (e.g., numeric for notebooks, UUID-like for warehouses and dashboards).
object_typestringObligatorioenumThe type of the workspace object. Defines the category of the object for which permission levels are being retrieved.
alertsauthorizationclusterscluster-policiesdashboardsdbsql-dashboardsdirectoriesexperimentsfilesgenieinstance-poolsjobs+7
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set IAM PermissionsDATABRICKS_IAM_PERMISSIONS_SETAcciónTool to set IAM permissions for a Databricks workspace object, replacing all existing permissions. Use when you need to configure complete access control for a resource. This operation replaces the entire access control list - existing permissions are overwritten. Admin permissions on the admins group cannot be removed.
DATABRICKS_IAM_PERMISSIONS_SETAcciónTool to set IAM permissions for a Databricks workspace object, replacing all existing permissions. Use when you need to configure complete access control for a resource. This operation replaces the entire access control list - existing permissions are overwritten. Admin permissions on the admins group cannot be removed.
Parámetros de entrada
object_idstringObligatorioThe unique identifier for the specific resource instance
object_typestringObligatorioThe type of workspace object. Valid values: alerts, authorization, clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, warehouses
access_control_listobject[]ObligatorioArray of access control entries. This replaces ALL existing permissions on the object. Each entry must specify exactly one of user_name, group_name, or service_principal_name. If empty, deletes all direct permissions on the object
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update IAM PermissionsDATABRICKS_IAM_PERMISSIONS_UPDATEAcciónTool to incrementally update permissions on Databricks workspace objects including dashboards, jobs, clusters, warehouses, notebooks, and more. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
DATABRICKS_IAM_PERMISSIONS_UPDATEAcciónTool to incrementally update permissions on Databricks workspace objects including dashboards, jobs, clusters, warehouses, notebooks, and more. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
Parámetros de entrada
object_idstringObligatorioUnique identifier of the workspace object. For dashboards, this is a 32-character resource identifier. For other objects like warehouses, jobs, or clusters, use their respective unique identifiers
object_typestringObligatorioType of the workspace object to update permissions for. Examples: 'dashboards', 'jobs', 'clusters', 'notebooks', 'warehouses', 'pipelines', 'serving-endpoints', 'cluster-policies', 'instance-pools', 'registered-models', 'repos', 'experiments', 'sql/alerts', 'sql/dashboards', 'sql/queries', 'sql/warehouses'
access_control_listobject[]ObligatorioList of access control entries to update. This operation updates permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create IAM Service Principal V2DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_CREATEAcciónTool to create a new service principal in Databricks workspace using SCIM v2 protocol. Use when you need to create a service principal that already exists in the Databricks account. Required for identity-federated workspaces where you must specify a valid UUID applicationId.
DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_CREATEAcciónTool to create a new service principal in Databricks workspace using SCIM v2 protocol. Use when you need to create a service principal that already exists in the Databricks account. Required for identity-federated workspaces where you must specify a valid UUID applicationId.
Parámetros de entrada
rolesobject[]Roles assigned to the service principal for role-based access control.
activebooleanActivation status of the service principal. Defaults to true if not specified.
groupsobject[]Group memberships for the service principal. Used for assigning the service principal to specific groups.
externalIdstringAn identifier from an external system for correlation with identity providers.
displayNamestringUser-friendly display name for the service principal. May be auto-generated if not provided in some configurations.
entitlementsobject[]Workspace entitlements and permissions assigned to the service principal (e.g., allow-cluster-create, can-manage, workspace-access, databricks-sql-access).
applicationIdstringObligatorioThe unique UUID identifier for the service principal (also known as Client ID). The service principal must already exist in the Databricks account before it can be created in a workspace. Required for identity-federated workspaces.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete IAM Service Principal V2DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_DELETEAcciónTool to delete a service principal from Databricks workspace using SCIM v2 protocol. Use when you need to permanently remove a service principal and revoke its access to the workspace. The operation is idempotent - subsequent DELETE requests to the same ID will return 404 Not Found.
DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_DELETEAcciónTool to delete a service principal from Databricks workspace using SCIM v2 protocol. Use when you need to permanently remove a service principal and revoke its access to the workspace. The operation is idempotent - subsequent DELETE requests to the same ID will return 404 Not Found.
Parámetros de entrada
idstringObligatorioUnique identifier for the service principal in the Databricks workspace. This is the service principal's application ID (also referred to as the SCIM ID or canonical unique identifier)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IAM Service Principal V2DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_GETAcciónTool to retrieve details of a specific service principal by ID from Databricks workspace using SCIM v2 protocol. Use when you need to get complete service principal information including groups, roles, entitlements, and metadata.
DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_GETAcciónTool to retrieve details of a specific service principal by ID from Databricks workspace using SCIM v2 protocol. Use when you need to get complete service principal information including groups, roles, entitlements, and metadata.
Parámetros de entrada
idstringObligatorioUnique identifier for the service principal in the Databricks workspace
attributesstringComma-separated list of attribute names to return in the response
excludedAttributesstringComma-separated list of attribute names to exclude from the response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch IAM Service Principal V2DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_PATCHAcciónTool to partially update a service principal using SCIM 2.0 PATCH operations. Use when you need to modify service principal attributes like active status, displayName, groups, entitlements, or roles without replacing the entire resource. All operations in a single request are atomic.
DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_PATCHAcciónTool to partially update a service principal using SCIM 2.0 PATCH operations. Use when you need to modify service principal attributes like active status, displayName, groups, entitlements, or roles without replacing the entire resource. All operations in a single request are atomic.
Parámetros de entrada
idstringObligatorioUnique identifier for the service principal in the Databricks workspace to update
Operationsobject[]ObligatorioArray of one or more PATCH operation objects. All operations in a single PATCH request are atomic - if any operation fails, the entire request is rolled back. Common operations include activating/deactivating service principals, updating display names, managing group memberships, adding/removing entitlements, and managing roles.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update IAM Service Principal V2DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_UPDATEAcciónTool to update an existing service principal in Databricks workspace using SCIM v2 protocol. This performs a complete replacement of the service principal resource (PUT operation). Use when you need to update service principal properties, group memberships, entitlements, or roles. Note: applicationId and id are immutable fields.
DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_UPDATEAcciónTool to update an existing service principal in Databricks workspace using SCIM v2 protocol. This performs a complete replacement of the service principal resource (PUT operation). Use when you need to update service principal properties, group memberships, entitlements, or roles. Note: applicationId and id are immutable fields.
Parámetros de entrada
idstringObligatorioThe unique identifier of the service principal to update. This is the Databricks workspace-level ID, not the applicationId.
rolesobject[]Roles assigned to the service principal for role-based access control. This replaces the entire role list.
activebooleanActivation status of the service principal. Set to false to deactivate without deleting.
groupsobject[]Group memberships for the service principal. This replaces the entire group membership list.
externalIdstringExternal identifier from an identity provider for SCIM synchronization.
displayNamestringObligatorioUser-friendly display name for the service principal. Note: For Azure AD-managed service principals, this field may be read-only.
entitlementsobject[]Workspace entitlements and permissions assigned to the service principal. This replaces the entire entitlement list.
applicationIdstringObligatorioThe unique UUID identifier for the service principal (also known as Client ID). This field is immutable and cannot be changed after creation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create IAM User V2DATABRICKS_IAM_USERS_V2_CREATEAcciónTool to create a new user in Databricks workspace using SCIM v2 protocol. Use when you need to provision a new user account with a unique userName (email), optionally with display name, activation status, group memberships, entitlements, and roles.
DATABRICKS_IAM_USERS_V2_CREATEAcciónTool to create a new user in Databricks workspace using SCIM v2 protocol. Use when you need to provision a new user account with a unique userName (email), optionally with display name, activation status, group memberships, entitlements, and roles.
Parámetros de entrada
nameobjectSCIM name object for user names.
rolesobject[]Array of roles to assign to the user
activebooleanAccount activation status (default: true)
emailsobject[]Array of email objects for the user
groupsobject[]Array of group IDs to assign the user to
userNamestringObligatorioUnique identifier for the user account, typically the user's email address
externalIdstringExternal system reference identifier (reserved for future use)
displayNamestringString representing concatenation of given and family names
entitlementsobject[]Array of entitlements to assign to the user
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete IAM User V2DATABRICKS_IAM_USERS_V2_DELETEAcciónTool to delete a user from Databricks workspace using SCIM v2 protocol. Use when you need to inactivate a user and revoke their access to the workspace. Note that users are automatically purged 30 days after deletion if they do not own or belong to any workspace. Applications or scripts using tokens generated by the deleted user will no longer be able to access Databricks APIs.
DATABRICKS_IAM_USERS_V2_DELETEAcciónTool to delete a user from Databricks workspace using SCIM v2 protocol. Use when you need to inactivate a user and revoke their access to the workspace. Note that users are automatically purged 30 days after deletion if they do not own or belong to any workspace. Applications or scripts using tokens generated by the deleted user will no longer be able to access Databricks APIs.
Parámetros de entrada
idstringObligatorioUnique identifier for the user in the Databricks workspace. This is the user's Databricks ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IAM User V2DATABRICKS_IAM_USERS_V2_GETAcciónTool to retrieve detailed information for a specific user by ID from Databricks workspace using SCIM v2 protocol. Use when you need to get complete user information including name, email, groups, roles, entitlements, and metadata.
DATABRICKS_IAM_USERS_V2_GETAcciónTool to retrieve detailed information for a specific user by ID from Databricks workspace using SCIM v2 protocol. Use when you need to get complete user information including name, email, groups, roles, entitlements, and metadata.
Parámetros de entrada
idstringObligatorioUnique identifier for a user in the Databricks workspace
attributesstringComma-separated list of attribute names to return in the response. If specified, only the requested attributes are returned.
excludedAttributesstringComma-separated list of attribute names to exclude from the response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IAM Users V2 PermissionsDATABRICKS_IAM_USERS_V2_GET_PERMISSIONSAcciónTool to retrieve permissions for password-based authentication. Use when you need to check who has access to password authentication and their permission levels. Note: Password authentication was deprecated July 10, 2024 and is no longer supported.
DATABRICKS_IAM_USERS_V2_GET_PERMISSIONSAcciónTool to retrieve permissions for password-based authentication. Use when you need to check who has access to password authentication and their permission levels. Note: Password authentication was deprecated July 10, 2024 and is no longer supported.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch IAM User V2DATABRICKS_IAM_USERS_V2_PATCHAcciónTool to partially update a user using SCIM 2.0 PATCH operations. Use when you need to modify user attributes like active status, displayName, userName, name fields, emails, groups, entitlements, or roles without replacing the entire resource. All operations in a single request are atomic.
DATABRICKS_IAM_USERS_V2_PATCHAcciónTool to partially update a user using SCIM 2.0 PATCH operations. Use when you need to modify user attributes like active status, displayName, userName, name fields, emails, groups, entitlements, or roles without replacing the entire resource. All operations in a single request are atomic.
Parámetros de entrada
idstringObligatorioUnique identifier for the user in the Databricks workspace to update
Operationsobject[]ObligatorioArray of one or more PATCH operation objects. All operations in a single PATCH request are atomic - if any operation fails, the entire request is rolled back. Common operations include activating/deactivating users, updating display names or userNames, managing group memberships, adding/removing entitlements, and managing roles.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update IAM User V2DATABRICKS_IAM_USERS_V2_UPDATEAcciónTool to update a user in Databricks workspace using SCIM v2 protocol. This performs a complete replacement of the user resource. Use when you need to update user properties including userName, displayName, active status, groups, entitlements, or roles.
DATABRICKS_IAM_USERS_V2_UPDATEAcciónTool to update a user in Databricks workspace using SCIM v2 protocol. This performs a complete replacement of the user resource. Use when you need to update user properties including userName, displayName, active status, groups, entitlements, or roles.
Parámetros de entrada
idstringObligatorioDatabricks user ID to update
nameobjectSCIM name object for user names.
rolesobject[]Array of roles to assign to the user. This replaces the entire role list.
activebooleanAccount activation status (true = active, false = inactive)
emailsobject[]Array of email objects for the user
groupsobject[]Array of group IDs to assign the user to. This replaces the entire group list.
userNamestringObligatorioUnique identifier for the user account, typically the user's email address. This field is required for complete replacement updates.
externalIdstringExternal system reference identifier (reserved for future use)
displayNamestringString representing concatenation of given and family names
entitlementsobject[]Array of entitlements to assign to the user. This replaces the entire entitlement list.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace Access Detail LocalDATABRICKS_IAMV2_WORKSPACE_IAM_V2_GET_WORKSPACE_ACCESS_DETAIL_LOCALAcciónTool to retrieve detailed workspace access information for a specific identity in Databricks. Use when you need to check workspace access details including permissions, principal information, and access metadata.
DATABRICKS_IAMV2_WORKSPACE_IAM_V2_GET_WORKSPACE_ACCESS_DETAIL_LOCALAcciónTool to retrieve detailed workspace access information for a specific identity in Databricks. Use when you need to check workspace access details including permissions, principal information, and access metadata.
Parámetros de entrada
idstringObligatorioThe unique identifier of the workspace access detail to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Job Compliance for PolicyDATABRICKS_JOB_COMPLIANCE_LISTCOMPLIANCEAcciónTool to retrieve policy compliance status of all jobs using a given cluster policy. Use when you need to identify jobs that are out of compliance because the policy was updated after the job was last edited. Jobs are non-compliant when their job clusters no longer meet the requirements of the updated policy.
DATABRICKS_JOB_COMPLIANCE_LISTCOMPLIANCEAcciónTool to retrieve policy compliance status of all jobs using a given cluster policy. Use when you need to identify jobs that are out of compliance because the policy was updated after the job was last edited. Jobs are non-compliant when their job clusters no longer meet the requirements of the updated policy.
Parámetros de entrada
page_sizeintegerNumber of results to return per page. If not specified, the default page size is used.
policy_idstringObligatorioThe cluster policy identifier to check compliance against. This field is required.
page_tokenstringToken for pagination to retrieve next page of results. Use the next_page_token from the previous response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Job Permission LevelsDATABRICKS_JOB_PERMISSION_LEVELS_GETPERMISSIONLEVELSAcciónTool to retrieve available permission levels for a Databricks job. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific job. Returns permission levels like CAN_VIEW, CAN_MANAGE_RUN, and CAN_MANAGE with their descriptions.
DATABRICKS_JOB_PERMISSION_LEVELS_GETPERMISSIONLEVELSAcciónTool to retrieve available permission levels for a Databricks job. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific job. Returns permission levels like CAN_VIEW, CAN_MANAGE_RUN, and CAN_MANAGE with their descriptions.
Parámetros de entrada
job_idstringObligatorioThe unique identifier of the job for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Job PermissionsDATABRICKS_JOB_PERMISSIONS_UPDATEPERMISSIONSAcciónTool to incrementally update permissions for a Databricks job. Use when you need to modify specific job permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
DATABRICKS_JOB_PERMISSIONS_UPDATEPERMISSIONSAcciónTool to incrementally update permissions for a Databricks job. Use when you need to modify specific job permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
Parámetros de entrada
job_idstringObligatorioThe unique identifier of the job whose permissions are being updated
access_control_listobject[]ObligatorioList of access control entries to update. This operation updates only the specified permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Job Run By IDDATABRICKS_JOB_RUN_BY_IDAcciónTool to retrieve metadata of a single Databricks job run by ID. Use when you need to get detailed information about a specific job run including state, timing, and cluster configuration. Runs are automatically removed after 60 days.
DATABRICKS_JOB_RUN_BY_IDAcciónTool to retrieve metadata of a single Databricks job run by ID. Use when you need to get detailed information about a specific job run including state, timing, and cluster configuration. Runs are automatically removed after 60 days.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier of the run for which to retrieve the metadata. This field is required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Databricks Job RunsDATABRICKS_JOB_RUNS_LISTRUNSAcciónTool to list Databricks job runs in descending order by start time. Use when you need to retrieve a paginated list of job runs with optional filtering by job ID, run status, time range, and other criteria. Supports pagination via offset/limit or page_token. All runs are automatically removed after 60 days.
DATABRICKS_JOB_RUNS_LISTRUNSAcciónTool to list Databricks job runs in descending order by start time. Use when you need to retrieve a paginated list of job runs with optional filtering by job ID, run status, time range, and other criteria. Supports pagination via offset/limit or page_token. All runs are automatically removed after 60 days.
Parámetros de entrada
limitintegerMaximum number of results per page. Default is 25.
job_idintegerFilter runs by specific job ID. If omitted, lists runs from all jobs.
offsetintegerPagination offset for result set. Use this to skip the first N results.
run_typestringFilter by run type (e.g., JOB_RUN, WORKFLOW_RUN, SUBMIT_RUN).
page_tokenstringToken for pagination to fetch next/previous page. Use the token from the previous response.
active_onlybooleanIf true, return only active (currently running) runs. Cannot be used with completed_only.
expand_tasksbooleanIf true, include detailed task information in the response.
start_time_tointegerFilter runs until this timestamp (epoch milliseconds).
completed_onlybooleanIf true, return only completed runs. Cannot be used with active_only.
start_time_fromintegerFilter runs starting from this timestamp (epoch milliseconds).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Cancel All Databricks Job RunsDATABRICKS_JOBS_JOBS_CANCEL_ALL_RUNSAcciónTool to cancel all active runs of a Databricks job asynchronously. Use when you need to terminate all running instances of a job. The cancellation happens asynchronously without preventing new runs. When all_queued_runs=true without a job_id, it cancels all queued runs across the workspace.
DATABRICKS_JOBS_JOBS_CANCEL_ALL_RUNSAcciónTool to cancel all active runs of a Databricks job asynchronously. Use when you need to terminate all running instances of a job. The cancellation happens asynchronously without preventing new runs. When all_queued_runs=true without a job_id, it cancels all queued runs across the workspace.
Parámetros de entrada
job_idintegerThe canonical identifier of the job to cancel all runs of. If provided, only runs of this job will be cancelled. If omitted along with all_queued_runs, the operation will have no effect.
all_queued_runsbooleanOptional boolean parameter to cancel all queued runs. If true and no job_id is provided, all queued runs in the entire workspace are canceled. Use with caution.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Cancel Databricks Job RunDATABRICKS_JOBS_JOBS_CANCEL_RUNAcciónTool to cancel a Databricks job run asynchronously. Use when you need to terminate a running job. The run will be terminated shortly after the request completes. If the run is already in a terminal state, this is a no-op.
DATABRICKS_JOBS_JOBS_CANCEL_RUNAcciónTool to cancel a Databricks job run asynchronously. Use when you need to terminate a running job. The run will be terminated shortly after the request completes. If the run is already in a terminal state, this is a no-op.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier of the run to cancel. This field is required to specify which job run should be cancelled. The cancellation happens asynchronously.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Databricks Job RunDATABRICKS_JOBS_JOBS_DELETE_RUNAcciónTool to delete a non-active Databricks job run. Use when you need to remove a job run from the workspace. The run must be in a non-active state; attempting to delete an active run will return an error. Runs are automatically removed after 60 days.
DATABRICKS_JOBS_JOBS_DELETE_RUNAcciónTool to delete a non-active Databricks job run. Use when you need to remove a job run from the workspace. The run must be in a non-active state; attempting to delete an active run will return an error. Runs are automatically removed after 60 days.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier of the run to delete. This is the ID of the non-active job run that should be deleted. Note that runs are automatically removed after 60 days.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks Job DetailsDATABRICKS_JOBS_JOBS_GETAcciónTool to retrieve detailed information about a single Databricks job. Use when you need to get comprehensive job configuration including tasks, schedules, notifications, and cluster settings. For jobs with more than 100 tasks or job clusters, use the page_token parameter to paginate through results.
DATABRICKS_JOBS_JOBS_GETAcciónTool to retrieve detailed information about a single Databricks job. Use when you need to get comprehensive job configuration including tasks, schedules, notifications, and cluster settings. For jobs with more than 100 tasks or job clusters, use the page_token parameter to paginate through results.
Parámetros de entrada
job_idintegerObligatorioThe canonical identifier of the job to retrieve information about. This field is required.
page_tokenstringToken for pagination. Use the next_page_token value returned from a previous request to retrieve the next page of results. Required when the tasks or job_clusters arrays exceed 100 elements.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Job Permission LevelsDATABRICKS_JOBS_JOBS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks job. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific job. Returns permission levels like CAN_VIEW, CAN_MANAGE_RUN, CAN_MANAGE, and IS_OWNER with their descriptions.
DATABRICKS_JOBS_JOBS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks job. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific job. Returns permission levels like CAN_VIEW, CAN_MANAGE_RUN, CAN_MANAGE, and IS_OWNER with their descriptions.
Parámetros de entrada
job_idstringObligatorioThe unique identifier of the job for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks Job Run DetailsDATABRICKS_JOBS_JOBS_GET_RUNAcciónTool to retrieve complete metadata for a single Databricks job run. Use when you need to get detailed information about a specific job run including its state, timing, cluster configuration, and task details. Note that runs are automatically removed after 60 days. This endpoint does not return the run's output; use the getRunOutput method separately to retrieve output.
DATABRICKS_JOBS_JOBS_GET_RUNAcciónTool to retrieve complete metadata for a single Databricks job run. Use when you need to get detailed information about a specific job run including its state, timing, cluster configuration, and task details. Note that runs are automatically removed after 60 days. This endpoint does not return the run's output; use the getRunOutput method separately to retrieve output.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier of the run for which to retrieve the metadata. This field is required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks Job Run OutputDATABRICKS_JOBS_JOBS_GET_RUN_OUTPUTAcciónTool to retrieve output and metadata of a single Databricks task run. Use when you need to get the output value from dbutils.notebook.exit() or check task execution results. IMPORTANT: This only works on task-level run IDs, not top-level job run IDs for multi-task jobs. API returns first 5 MB of output; for larger results use cloud storage. Runs are auto-removed after 60 days.
DATABRICKS_JOBS_JOBS_GET_RUN_OUTPUTAcciónTool to retrieve output and metadata of a single Databricks task run. Use when you need to get the output value from dbutils.notebook.exit() or check task execution results. IMPORTANT: This only works on task-level run IDs, not top-level job run IDs for multi-task jobs. API returns first 5 MB of output; for larger results use cloud storage. Runs are auto-removed after 60 days.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier for the run. For jobs with multiple tasks, this must be the run_id of a task run (not the top-level job run ID).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Databricks Job PermissionsDATABRICKS_JOBS_JOBS_SET_PERMISSIONSAcciónTool to set permissions for a Databricks job, completely replacing all existing permissions. Use when you need to configure access control for a job. This operation replaces ALL existing permissions; if no access_control_list is provided, all direct permissions are deleted. The job must have exactly one owner (cannot be a group).
DATABRICKS_JOBS_JOBS_SET_PERMISSIONSAcciónTool to set permissions for a Databricks job, completely replacing all existing permissions. Use when you need to configure access control for a job. This operation replaces ALL existing permissions; if no access_control_list is provided, all direct permissions are deleted. The job must have exactly one owner (cannot be a group).
Parámetros de entrada
job_idstringObligatorioThe unique identifier of the job for which to set permissions
access_control_listobject[]Array of access control entries. This replaces ALL existing permissions. If empty or not specified, all direct permissions are deleted. For each entry, only one of user_name, group_name, or service_principal_name should be specified. The job must have exactly one owner
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Submit Databricks Job RunDATABRICKS_JOBS_JOBS_SUBMITAcciónTool to submit a one-time Databricks job run without creating a persistent job. Use when you need to execute a workload directly without defining a reusable job. The job run is submitted immediately and executes the specified tasks. You can track the run using the returned run_id with the jobs/runs/get endpoint.
DATABRICKS_JOBS_JOBS_SUBMITAcciónTool to submit a one-time Databricks job run without creating a persistent job. Use when you need to execute a workload directly without defining a reusable job. The job run is submitted immediately and executes the specified tasks. You can track the run using the returned run_id with the jobs/runs/get endpoint.
Parámetros de entrada
queueobjectQueue settings for the run.
tasksobject[]Array of tasks to execute in this run. Each task must have a unique task_key. At least one task is required
healthobjectHealth monitoring rules.
run_asobjectUser or service principal that the job runs as.
run_namestringAn optional name for the run. The default value is 'Untitled'
git_sourceobjectGit source configuration.
environmentsobject[]Task execution environment specifications
timeout_secondsintegerAn optional timeout in seconds applied to each run of the job. A value of 0 means no timeout
usage_policy_idstringUser-specified ID of the usage policy for this run
budget_policy_idstringUser-specified ID of the budget policy. If not specified, run will not be attributed to any budget policy
idempotency_tokenstringAn optional token to guarantee idempotency of job run requests. Maximum 64 characters. If a run with the provided token already exists, the request won't create a new run
access_control_listobject[]List of permissions to set on the job
email_notificationsobjectEmail notification settings.
notification_settingsobjectJob notification settings.
webhook_notificationsobjectWebhook notification settings.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Databricks JobsDATABRICKS_JOBS_LISTAcciónTool to retrieve a paginated list of all jobs in the Databricks workspace. Use when you need to discover available jobs, filter by name, or iterate through all jobs. Returns jobs in descending order by start time and supports task expansion for detailed task information.
DATABRICKS_JOBS_LISTAcciónTool to retrieve a paginated list of all jobs in the Databricks workspace. Use when you need to discover available jobs, filter by name, or iterate through all jobs. Returns jobs in descending order by start time and supports task expansion for detailed task information.
Parámetros de entrada
namestringFilter jobs by exact name match.
limitintegerMaximum number of jobs to return. Default is 25, maximum is 100.
offsetintegerThe starting position for pagination. The offset of the first result to return.
page_tokenstringToken for pagination continuation. Use the next_page_token from a previous response to retrieve the next page of results.
expand_tasksbooleanWhether to include task details in the response. If false, task information is minimal.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Job Policy ComplianceDATABRICKS_JOBS_POLICY_COMPLIANCE_FOR_JOBS_GET_COMPLIANCEAcciónTool to retrieve policy compliance status for a specific job. Use when you need to check whether a job meets the requirements of its assigned policies and identify any policy violations. Jobs could be out of compliance if a policy they use was updated after the job was last edited and some of its job clusters no longer comply with their updated policies.
DATABRICKS_JOBS_POLICY_COMPLIANCE_FOR_JOBS_GET_COMPLIANCEAcciónTool to retrieve policy compliance status for a specific job. Use when you need to check whether a job meets the requirements of its assigned policies and identify any policy violations. Jobs could be out of compliance if a policy they use was updated after the job was last edited and some of its job clusters no longer comply with their updated policies.
Parámetros de entrada
job_idintegerObligatorioThe ID of the job whose compliance status you are requesting
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Unity CatalogsDATABRICKS_LIST_CATALOGSAcciónTool to retrieve a list of all catalogs in the Unity Catalog metastore. Use when you need to discover available catalogs based on user permissions. 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.
DATABRICKS_LIST_CATALOGSAcciónTool to retrieve a list of all catalogs in the Unity Catalog metastore. Use when you need to discover available catalogs based on user permissions. 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.
Parámetros de entrada
page_tokenstringOpaque pagination token to retrieve the next page based on previous query. Obtained from the next_page_token field in the previous response.
max_resultsintegerMaximum number of catalogs to return. If not specified or negative, attempts to return all catalogs (unpaginated, being deprecated). Use 0 for server default page size, or a positive number for specific page size.
include_browsebooleanWhether to include catalogs in the response for which the principal can only access selective metadata through the BROWSE privilege. Default is false.
include_unboundbooleanWhether to include catalogs that are not bound to the current workspace. Only effective if the user has permission to update the catalog-workspace binding. Default is false.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ClustersDATABRICKS_LIST_CLUSTERSAcciónTool to list all pinned, active, and recently terminated Databricks clusters. Use when you need to retrieve cluster information, monitor cluster status, or get an overview of available compute resources. Returns clusters terminated within the last 30 days along with currently active clusters. Supports filtering by state, source, and policy, with pagination for large result sets.
DATABRICKS_LIST_CLUSTERSAcciónTool to list all pinned, active, and recently terminated Databricks clusters. Use when you need to retrieve cluster information, monitor cluster status, or get an overview of available compute resources. Returns clusters terminated within the last 30 days along with currently active clusters. Supports filtering by state, source, and policy, with pagination for large result sets.
Parámetros de entrada
sort_byobjectSorting criteria for cluster listing.
filter_byobjectFilter criteria for cluster listing.
page_sizeintegerMaximum number of results per page for pagination
page_tokenstringToken for navigating to next or previous pages in paginated results
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Workspace GroupsDATABRICKS_LIST_GROUPSAcciónTool to list all groups in the Databricks workspace using SCIM v2 protocol. Use when you need to retrieve all groups or search for specific groups using filters and pagination.
DATABRICKS_LIST_GROUPSAcciónTool to list all groups in the Databricks workspace using SCIM v2 protocol. Use when you need to retrieve all groups or search for specific groups using filters and pagination.
Parámetros de entrada
countintegerMaximum number of results to return per page. Negative values treated as zero
filterstringQuery parameter to filter results. Supports operators: equals (eq), contains (co), starts with (sw), not equals (ne). Logical operators 'and' and 'or' can form simple expressions. Example: 'displayName sw "eng"' filters groups whose display name starts with 'eng'
sortBystringAttribute name to sort results by. For multi-valued attributes, uses primary or first value. Complex attributes require sub-attribute notation
sortOrderstringenumSort direction, either 'ascending' or 'descending'. Defaults to ascending
ascendingdescendingattributesstringComma-separated list of attribute names to include in the response. Overrides default attribute set
startIndexintegerThe 1-based index position of the first result to return. First item is number 1. Used for pagination
excludedAttributesstringComma-separated list of attribute names to exclude from the response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Instance PoolsDATABRICKS_LIST_INSTANCE_POOLSAcciónTool to retrieve a list of all active instance pools in the Databricks workspace with their statistics and configuration. Use when you need to get an overview of all available instance pools.
DATABRICKS_LIST_INSTANCE_POOLSAcciónTool to retrieve a list of all active instance pools in the Databricks workspace with their statistics and configuration. Use when you need to get an overview of all available instance pools.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Databricks Jobs (API 2.0)DATABRICKS_LIST_JOBSAcciónTool to list all jobs in the Databricks workspace using API 2.0. Use when you need to retrieve all jobs without pagination. Note: API 2.0 does not support pagination or filtering. For pagination support, use the API 2.2 endpoint instead.
DATABRICKS_LIST_JOBSAcciónTool to list all jobs in the Databricks workspace using API 2.0. Use when you need to retrieve all jobs without pagination. Note: API 2.0 does not support pagination or filtering. For pagination support, use the API 2.2 endpoint instead.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Members of a Security GroupDATABRICKS_LIST_MEMBERS_OF_A_SECURITY_GROUPAcciónTool to retrieve all members (users and nested groups) of a Databricks security group. Use when you need to see who belongs to a specific group for access control auditing or management. This method is non-recursive and does not expand nested group memberships.
DATABRICKS_LIST_MEMBERS_OF_A_SECURITY_GROUPAcciónTool to retrieve all members (users and nested groups) of a Databricks security group. Use when you need to see who belongs to a specific group for access control auditing or management. This method is non-recursive and does not expand nested group memberships.
Parámetros de entrada
group_namestringObligatorioThe name of the group whose members you want to list. Administrator privileges are required to invoke this operation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Model Serving EndpointsDATABRICKS_LIST_MODEL_SERVING_ENDPOINTSAcciónTool to retrieve all serving endpoints for model serving in the workspace. Use when you need to list all available model serving endpoints and their configurations. Returns information about each endpoint including its state, configuration, served models, and traffic routing.
DATABRICKS_LIST_MODEL_SERVING_ENDPOINTSAcciónTool to retrieve all serving endpoints for model serving in the workspace. Use when you need to list all available model serving endpoints and their configurations. Returns information about each endpoint including its state, configuration, served models, and traffic routing.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Node TypesDATABRICKS_LIST_NODE_TYPESAcciónTool to list all supported node types available for cluster launch in the workspace. Use when you need to determine which instance types are available for creating or configuring Databricks clusters.
DATABRICKS_LIST_NODE_TYPESAcciónTool to list all supported node types available for cluster launch in the workspace. Use when you need to determine which instance types are available for creating or configuring Databricks clusters.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Delta Live Tables PipelinesDATABRICKS_LIST_PIPELINESAcciónTool to list Delta Live Tables pipelines in the workspace. Use when you need to retrieve a paginated list of pipelines with summary information. The pipeline specification field is not returned by this endpoint - only summary information is provided. For complete pipeline details, use the get pipeline endpoint.
DATABRICKS_LIST_PIPELINESAcciónTool to list Delta Live Tables pipelines in the workspace. Use when you need to retrieve a paginated list of pipelines with summary information. The pipeline specification field is not returned by this endpoint - only summary information is provided. For complete pipeline details, use the get pipeline endpoint.
Parámetros de entrada
filterstringNarrows results based on criteria using SQL-like syntax. Supports filtering by notebook path or name patterns with wildcards. Composite filters are unsupported.
order_bystring[]Ordering specification for results. Supported fields are 'id' and 'name'. Default ordering is 'id asc'.
page_tokenstringOpaque pagination token from a previous call to fetch the next page of results. Cannot be used together with filter parameter.
max_resultsintegerMaximum number of pipelines to return per page. Default is 25; maximum allowed value is 100. An error occurs if exceeded.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ReposDATABRICKS_LIST_REPOSAcciónTool to list Git repos that the calling user has Manage permissions on. Use when you need to retrieve all available repos in the workspace. Supports pagination and filtering by path prefix.
DATABRICKS_LIST_REPOSAcciónTool to list Git repos that the calling user has Manage permissions on. Use when you need to retrieve all available repos in the workspace. Supports pagination and filtering by path prefix.
Parámetros de entrada
path_prefixstringFilters repos that have paths starting with the given path prefix. If not provided or when provided an effectively empty prefix (/ or /Workspace), Git folders (repos) from /Workspace/Repos will be served.
next_page_tokenstringToken used to get the next page of results. If not specified, returns the first page of results as well as a next page token if there are more results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Databricks Job RunsDATABRICKS_LIST_RUNSAcciónTool to list Databricks job runs in descending order by start time. Use when you need to retrieve job runs with optional filtering by job ID, run status, and type. Supports pagination via offset and limit parameters. Runs are automatically removed after 60 days.
DATABRICKS_LIST_RUNSAcciónTool to list Databricks job runs in descending order by start time. Use when you need to retrieve job runs with optional filtering by job ID, run status, and type. Supports pagination via offset and limit parameters. Runs are automatically removed after 60 days.
Parámetros de entrada
limitintegerThe number of runs to return. This value should be greater than 0 and less than 1000. The default value is 20. If 0 is specified, uses maximum limit.
job_idintegerThe job for which to list runs. If omitted, the Jobs service will list runs from all jobs.
offsetintegerThe offset of the first run to return, relative to the most recent run. Used for pagination.
run_typestringThe type of runs to return (e.g., JOB_RUN, WORKFLOW_RUN, SUBMIT_RUN).
active_onlybooleanIf true, only active runs are included in the results (PENDING, RUNNING, TERMINATING states); otherwise, lists both active and completed runs. Cannot be true when completed_only is true.
completed_onlybooleanIf true, only completed runs are included in the results. Cannot be true when active_only is true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Catalog SchemasDATABRICKS_LIST_SCHEMASAcciónTool to retrieve all schemas in a specified catalog from Unity Catalog. Use when you need to discover available schemas within a catalog based on user permissions. If the caller is the metastore admin or owner of the parent catalog, all schemas will be retrieved. Otherwise, only schemas owned by the caller or for which the caller has the USE_SCHEMA privilege will be retrieved.
DATABRICKS_LIST_SCHEMASAcciónTool to retrieve all schemas in a specified catalog from Unity Catalog. Use when you need to discover available schemas within a catalog based on user permissions. If the caller is the metastore admin or owner of the parent catalog, all schemas will be retrieved. Otherwise, only schemas owned by the caller or for which the caller has the USE_SCHEMA privilege will be retrieved.
Parámetros de entrada
page_tokenstringOpaque pagination token to retrieve the next page based on previous query. Obtained from the next_page_token field in the previous response.
max_resultsintegerMaximum number of schemas to return. If not specified, all schemas are returned. Use 0 for server default page size (recommended for pagination), positive number for specific page size. Negative values return an error.
catalog_namestringObligatorioParent catalog for schemas of interest. The name of the catalog to list schemas from.
include_browsebooleanWhether to include schemas in the response for which the principal can only access selective metadata through the BROWSE privilege. When enabled, schemas where the user has limited metadata access will be included in results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SecretsDATABRICKS_LIST_SECRETSAcciónTool to list all secret keys stored in a Databricks secret scope. Use when you need to retrieve metadata about secrets in a scope (does not return secret values). Requires READ permission on the scope.
DATABRICKS_LIST_SECRETSAcciónTool to list all secret keys stored in a Databricks secret scope. Use when you need to retrieve metadata about secrets in a scope (does not return secret values). Requires READ permission on the scope.
Parámetros de entrada
scopestringObligatorioThe name of the scope to list secrets within
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Secret ScopesDATABRICKS_LIST_SECRET_SCOPESAcciónTool to list all secret scopes available in the Databricks workspace. Use when you need to retrieve all secret scopes including their names, backend types (DATABRICKS or AZURE_KEYVAULT), and Key Vault metadata for Azure-backed scopes.
DATABRICKS_LIST_SECRET_SCOPESAcciónTool to list all secret scopes available in the Databricks workspace. Use when you need to retrieve all secret scopes including their names, backend types (DATABRICKS or AZURE_KEYVAULT), and Key Vault metadata for Azure-backed scopes.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Security GroupsDATABRICKS_LIST_SECURITY_GROUPSAcciónTool to list all security groups in the Databricks workspace using SCIM v2 protocol. Use when you need to retrieve all groups with their identifiers and display names for access control management.
DATABRICKS_LIST_SECURITY_GROUPSAcciónTool to list all security groups in the Databricks workspace using SCIM v2 protocol. Use when you need to retrieve all groups with their identifiers and display names for access control management.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SQL WarehousesDATABRICKS_LIST_SQL_WAREHOUSESAcciónTool to list all SQL warehouses in the Databricks workspace. Use when you need to retrieve information about available SQL compute resources for running SQL commands. Returns the full list of SQL warehouses the user has access to, including their configuration, state, and connection details.
DATABRICKS_LIST_SQL_WAREHOUSESAcciónTool to list all SQL warehouses in the Databricks workspace. Use when you need to retrieve information about available SQL compute resources for running SQL commands. Returns the full list of SQL warehouses the user has access to, including their configuration, state, and connection details.
Parámetros de entrada
page_sizeintegerThe maximum number of warehouses to return per page
page_tokenstringA page token received from a previous ListWarehouses call. Provide this to retrieve the subsequent page; otherwise the first page will be retrieved. When paginating, all other parameters provided to ListWarehouses must match the call that provided the page token
run_as_user_idintegerService Principal which will be used to fetch the list of endpoints. If not specified, SQL Gateway will use the user from the session header
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Catalog TablesDATABRICKS_LIST_TABLESAcciónTool to list all tables in a Unity Catalog schema with pagination support. Use when you need to retrieve tables from a specific catalog and schema combination. The API is paginated by default - continue reading pages using next_page_token until it's absent to ensure all results are retrieved.
DATABRICKS_LIST_TABLESAcciónTool to list all tables in a Unity Catalog schema with pagination support. Use when you need to retrieve tables from a specific catalog and schema combination. The API is paginated by default - continue reading pages using next_page_token until it's absent to ensure all results are retrieved.
Parámetros de entrada
page_tokenstringOpaque pagination token to go to the next page based on previous query. Continue reading pages until next_page_token is absent in the response
max_resultsintegerMaximum number of tables to return. If not set, all tables are returned (not recommended). When set to a value greater than 0, the page length is the minimum of this value and a server configured value; when set to 0, the page length is set to a server configured value (recommended)
schema_namestringObligatorioParent schema of tables to list
catalog_namestringObligatorioName of parent catalog for tables of interest
omit_columnsbooleanWhether to omit the columns of the table from the response
omit_usernamebooleanWhether to omit the username of the table (e.g. owner, updated_by, created_by)
include_browsebooleanWhether to include tables in the response for which the principal can only access selective metadata through the BROWSE privilege
omit_propertiesbooleanWhether to omit the properties of the table from the response
include_manifest_capabilitiesbooleanWhether to include a manifest containing table capabilities in the response. Use this to retrieve tables that support credential vending (marked HAS_DIRECT_EXTERNAL_ENGINE_READ_SUPPORT or HAS_DIRECT_EXTERNAL_ENGINE_WRITE_SUPPORT)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TokensDATABRICKS_LIST_TOKENSAcciónTool to list all valid personal access tokens (PATs) for a user-workspace pair. Use when you need to retrieve all tokens associated with the authenticated user in the current workspace. Note that each PAT is valid for only one workspace, and Databricks automatically revokes PATs that haven't been used for 90 days.
DATABRICKS_LIST_TOKENSAcciónTool to list all valid personal access tokens (PATs) for a user-workspace pair. Use when you need to retrieve all tokens associated with the authenticated user in the current workspace. Note that each PAT is valid for only one workspace, and Databricks automatically revokes PATs that haven't been used for 90 days.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List UsersDATABRICKS_LIST_USERSAcciónTool to list all users in a Databricks workspace using SCIM 2.0 protocol. Use when you need to retrieve user identities and their attributes. Supports filtering, pagination, and sorting.
DATABRICKS_LIST_USERSAcciónTool to list all users in a Databricks workspace using SCIM 2.0 protocol. Use when you need to retrieve user identities and their attributes. Supports filtering, pagination, and sorting.
Parámetros de entrada
countintegerMaximum number of user records to return per request. Databricks returns at most 100 users at a time.
filterstringSCIM-compliant filter expression to search users by specific criteria. Supports operators: eq (equals), co (contains), sw (starts with), ne (not equals). Can use logical operators 'and' and 'or'. Example: 'userName eq "user@example.com"'
sortBystringAttribute name to sort results by. Supports multi-part paths such as userName, name.givenName, and emails.
sortOrderstringenumSort direction. Valid values: 'ascending' or 'descending'.
ascendingdescendingattributesstringComma-separated list of specific attributes to include in response. Allows selective field retrieval.
startIndexintegerStarting position for paginated results using 1-based indexing. First item is number 1. Used with count parameter for pagination.
excludedAttributesstringComma-separated list of attributes to exclude from response. Inverse of attributes parameter.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Vector Search EndpointsDATABRICKS_LIST_VECTOR_SEARCH_ENDPOINTSAcciónTool to list all vector search endpoints in the Databricks workspace. Use when you need to retrieve information about vector search endpoints which represent compute resources hosting vector search indexes. Supports pagination for handling large result sets.
DATABRICKS_LIST_VECTOR_SEARCH_ENDPOINTSAcciónTool to list all vector search endpoints in the Databricks workspace. Use when you need to retrieve information about vector search endpoints which represent compute resources hosting vector search indexes. Supports pagination for handling large result sets.
Parámetros de entrada
page_tokenstringToken used for pagination to retrieve subsequent pages of results. When present in the response as next_page_token, pass it in the next request to get the next page.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Marketplace Consumer InstallationDATABRICKS_MARKETPLACE_CONSUMER_INSTALLATIONS_CREATEAcciónTool to create a marketplace consumer installation for Databricks Marketplace listings. Use when you need to install data products, datasets, notebooks, models, or other marketplace offerings into a workspace. Requires acceptance of consumer terms and the listing ID to proceed with installation.
DATABRICKS_MARKETPLACE_CONSUMER_INSTALLATIONS_CREATEAcciónTool to create a marketplace consumer installation for Databricks Marketplace listings. Use when you need to install data products, datasets, notebooks, models, or other marketplace offerings into a workspace. Requires acceptance of consumer terms and the listing ID to proceed with installation.
Parámetros de entrada
idstringObligatorioThe listing ID to install from
share_namestringThe name of the share
repo_detailobjectConfiguration for git repository installations.
catalog_namestringThe name of the catalog for installation
recipient_typestringenumType of Delta Sharing recipient
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPENaccepted_consumer_termsobjectConsumer terms acceptance details.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Marketplace Consumer InstallationDATABRICKS_MARKETPLACE_CONSUMER_INSTALLATIONS_DELETEAcciónTool to uninstall a Databricks Marketplace installation. Use when you need to remove an installed data product from your workspace. When an installation is deleted, the shared catalog is removed from the workspace. Requires CREATE CATALOG and USE PROVIDER permissions on the Unity Catalog metastore, or metastore admin role.
DATABRICKS_MARKETPLACE_CONSUMER_INSTALLATIONS_DELETEAcciónTool to uninstall a Databricks Marketplace installation. Use when you need to remove an installed data product from your workspace. When an installation is deleted, the shared catalog is removed from the workspace. Requires CREATE CATALOG and USE PROVIDER permissions on the Unity Catalog metastore, or metastore admin role.
Parámetros de entrada
listing_idstringObligatorioThe marketplace listing identifier to uninstall from
installation_idstringObligatorioThe installation identifier to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Marketplace Consumer InstallationDATABRICKS_MARKETPLACE_CONSUMER_INSTALLATIONS_UPDATEAcciónTool to update marketplace consumer installation fields and rotate tokens for marketplace listings. Use when you need to modify installation attributes or refresh access credentials. The token will be rotated if the rotate_token flag is true.
DATABRICKS_MARKETPLACE_CONSUMER_INSTALLATIONS_UPDATEAcciónTool to update marketplace consumer installation fields and rotate tokens for marketplace listings. Use when you need to modify installation attributes or refresh access credentials. The token will be rotated if the rotate_token flag is true.
Parámetros de entrada
idstringUnique installation identifier
statusstringenumInstallation state
INSTALLEDFAILEDtokensobject[]Collection of token records
repo_namestringGit repository name for repo-based installs
repo_pathstringRepository file path reference
listing_idstringObligatorioThe listing ID associated with the installation
share_namestringDelta Share name for data assets
catalog_namestringTarget catalog for installation
installed_onintegerTimestamp of installation in epoch milliseconds
listing_namestringHuman-readable listing name
rotate_tokenbooleanFlag to rotate the token during the update operation. The token will be forcibly rotated if this flag is true and the tokenInfo field is empty.
token_detailobjectDetails about access tokens.
error_messagestringError details if installation failed
recipient_typestringenumRecipient classification (Databricks or Open)
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKSDELTA_SHARING_RECIPIENT_TYPE_OPENinstallation_idstringObligatorioThe installation ID to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Batch Get Marketplace Consumer ListingsDATABRICKS_MARKETPLACE_CONSUMER_LISTINGS_BATCH_GETAcciónTool to batch get published listings from the Databricks Marketplace. Use when you need to retrieve multiple listing details in a single API call. Maximum limit of 50 listing IDs per request.
DATABRICKS_MARKETPLACE_CONSUMER_LISTINGS_BATCH_GETAcciónTool to batch get published listings from the Databricks Marketplace. Use when you need to retrieve multiple listing details in a single API call. Maximum limit of 50 listing IDs per request.
Parámetros de entrada
idsstring[]A list of listing identifiers to retrieve. Maximum of 50 IDs can be specified per request
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Marketplace Consumer ListingDATABRICKS_MARKETPLACE_CONSUMER_LISTINGS_GETAcciónTool to retrieve a published listing from Databricks Marketplace that consumer has access to. Use when you need to get detailed information about a specific marketplace listing by its ID. Requires Unity Catalog permissions to access marketplace assets.
DATABRICKS_MARKETPLACE_CONSUMER_LISTINGS_GETAcciónTool to retrieve a published listing from Databricks Marketplace that consumer has access to. Use when you need to get detailed information about a specific marketplace listing by its ID. Requires Unity Catalog permissions to access marketplace assets.
Parámetros de entrada
idstringObligatorioUnique identifier of the marketplace listing to retrieve. This is a UUID-formatted string that identifies a specific published listing
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Marketplace Consumer Personalization RequestsDATABRICKS_MARKETPLACE_CONSUMER_PERSONALIZATION_REQUESTS_GETAcciónTool to retrieve personalization requests for a specific marketplace listing. Use when you need to check the status of customization or commercial transaction requests for a listing. Each consumer can make at most one personalization request per listing.
DATABRICKS_MARKETPLACE_CONSUMER_PERSONALIZATION_REQUESTS_GETAcciónTool to retrieve personalization requests for a specific marketplace listing. Use when you need to check the status of customization or commercial transaction requests for a listing. Each consumer can make at most one personalization request per listing.
Parámetros de entrada
listing_idstringObligatorioThe unique identifier of the marketplace listing for which to retrieve personalization requests
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Batch Get Marketplace Consumer ProvidersDATABRICKS_MARKETPLACE_CONSUMER_PROVIDERS_BATCH_GETAcciónTool to batch get providers from the Databricks Marketplace with visible listings. Use when you need to retrieve multiple provider details in a single API call. Maximum limit of 50 provider IDs per request.
DATABRICKS_MARKETPLACE_CONSUMER_PROVIDERS_BATCH_GETAcciónTool to batch get providers from the Databricks Marketplace with visible listings. Use when you need to retrieve multiple provider details in a single API call. Maximum limit of 50 provider IDs per request.
Parámetros de entrada
idsstring[]A list of provider IDs to retrieve. Maximum 50 IDs can be specified per request
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Marketplace Consumer ProviderDATABRICKS_MARKETPLACE_CONSUMER_PROVIDERS_GETAcciónTool to retrieve information about a specific provider in the Databricks Marketplace with visible listings. Use when you need to get provider details including contact information, description, and metadata.
DATABRICKS_MARKETPLACE_CONSUMER_PROVIDERS_GETAcciónTool to retrieve information about a specific provider in the Databricks Marketplace with visible listings. Use when you need to get provider details including contact information, description, and metadata.
Parámetros de entrada
idstringObligatorioThe provider identifier to retrieve. This is a unique identifier for the marketplace provider
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Listing From ExchangeDATABRICKS_MARKETPLACE_PROVIDER_EXCHANGES_DELETE_LISTING_FROM_EXCHANGEAcciónTool to remove the association between a marketplace exchange and a listing. Use when you need to disassociate an exchange from a provider listing. This removes the listing from the private exchange, and it will no longer be shared with the curated set of customers in that exchange.
DATABRICKS_MARKETPLACE_PROVIDER_EXCHANGES_DELETE_LISTING_FROM_EXCHANGEAcciónTool to remove the association between a marketplace exchange and a listing. Use when you need to disassociate an exchange from a provider listing. This removes the listing from the private exchange, and it will no longer be shared with the curated set of customers in that exchange.
Parámetros de entrada
idstringObligatorioThe identifier for the exchange-listing association to remove. This ID represents the specific association between an exchange and a listing that should be disassociated
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Marketplace Provider ListingDATABRICKS_MARKETPLACE_PROVIDER_LISTINGS_CREATEAcciónTool to create a new listing in Databricks Marketplace for data providers. Use when you need to publish data products, datasets, models, or notebooks to the marketplace. Requires a listing object with summary information (name and listing_type). For free and instantly available data products, a share must be included during creation.
DATABRICKS_MARKETPLACE_PROVIDER_LISTINGS_CREATEAcciónTool to create a new listing in Databricks Marketplace for data providers. Use when you need to publish data products, datasets, models, or notebooks to the marketplace. Requires a listing object with summary information (name and listing_type). For free and instantly available data products, a share must be included during creation.
Parámetros de entrada
listingobjectObligatorioComplete listing configuration including summary, optional share, and detailed metadata
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Marketplace Provider ListingDATABRICKS_MARKETPLACE_PROVIDER_LISTINGS_GETAcciónTool to retrieve a specific marketplace provider listing by its identifier. Use when you need to get detailed information about a published or draft listing including metadata, configuration, and assets.
DATABRICKS_MARKETPLACE_PROVIDER_LISTINGS_GETAcciónTool to retrieve a specific marketplace provider listing by its identifier. Use when you need to get detailed information about a published or draft listing including metadata, configuration, and assets.
Parámetros de entrada
idstringObligatorioThe unique identifier of the listing to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Provider Analytics DashboardDATABRICKS_MARKETPLACE_PROVIDER_PROVIDER_ANALYTICS_DASHBOARDS_CREATEAcciónTool to create a provider analytics dashboard for monitoring Databricks Marketplace listing metrics. Use when you need to establish analytics tracking for listing views, requests, installs, conversion rates, and consumer information. Requires Marketplace admin role and system tables to be enabled in the metastore.
DATABRICKS_MARKETPLACE_PROVIDER_PROVIDER_ANALYTICS_DASHBOARDS_CREATEAcciónTool to create a provider analytics dashboard for monitoring Databricks Marketplace listing metrics. Use when you need to establish analytics tracking for listing views, requests, installs, conversion rates, and consumer information. Requires Marketplace admin role and system tables to be enabled in the metastore.
Parámetros de entrada
versionstringThe version of the dashboard template to use. Should equal the latest version if updating an existing dashboard
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Provider Analytics DashboardDATABRICKS_MARKETPLACE_PROVIDER_PROVIDER_ANALYTICS_DASHBOARDS_GETAcciónTool to retrieve provider analytics dashboard information for monitoring consumer usage metrics. Use when you need to access the dashboard ID to view marketplace listing performance including views, requests, installs, and conversion rates.
DATABRICKS_MARKETPLACE_PROVIDER_PROVIDER_ANALYTICS_DASHBOARDS_GETAcciónTool to retrieve provider analytics dashboard information for monitoring consumer usage metrics. Use when you need to access the dashboard ID to view marketplace listing performance including views, requests, installs, and conversion rates.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Latest Provider Analytics Dashboard VersionDATABRICKS_MARKETPLACE_PROVIDER_PROVIDER_ANALYTICS_DASHBOARDS_GET_LATEST_VERSIONAcciónTool to retrieve the latest logical version of the provider analytics dashboard template. Use when you need to get the current dashboard template version for monitoring consumer usage metrics including listing views, requests, and installs.
DATABRICKS_MARKETPLACE_PROVIDER_PROVIDER_ANALYTICS_DASHBOARDS_GET_LATEST_VERSIONAcciónTool to retrieve the latest logical version of the provider analytics dashboard template. Use when you need to get the current dashboard template version for monitoring consumer usage metrics including listing views, requests, and installs.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ML ExperimentDATABRICKS_ML_EXPERIMENTS_CREATE_EXPERIMENTAcciónTool to create a new MLflow experiment for tracking machine learning runs and models. Use when you need to organize and track ML experiments within Databricks. Returns RESOURCE_ALREADY_EXISTS error if an experiment with the same name already exists.
DATABRICKS_ML_EXPERIMENTS_CREATE_EXPERIMENTAcciónTool to create a new MLflow experiment for tracking machine learning runs and models. Use when you need to organize and track ML experiments within Databricks. Returns RESOURCE_ALREADY_EXISTS error if an experiment with the same name already exists.
Parámetros de entrada
namestringObligatorioExperiment name. This field is required and must be unique within the workspace
tagsobject[]A collection of tags to set on the experiment. Maximum tag size: keys up to 250 bytes, values up to 5000 bytes. Limited to 20 tags per request
artifact_locationstringLocation where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Logged ModelDATABRICKS_ML_EXPERIMENTS_CREATE_LOGGED_MODELAcciónTool to create a new logged model in MLflow that ties together model metadata, parameters, metrics, and artifacts. Use when you need to create a LoggedModel object as part of the unified 'log + register' workflow introduced in MLflow 2.8. LoggedModel objects persist throughout a model's lifecycle and provide a centralized way to track model information.
DATABRICKS_ML_EXPERIMENTS_CREATE_LOGGED_MODELAcciónTool to create a new logged model in MLflow that ties together model metadata, parameters, metrics, and artifacts. Use when you need to create a LoggedModel object as part of the unified 'log + register' workflow introduced in MLflow 2.8. LoggedModel objects persist throughout a model's lifecycle and provide a centralized way to track model information.
Parámetros de entrada
namestringName of the model. If not specified, the backend will generate one automatically
tagsobject[]LoggedModel tags as key-value pairs. Each tag consists of a key and a value
paramsobject[]LoggedModel parameters as key-value pairs. Each parameter consists of a key and a value
model_typestringThe type of model, such as 'Agent', 'Classifier', 'LLM', or 'sklearn'. Used to search and compare related models
experiment_idstringObligatorioID of the associated experiment. This field is required
source_run_idstringRun ID of the run that created this model
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create MLflow Experiment RunDATABRICKS_ML_EXPERIMENTS_CREATE_RUNAcciónTool to create a new MLflow run within an experiment for tracking machine learning execution. Use when starting a new ML training run, experiment execution, or data pipeline that needs parameter and metric tracking. Returns the created run with a unique run_id for subsequent metric and parameter logging.
DATABRICKS_ML_EXPERIMENTS_CREATE_RUNAcciónTool to create a new MLflow run within an experiment for tracking machine learning execution. Use when starting a new ML training run, experiment execution, or data pipeline that needs parameter and metric tracking. Returns the created run with a unique run_id for subsequent metric and parameter logging.
Parámetros de entrada
tagsobject[]Additional metadata for the run as key-value pairs. Tags can be used to categorize, filter, and organize runs.
user_idstringID of the user executing the run. This field is deprecated as of MLflow 1.0 and should not be used in new implementations.
run_namestringName assigned to the run. This is a human-readable identifier for the run.
start_timeintegerUnix timestamp in milliseconds of when the run started. If not provided, the current time will be used.
experiment_idstringThe associated experiment identifier. This is the ID of the experiment under which the run will be created.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML ExperimentDATABRICKS_ML_EXPERIMENTS_DELETE_EXPERIMENTAcciónTool to delete an MLflow experiment and associated metadata, runs, metrics, params, and tags. Use when you need to remove an experiment from Databricks. If the experiment uses FileStore, artifacts associated with the experiment are also deleted.
DATABRICKS_ML_EXPERIMENTS_DELETE_EXPERIMENTAcciónTool to delete an MLflow experiment and associated metadata, runs, metrics, params, and tags. Use when you need to remove an experiment from Databricks. If the experiment uses FileStore, artifacts associated with the experiment are also deleted.
Parámetros de entrada
experiment_idstringObligatorioID of the associated experiment. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Logged ModelDATABRICKS_ML_EXPERIMENTS_DELETE_LOGGED_MODELAcciónTool to delete a logged model from MLflow tracking. Use when you need to permanently remove a LoggedModel from the tracking server. The deletion is permanent and cannot be undone. LoggedModels track a model's lifecycle across different training and evaluation runs.
DATABRICKS_ML_EXPERIMENTS_DELETE_LOGGED_MODELAcciónTool to delete a logged model from MLflow tracking. Use when you need to permanently remove a LoggedModel from the tracking server. The deletion is permanent and cannot be undone. LoggedModels track a model's lifecycle across different training and evaluation runs.
Parámetros de entrada
model_idstringObligatorioThe unique identifier of the logged model to delete. This is the model_id that is assigned when a model is logged using mlflow.<model-flavor>.log_model()
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Logged Model TagDATABRICKS_ML_EXPERIMENTS_DELETE_LOGGED_MODEL_TAGAcciónTool to delete a tag from a logged model in MLflow. Use when you need to remove metadata from a LoggedModel object. This operation is irreversible and permanently removes the tag from the logged model. Part of MLflow 3's logged model management capabilities.
DATABRICKS_ML_EXPERIMENTS_DELETE_LOGGED_MODEL_TAGAcciónTool to delete a tag from a logged model in MLflow. Use when you need to remove metadata from a LoggedModel object. This operation is irreversible and permanently removes the tag from the logged model. Part of MLflow 3's logged model management capabilities.
Parámetros de entrada
keystringObligatorioThe tag key to delete. Maximum size is 255 bytes. This operation is irreversible.
model_idstringObligatorioThe unique identifier of the logged model from which to remove the tag. This is the model_id that is assigned when a model is logged using mlflow.<model-flavor>.log_model()
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Experiment RunDATABRICKS_ML_EXPERIMENTS_DELETE_RUNAcciónTool to mark an MLflow run for deletion in ML experiments. Use when you need to remove a specific run from Databricks. This is a soft delete operation - the run is marked for deletion rather than immediately removed and can be restored unless permanently deleted.
DATABRICKS_ML_EXPERIMENTS_DELETE_RUNAcciónTool to mark an MLflow run for deletion in ML experiments. Use when you need to remove a specific run from Databricks. This is a soft delete operation - the run is marked for deletion rather than immediately removed and can be restored unless permanently deleted.
Parámetros de entrada
run_idstringObligatorioID of the run to delete. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Experiment RunsDATABRICKS_ML_EXPERIMENTS_DELETE_RUNSAcciónTool to bulk delete runs in an ML experiment created before a specified timestamp. Use when you need to clean up old experiment runs. Only runs created prior to or at the specified timestamp are deleted. The maximum number of runs that can be deleted in one operation is 10000.
DATABRICKS_ML_EXPERIMENTS_DELETE_RUNSAcciónTool to bulk delete runs in an ML experiment created before a specified timestamp. Use when you need to clean up old experiment runs. Only runs created prior to or at the specified timestamp are deleted. The maximum number of runs that can be deleted in one operation is 10000.
Parámetros de entrada
max_runsintegerA positive integer that indicates the maximum number of runs to delete. The maximum allowed value for max_runs is 10000. If not specified, max_runs defaults to 10000
experiment_idstringObligatorioThe ID of the experiment containing the runs to delete. This field is required
max_timestamp_millisintegerObligatorioThe maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to or at this timestamp are deleted. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Experiment Run TagDATABRICKS_ML_EXPERIMENTS_DELETE_TAGAcciónTool to delete a tag from an MLflow experiment run. Use when you need to remove run metadata. This operation is irreversible and permanently removes the tag from the run.
DATABRICKS_ML_EXPERIMENTS_DELETE_TAGAcciónTool to delete a tag from an MLflow experiment run. Use when you need to remove run metadata. This operation is irreversible and permanently removes the tag from the run.
Parámetros de entrada
keystringObligatorioName of the tag to delete. Maximum size is 255 bytes. This operation is irreversible.
run_idstringObligatorioID of the run that the tag was logged under. This is the unique identifier for the MLflow experiment run.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Finalize Logged ModelDATABRICKS_ML_EXPERIMENTS_FINALIZE_LOGGED_MODELAcciónTool to finalize a logged model in MLflow by updating its status to READY or FAILED. Use when custom model preparation logic is complete and you need to mark the model as ready for use or indicate that upload failed. This is part of the experimental logged models feature introduced in MLflow 2.8+.
DATABRICKS_ML_EXPERIMENTS_FINALIZE_LOGGED_MODELAcciónTool to finalize a logged model in MLflow by updating its status to READY or FAILED. Use when custom model preparation logic is complete and you need to mark the model as ready for use or indicate that upload failed. This is part of the experimental logged models feature introduced in MLflow 2.8+.
Parámetros de entrada
statusstringObligatorioenumFinal status to set on the model. Use LOGGED_MODEL_READY when model files are completely uploaded and ready for use, or LOGGED_MODEL_UPLOAD_FAILED if an error occurred during model upload
LOGGED_MODEL_READYLOGGED_MODEL_UPLOAD_FAILEDmodel_idstringObligatorioThe unique identifier of the logged model to finalize. This ID is assigned when the model is initially created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ML Experiment By NameDATABRICKS_ML_EXPERIMENTS_GET_BY_NAMEAcciónTool to retrieve MLflow experiment metadata by name. Use when you need to get experiment details using the experiment name. Returns deleted experiments but prefers active ones if both exist with the same name. Throws RESOURCE_DOES_NOT_EXIST if no matching experiment exists.
DATABRICKS_ML_EXPERIMENTS_GET_BY_NAMEAcciónTool to retrieve MLflow experiment metadata by name. Use when you need to get experiment details using the experiment name. Returns deleted experiments but prefers active ones if both exist with the same name. Throws RESOURCE_DOES_NOT_EXIST if no matching experiment exists.
Parámetros de entrada
experiment_namestringObligatorioName of the associated experiment. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ML ExperimentDATABRICKS_ML_EXPERIMENTS_GET_EXPERIMENTAcciónTool to retrieve metadata for an MLflow experiment by ID. Use when you need to get experiment details including name, artifact location, lifecycle stage, and tags. Works on both active and deleted experiments.
DATABRICKS_ML_EXPERIMENTS_GET_EXPERIMENTAcciónTool to retrieve metadata for an MLflow experiment by ID. Use when you need to get experiment details including name, artifact location, lifecycle stage, and tags. Works on both active and deleted experiments.
Parámetros de entrada
experiment_idstringObligatorioID of the associated experiment. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Logged ModelDATABRICKS_ML_EXPERIMENTS_GET_LOGGED_MODELAcciónTool to fetch logged model metadata by unique ID. Use when you need to retrieve a LoggedModel object representing a model logged to an MLflow Experiment. Returns comprehensive model information including metrics, parameters, tags, and artifact details.
DATABRICKS_ML_EXPERIMENTS_GET_LOGGED_MODELAcciónTool to fetch logged model metadata by unique ID. Use when you need to retrieve a LoggedModel object representing a model logged to an MLflow Experiment. Returns comprehensive model information including metrics, parameters, tags, and artifact details.
Parámetros de entrada
idstringObligatorioThe unique identifier (model_id) of the logged model to retrieve. Must be provided.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ML Experiment Permission LevelsDATABRICKS_ML_EXPERIMENTS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks ML experiment. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific experiment. Returns permission levels like CAN_READ, CAN_EDIT, CAN_MANAGE, and IS_OWNER with their descriptions.
DATABRICKS_ML_EXPERIMENTS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks ML experiment. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific experiment. Returns permission levels like CAN_READ, CAN_EDIT, CAN_MANAGE, and IS_OWNER with their descriptions.
Parámetros de entrada
experiment_idstringObligatorioThe numeric string identifier of the MLflow experiment
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ML Experiment PermissionsDATABRICKS_ML_EXPERIMENTS_GET_PERMISSIONSAcciónTool to retrieve permissions for an MLflow experiment. Use when you need to check who has access to an experiment and their permission levels. Note that notebook experiments inherit permissions from their corresponding notebook, while workspace experiments have independent permissions.
DATABRICKS_ML_EXPERIMENTS_GET_PERMISSIONSAcciónTool to retrieve permissions for an MLflow experiment. Use when you need to check who has access to an experiment and their permission levels. Note that notebook experiments inherit permissions from their corresponding notebook, while workspace experiments have independent permissions.
Parámetros de entrada
experiment_idstringObligatorioThe ID of the experiment for which to get permissions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get MLflow RunDATABRICKS_ML_EXPERIMENTS_GET_RUNAcciónTool to retrieve complete information about a specific MLflow run including metadata, metrics, parameters, tags, inputs, and outputs. Use when you need to get details of a run by its run_id. Returns the most recent metric values when multiple metrics with the same key exist.
DATABRICKS_ML_EXPERIMENTS_GET_RUNAcciónTool to retrieve complete information about a specific MLflow run including metadata, metrics, parameters, tags, inputs, and outputs. Use when you need to get details of a run by its run_id. Returns the most recent metric values when multiple metrics with the same key exist.
Parámetros de entrada
run_idstringObligatorioID of the run to fetch. Must be provided. Unique identifier for the run.
run_uuidstringDeprecated parameter; use run_id instead. Will be removed in future MLflow versions.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log Batch MLflow DataDATABRICKS_ML_EXPERIMENTS_LOG_BATCHAcciónTool to log a batch of metrics, parameters, and tags for an MLflow run in a single request. Use when you need to efficiently log multiple metrics, params, or tags simultaneously. Items within each type are processed sequentially in the order specified. The combined total of all items across metrics, params, and tags cannot exceed 1000.
DATABRICKS_ML_EXPERIMENTS_LOG_BATCHAcciónTool to log a batch of metrics, parameters, and tags for an MLflow run in a single request. Use when you need to efficiently log multiple metrics, params, or tags simultaneously. Items within each type are processed sequentially in the order specified. The combined total of all items across metrics, params, and tags cannot exceed 1000.
Parámetros de entrada
tagsobject[]Tags to log. Each tag includes key and value. Items are processed sequentially in order. Maximum 100 tags
paramsobject[]Parameters to log. Each param includes key and value. Items are processed sequentially in order. Maximum 100 parameters
run_idstringObligatorioID of the run to log under. This identifies the specific MLflow run for which metrics, params, and tags will be logged
metricsobject[]Metrics to log. Each metric includes key, value, timestamp, and optional step. Items are processed sequentially in order
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log MLflow Dataset InputsDATABRICKS_ML_EXPERIMENTS_LOG_INPUTSAcciónTool to log dataset inputs to an MLflow run for tracking data sources used during model development. Use when you need to track metadata about datasets used in ML experiment runs, including information about the dataset source, schema, and tags. Enables logging of dataset inputs to a run, allowing you to track data sources throughout the ML lifecycle.
DATABRICKS_ML_EXPERIMENTS_LOG_INPUTSAcciónTool to log dataset inputs to an MLflow run for tracking data sources used during model development. Use when you need to track metadata about datasets used in ML experiment runs, including information about the dataset source, schema, and tags. Enables logging of dataset inputs to a run, allowing you to track data sources throughout the ML lifecycle.
Parámetros de entrada
run_idstringObligatorioID of the run to log under. This field is required. The unique identifier for the MLflow run where dataset inputs will be logged
datasetsobject[]Collection of dataset inputs being logged to the run. Each entry contains dataset metadata and optional tags
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log Logged Model ParametersDATABRICKS_ML_EXPERIMENTS_LOG_LOGGED_MODEL_PARAMSAcciónTool to log parameters for a logged model in MLflow. Use when you need to attach hyperparameters or metadata to a LoggedModel object. A param can be logged only once for a logged model, and attempting to overwrite an existing param will result in an error. Available in MLflow 2.8+.
DATABRICKS_ML_EXPERIMENTS_LOG_LOGGED_MODEL_PARAMSAcciónTool to log parameters for a logged model in MLflow. Use when you need to attach hyperparameters or metadata to a LoggedModel object. A param can be logged only once for a logged model, and attempting to overwrite an existing param will result in an error. Available in MLflow 2.8+.
Parámetros de entrada
idstringObligatorioThe unique identifier (model_id) of the logged model to log params for. Must be provided
paramsobject[]ObligatorioParameters to attach to the logged model. Each parameter is a key-value pair where both key and value are strings
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log MLflow MetricDATABRICKS_ML_EXPERIMENTS_LOG_METRICAcciónTool to log a metric for an MLflow run with timestamp. Use when you need to record ML model performance metrics like accuracy, loss, or custom evaluation metrics. Metrics can be logged multiple times with different timestamps and values are never overwritten - each log appends to the metric history for that key.
DATABRICKS_ML_EXPERIMENTS_LOG_METRICAcciónTool to log a metric for an MLflow run with timestamp. Use when you need to record ML model performance metrics like accuracy, loss, or custom evaluation metrics. Metrics can be logged multiple times with different timestamps and values are never overwritten - each log appends to the metric history for that key.
Parámetros de entrada
keystringObligatorioName of the metric. May only contain alphanumerics, underscores (_), dashes (-), periods (.), spaces ( ), and slashes (/). Maximum length is 250 characters
stepintegerInteger training step (iteration) at which the metric was calculated
valuenumberObligatorioDouble value of the metric being logged. Note that some special values such as +/- Infinity may be replaced by other values depending on the store
run_idstringObligatorioID of the run under which to log the metric. Must be provided
timestampintegerObligatorioUnix timestamp in milliseconds at the time metric was logged. Defaults to current system time if not provided
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log MLflow ModelDATABRICKS_ML_EXPERIMENTS_LOG_MODELAcciónTool to log a model artifact for an MLflow run (Experimental API). Use when you need to record model metadata including artifact paths, flavors, and versioning information for a training run. The model_json parameter should contain a complete MLmodel specification in JSON string format.
DATABRICKS_ML_EXPERIMENTS_LOG_MODELAcciónTool to log a model artifact for an MLflow run (Experimental API). Use when you need to record model metadata including artifact paths, flavors, and versioning information for a training run. The model_json parameter should contain a complete MLmodel specification in JSON string format.
Parámetros de entrada
run_idstringObligatorioID of the run to log the model under. This field is required
model_jsonstringObligatorioMLmodel file in JSON format as a string. Contains model metadata including artifact_path, flavors, mlflow_version, model_uuid, and utc_time_created. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log MLflow Dataset OutputsDATABRICKS_ML_EXPERIMENTS_LOG_OUTPUTSAcciónTool to log dataset outputs from an MLflow run for tracking data generated during model development. Use when you need to track metadata about datasets produced by ML experiment runs, including information about predictions, model outputs, or generated data. Enables logging of dataset outputs to a run, allowing you to track generated data throughout the ML lifecycle.
DATABRICKS_ML_EXPERIMENTS_LOG_OUTPUTSAcciónTool to log dataset outputs from an MLflow run for tracking data generated during model development. Use when you need to track metadata about datasets produced by ML experiment runs, including information about predictions, model outputs, or generated data. Enables logging of dataset outputs to a run, allowing you to track generated data throughout the ML lifecycle.
Parámetros de entrada
run_idstringObligatorioID of the run to log under. This field is required. The unique identifier for the MLflow run where dataset outputs will be logged
datasetsobject[]Collection of dataset outputs being logged to the run. Each entry contains dataset metadata and optional tags
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log MLflow ParameterDATABRICKS_ML_EXPERIMENTS_LOG_PARAMAcciónTool to log a parameter for an MLflow run as a key-value pair. Use when you need to record hyperparameters or constant values for ML model training or ETL pipelines. Parameters can only be logged once per run and cannot be changed after logging. Logging identical parameters is idempotent.
DATABRICKS_ML_EXPERIMENTS_LOG_PARAMAcciónTool to log a parameter for an MLflow run as a key-value pair. Use when you need to record hyperparameters or constant values for ML model training or ETL pipelines. Parameters can only be logged once per run and cannot be changed after logging. Logging identical parameters is idempotent.
Parámetros de entrada
keystringObligatorioName of the param. Maximum size is 255 bytes. This field is required
valuestringObligatorioString value of the param being logged. Maximum size is 6000 bytes
run_idstringObligatorioID of the run under which to log the param. Must be provided
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Restore ML ExperimentDATABRICKS_ML_EXPERIMENTS_RESTORE_EXPERIMENTAcciónTool to restore a deleted MLflow experiment and its associated metadata, runs, metrics, params, and tags. Use when you need to recover a previously deleted experiment from Databricks. If the experiment uses FileStore, underlying artifacts are also restored.
DATABRICKS_ML_EXPERIMENTS_RESTORE_EXPERIMENTAcciónTool to restore a deleted MLflow experiment and its associated metadata, runs, metrics, params, and tags. Use when you need to recover a previously deleted experiment from Databricks. If the experiment uses FileStore, underlying artifacts are also restored.
Parámetros de entrada
experiment_idstringObligatorioID of the associated experiment. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Restore ML Experiment RunDATABRICKS_ML_EXPERIMENTS_RESTORE_RUNAcciónTool to restore a deleted MLflow run and its associated metadata, runs, metrics, params, and tags. Use when you need to recover a previously deleted run from Databricks ML experiments. The operation cannot restore runs that were permanently deleted.
DATABRICKS_ML_EXPERIMENTS_RESTORE_RUNAcciónTool to restore a deleted MLflow run and its associated metadata, runs, metrics, params, and tags. Use when you need to recover a previously deleted run from Databricks ML experiments. The operation cannot restore runs that were permanently deleted.
Parámetros de entrada
run_idstringObligatorioID of the run to restore. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Restore ML Experiment RunsDATABRICKS_ML_EXPERIMENTS_RESTORE_RUNSAcciónTool to bulk restore runs in an ML experiment that were deleted at or after a specified timestamp. Use when you need to recover multiple deleted experiment runs. Only runs deleted at or after the specified timestamp are restored. The maximum number of runs that can be restored in one operation is 10000.
DATABRICKS_ML_EXPERIMENTS_RESTORE_RUNSAcciónTool to bulk restore runs in an ML experiment that were deleted at or after a specified timestamp. Use when you need to recover multiple deleted experiment runs. Only runs deleted at or after the specified timestamp are restored. The maximum number of runs that can be restored in one operation is 10000.
Parámetros de entrada
max_runsintegerAn optional positive integer indicating the maximum number of runs to restore. The maximum allowed value for max_runs is 10000. If not specified, defaults to 10000
experiment_idstringObligatorioThe ID of the experiment containing the runs to restore. This field is required
min_timestamp_millisintegerObligatorioThe minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted at or after this timestamp are restored. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Logged ModelsDATABRICKS_ML_EXPERIMENTS_SEARCH_LOGGED_MODELSAcciónTool to search for logged models in MLflow experiments based on various criteria. Use when you need to find models that match specific metrics, parameters, tags, or attributes using SQL-like filter expressions. Supports pagination, ordering results, and filtering by datasets.
DATABRICKS_ML_EXPERIMENTS_SEARCH_LOGGED_MODELSAcciónTool to search for logged models in MLflow experiments based on various criteria. Use when you need to find models that match specific metrics, parameters, tags, or attributes using SQL-like filter expressions. Supports pagination, ordering results, and filtering by datasets.
Parámetros de entrada
filterstringA filter expression over logged model info and data. Supports AND'ing binary operations. Example: 'params.alpha < 0.3 AND metrics.accuracy > 0.9'. Can filter by metrics (metrics.<name>), params (params.<name>), and model attributes
datasetsobject[]List of datasets on which to apply the metrics filter clauses. When specified with a metrics filter like 'metrics.accuracy > 0.9', returns logged models meeting the criteria on the specified dataset
order_byobject[]The list of columns for ordering the results. Can order by metrics, params, or model attributes
page_tokenstringThe token indicating the page of logged models to fetch for pagination. Obtained from the next_page_token in a previous response
max_resultsintegerThe maximum number of logged models to return. The maximum limit is 50
experiment_idsstring[]The IDs of the experiments in which to search for logged models. If not specified, searches across all experiments
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set ML Experiment TagDATABRICKS_ML_EXPERIMENTS_SET_EXPERIMENT_TAGAcciónTool to set a tag on an MLflow experiment. Use when you need to add or update experiment metadata. Experiment tags are metadata that can be updated at any time.
DATABRICKS_ML_EXPERIMENTS_SET_EXPERIMENT_TAGAcciónTool to set a tag on an MLflow experiment. Use when you need to add or update experiment metadata. Experiment tags are metadata that can be updated at any time.
Parámetros de entrada
keystringObligatorioName of the tag. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 250 bytes in size.
valuestringObligatorioString value of the tag being logged. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 5000 bytes in size.
experiment_idstringObligatorioID of the experiment under which to log the tag. Must be provided. This is the unique identifier for the MLflow experiment.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Logged Model TagsDATABRICKS_ML_EXPERIMENTS_SET_LOGGED_MODEL_TAGSAcciónTool to set tags on a logged model in MLflow. Use when you need to add or update metadata tags on a LoggedModel object for organization and tracking. Tags are key-value pairs that can be used to search and filter logged models. Part of MLflow 3's logged model management capabilities.
DATABRICKS_ML_EXPERIMENTS_SET_LOGGED_MODEL_TAGSAcciónTool to set tags on a logged model in MLflow. Use when you need to add or update metadata tags on a LoggedModel object for organization and tracking. Tags are key-value pairs that can be used to search and filter logged models. Part of MLflow 3's logged model management capabilities.
Parámetros de entrada
tagsobject[]ObligatorioArray of tags to set on the logged model. Each tag consists of a key-value pair used for organizing and tracking models throughout their lifecycle
model_idstringObligatorioThe unique identifier of the logged model to set tags on. This is the model_id that is assigned when a model is logged using mlflow.<model-flavor>.log_model()
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set ML Experiment PermissionsDATABRICKS_ML_EXPERIMENTS_SET_PERMISSIONSAcciónTool to set permissions for an MLflow experiment, replacing all existing permissions. Use when you need to configure access control for an experiment. This operation replaces ALL existing permissions; for incremental updates, use the update permissions endpoint instead.
DATABRICKS_ML_EXPERIMENTS_SET_PERMISSIONSAcciónTool to set permissions for an MLflow experiment, replacing all existing permissions. Use when you need to configure access control for an experiment. This operation replaces ALL existing permissions; for incremental updates, use the update permissions endpoint instead.
Parámetros de entrada
experiment_idstringObligatorioThe ID of the MLflow experiment
access_control_listobject[]ObligatorioArray of access control entries. This replaces ALL existing permissions. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set MLflow Run TagDATABRICKS_ML_EXPERIMENTS_SET_TAGAcciónTool to set a tag on an MLflow run. Use when you need to add custom metadata to runs for filtering, searching, and organizing experiments. Tags with the same key can be overwritten by successive writes. Logging the same tag (key, value) is idempotent.
DATABRICKS_ML_EXPERIMENTS_SET_TAGAcciónTool to set a tag on an MLflow run. Use when you need to add custom metadata to runs for filtering, searching, and organizing experiments. Tags with the same key can be overwritten by successive writes. Logging the same tag (key, value) is idempotent.
Parámetros de entrada
keystringObligatorioName of the tag. Maximum size is 250 bytes. All storage backends are guaranteed to support key values up to 250 bytes in size.
valuestringObligatorioString value of the tag being logged. Maximum size is 5000 bytes. All storage backends are guaranteed to support values up to 5000 bytes in size.
run_idstringObligatorioID of the run under which to log the tag. This is the unique identifier for the MLflow run.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ML ExperimentDATABRICKS_ML_EXPERIMENTS_UPDATE_EXPERIMENTAcciónTool to update MLflow experiment metadata, primarily for renaming experiments. Use when you need to rename an existing experiment. The new experiment name must be unique across all experiments in the workspace.
DATABRICKS_ML_EXPERIMENTS_UPDATE_EXPERIMENTAcciónTool to update MLflow experiment metadata, primarily for renaming experiments. Use when you need to rename an existing experiment. The new experiment name must be unique across all experiments in the workspace.
Parámetros de entrada
new_namestringObligatorioThe experiment's name is changed to the new name. The new name must be unique across all experiments in the workspace. This field is required by Databricks
experiment_idstringObligatorioID of the associated experiment. This field is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ML Experiment PermissionsDATABRICKS_ML_EXPERIMENTS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for an MLflow experiment. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
DATABRICKS_ML_EXPERIMENTS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for an MLflow experiment. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
Parámetros de entrada
experiment_idstringObligatorioThe ID of the MLflow experiment
access_control_listobject[]ObligatorioArray of access control entries to update. This operation updates only the specified permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ML Experiment RunDATABRICKS_ML_EXPERIMENTS_UPDATE_RUNAcciónTool to update MLflow run metadata including status, end time, and run name. Use when a run's status changes outside normal execution flow or when you need to rename a run. This endpoint allows you to modify a run's metadata after it has been created.
DATABRICKS_ML_EXPERIMENTS_UPDATE_RUNAcciónTool to update MLflow run metadata including status, end time, and run name. Use when a run's status changes outside normal execution flow or when you need to rename a run. This endpoint allows you to modify a run's metadata after it has been created.
Parámetros de entrada
run_idstringObligatorioID of the run to update. Must be provided. This is the unique identifier for the run you want to update.
statusstringenumUpdated status of the run. Valid values: RUNNING (1), SCHEDULED (2), FINISHED (3), FAILED (4), KILLED (5). The RunStatus enum represents the execution state of the run.
RUNNINGSCHEDULEDFINISHEDFAILEDKILLEDend_timeintegerUnix timestamp in milliseconds of when the run ended. Represents the end time in milliseconds since the UNIX epoch.
run_namestringUpdated name of the run. Used to rename the run for better identification.
run_uuidstringDeprecated field; use run_id instead. Maintained for backwards compatibility.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Feature Engineering Kafka ConfigDATABRICKS_ML_FEATURE_ENGINEERING_DELETE_KAFKA_CONFIGAcciónTool to delete a Kafka configuration from ML Feature Engineering. Use when you need to remove Kafka streaming source configurations. The deletion is permanent and cannot be undone. Kafka configurations define how features are streamed from Kafka sources.
DATABRICKS_ML_FEATURE_ENGINEERING_DELETE_KAFKA_CONFIGAcciónTool to delete a Kafka configuration from ML Feature Engineering. Use when you need to remove Kafka streaming source configurations. The deletion is permanent and cannot be undone. Kafka configurations define how features are streamed from Kafka sources.
Parámetros de entrada
idstringObligatorioThe unique identifier of the Kafka configuration to delete. This is the configuration ID that was assigned when the Kafka config was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ML Feature Store Online StoreDATABRICKS_ML_FEATURE_STORE_CREATE_ONLINE_STOREAcciónTool to create a Databricks Online Feature Store for real-time feature serving. Use when you need to establish serverless infrastructure for low-latency access to feature data at scale. Requires Databricks Runtime 16.4 LTS ML or above, or serverless compute.
DATABRICKS_ML_FEATURE_STORE_CREATE_ONLINE_STOREAcciónTool to create a Databricks Online Feature Store for real-time feature serving. Use when you need to establish serverless infrastructure for low-latency access to feature data at scale. Requires Databricks Runtime 16.4 LTS ML or above, or serverless compute.
Parámetros de entrada
namestringObligatorioName of the online store to create. Must be unique and a valid identifier
capacitystringObligatorioenumCompute capacity units allocated to the online store. Each capacity unit allocates approximately 16GB of RAM with associated CPU and local SSD resources
CU_1CU_2CU_4CU_8read_replica_countintegerNumber of read replicas for high availability. Default is 0, maximum is 2 (contact Databricks to increase limit). Scaling to zero is not supported
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Feature Store Online StoreDATABRICKS_ML_FEATURE_STORE_DELETE_ONLINE_STOREAcciónTool to delete an online store from ML Feature Store. Use when you need to remove online stores that provide low-latency feature serving infrastructure. The deletion is permanent and cannot be undone. Online stores are used for real-time feature retrieval in production ML serving.
DATABRICKS_ML_FEATURE_STORE_DELETE_ONLINE_STOREAcciónTool to delete an online store from ML Feature Store. Use when you need to remove online stores that provide low-latency feature serving infrastructure. The deletion is permanent and cannot be undone. Online stores are used for real-time feature retrieval in production ML serving.
Parámetros de entrada
idstringObligatorioThe unique identifier of the online store to delete. This is the ID that was assigned when the online store was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Feature Store Online TableDATABRICKS_ML_FEATURE_STORE_DELETE_ONLINE_TABLEAcciónTool to delete an online table from ML Feature Store. Use when you need to permanently remove an online table and stop data synchronization. This operation deletes all data in the online table permanently and releases all resources.
DATABRICKS_ML_FEATURE_STORE_DELETE_ONLINE_TABLEAcciónTool to delete an online table from ML Feature Store. Use when you need to permanently remove an online table and stop data synchronization. This operation deletes all data in the online table permanently and releases all resources.
Parámetros de entrada
namestringObligatorioFull three-part (catalog, schema, table) name of the online table to delete from ML Feature Store. Format: 'catalog.schema.table_name'. This operation will permanently delete the online table and stop data synchronization
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ML Forecasting ExperimentDATABRICKS_ML_FORECASTING_CREATE_EXPERIMENTAcciónTool to create a new AutoML forecasting experiment for time series prediction. Use when you need to automatically train and optimize forecasting models on time series data. The experiment will train multiple models and select the best one based on the primary metric.
DATABRICKS_ML_FORECASTING_CREATE_EXPERIMENTAcciónTool to create a new AutoML forecasting experiment for time series prediction. Use when you need to automatically train and optimize forecasting models on time series data. The experiment will train multiple models and select the best one based on the primary metric.
Parámetros de entrada
datasetstringObligatorioThe name of the dataset table in the format catalog.schema.table or schema.table for use in forecasting
horizonintegerObligatorioThe number of time steps into the future to forecast. Must be a positive integer
data_dirstringDBFS path where intermediate data will be stored during the AutoML run
time_colstringObligatorioThe name of the column containing the time series timestamps
frequencystringObligatorioThe frequency of the time series data. Common values: 'D' (daily), 'W' (weekly), 'M' (monthly), 'H' (hourly), 'T' or 'min' (minutely)
target_colstringObligatorioThe name of the column containing the target values to forecast
identity_colstring[]List of column names that identify individual time series in the dataset. Use when the dataset contains multiple time series to forecast independently
primary_metricstringThe primary metric to optimize during model training. Common values: 'smape' (Symmetric Mean Absolute Percentage Error), 'mse' (Mean Squared Error), 'mae' (Mean Absolute Error), 'rmse' (Root Mean Squared Error)
experiment_namestringName for the MLflow experiment that will be created to track this AutoML run
timeout_minutesintegerMaximum time in minutes to run the AutoML forecasting experiment before timing out. If not specified, the experiment will run until completion
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ML Feature TagDATABRICKS_ML_MATERIALIZED_FEATURES_DELETE_FEATURE_TAGAcciónTool to delete a tag from a feature in a feature table in ML Feature Store. Use when you need to remove metadata tags from specific features. This operation removes the tag association from the feature but does not affect the feature data itself.
DATABRICKS_ML_MATERIALIZED_FEATURES_DELETE_FEATURE_TAGAcciónTool to delete a tag from a feature in a feature table in ML Feature Store. Use when you need to remove metadata tags from specific features. This operation removes the tag association from the feature but does not affect the feature data itself.
Parámetros de entrada
tag_namestringObligatorioThe name of the tag to delete from the feature
feature_namestringObligatorioThe name of the feature within the feature table from which to delete the tag
feature_table_idstringObligatorioThe unique identifier of the feature table. This is typically the full name of the feature table (e.g., 'samples.nyctaxi.trips')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ML Feature TagDATABRICKS_ML_MATERIALIZED_FEATURES_GET_FEATURE_TAGAcciónTool to retrieve a specific tag from a feature in a feature table in ML Feature Store. Use when you need to get metadata tag details from specific features. This operation returns the tag name and value associated with the feature.
DATABRICKS_ML_MATERIALIZED_FEATURES_GET_FEATURE_TAGAcciónTool to retrieve a specific tag from a feature in a feature table in ML Feature Store. Use when you need to get metadata tag details from specific features. This operation returns the tag name and value associated with the feature.
Parámetros de entrada
tag_namestringObligatorioThe name of the tag to retrieve from the feature
feature_namestringObligatorioThe name of the feature within the feature table from which to retrieve the tag
feature_table_idstringObligatorioThe unique identifier of the feature table. This is typically the full name of the feature table (e.g., 'samples.nyctaxi.trips')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set or Update ML Feature TagDATABRICKS_ML_MATERIALIZED_FEATURES_UPDATE_FEATURE_TAGAcciónTool to set or update a tag on a feature in a feature table in ML Feature Store. Use when you need to add or modify metadata tags on specific features. If the tag already exists, it will be updated with the new value. If the tag doesn't exist, it will be created automatically. This operation is idempotent and can be used to ensure a tag has a specific value.
DATABRICKS_ML_MATERIALIZED_FEATURES_UPDATE_FEATURE_TAGAcciónTool to set or update a tag on a feature in a feature table in ML Feature Store. Use when you need to add or modify metadata tags on specific features. If the tag already exists, it will be updated with the new value. If the tag doesn't exist, it will be created automatically. This operation is idempotent and can be used to ensure a tag has a specific value.
Parámetros de entrada
valuestringObligatorioThe new value to set for the tag
tag_namestringObligatorioThe name of the tag to update on the feature
feature_namestringObligatorioThe name of the feature within the feature table whose tag should be updated
feature_table_idstringObligatorioThe unique identifier of the feature table. This is typically the full name of the feature table (e.g., 'samples.nyctaxi.trips')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ML Model Registry Permission LevelsDATABRICKS_ML_MODEL_REGISTRY_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks ML registered model. Use when you need to understand what permission levels can be assigned to users or groups for a specific model. Returns permission levels like CAN_READ, CAN_EDIT, CAN_MANAGE, CAN_MANAGE_PRODUCTION_VERSIONS, CAN_MANAGE_STAGING_VERSIONS, and IS_OWNER with their descriptions.
DATABRICKS_ML_MODEL_REGISTRY_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks ML registered model. Use when you need to understand what permission levels can be assigned to users or groups for a specific model. Returns permission levels like CAN_READ, CAN_EDIT, CAN_MANAGE, CAN_MANAGE_PRODUCTION_VERSIONS, CAN_MANAGE_STAGING_VERSIONS, and IS_OWNER with their descriptions.
Parámetros de entrada
registered_model_idstringObligatorioThe unique identifier for the registered model. This is a string identifier that corresponds to the resource_id of the registered model in the workspace.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete OAuth2 Service Principal SecretDATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_DELETEAcciónTool to delete an OAuth secret from a service principal at the account level. Use when you need to revoke OAuth credentials for service principal authentication. Once deleted, applications or scripts using tokens generated from that secret will no longer be able to access Databricks APIs.
DATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_DELETEAcciónTool to delete an OAuth secret from a service principal at the account level. Use when you need to revoke OAuth credentials for service principal authentication. Once deleted, applications or scripts using tokens generated from that secret will no longer be able to access Databricks APIs.
Parámetros de entrada
secret_idstringObligatorioThe unique identifier of the OAuth secret to delete. Once deleted, applications using tokens generated from this secret will no longer be able to access Databricks APIs
service_principal_idstringObligatorioThe unique identifier of the service principal whose secret will be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create OAuth Service Principal SecretDATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_PROXY_CREATEAcciónTool to create an OAuth secret for service principal authentication. Use when you need to obtain OAuth access tokens for accessing Databricks Accounts and Workspace APIs. A service principal can have up to five OAuth secrets, each valid for up to two years (730 days). The secret value is only shown once upon creation.
DATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_PROXY_CREATEAcciónTool to create an OAuth secret for service principal authentication. Use when you need to obtain OAuth access tokens for accessing Databricks Accounts and Workspace APIs. A service principal can have up to five OAuth secrets, each valid for up to two years (730 days). The secret value is only shown once upon creation.
Parámetros de entrada
idstringObligatorioThe service principal ID (SCIM ID, not application ID)
lifetimestringThe lifetime of the secret in seconds, formatted as 'NNNNs' (e.g., '63072000s' for 730 days). If not provided, defaults to 730 days (63072000 seconds). Maximum allowed is 730 days
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete OAuth2 Service Principal Secret ProxyDATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_PROXY_DELETEAcciónTool to delete an OAuth secret from a service principal. Use when you need to revoke OAuth credentials for service principal authentication. Once deleted, applications using tokens generated from that secret will no longer be able to access Databricks APIs.
DATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_PROXY_DELETEAcciónTool to delete an OAuth secret from a service principal. Use when you need to revoke OAuth credentials for service principal authentication. Once deleted, applications using tokens generated from that secret will no longer be able to access Databricks APIs.
Parámetros de entrada
secret_idstringObligatorioThe unique identifier of the OAuth secret to delete. Once deleted, applications using tokens generated from this secret will no longer be able to access Databricks APIs
service_principal_idstringObligatorioThe unique identifier of the service principal whose secret will be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Databricks PipelineDATABRICKS_PIPELINES_PIPELINES_DELETEAcciónTool to delete a Databricks Delta Live Tables pipeline permanently and stop any active updates. Use when you need to remove a pipeline completely. If the pipeline publishes to Unity Catalog, deletion will cascade to all pipeline tables. This action cannot be easily undone without Databricks support assistance.
DATABRICKS_PIPELINES_PIPELINES_DELETEAcciónTool to delete a Databricks Delta Live Tables pipeline permanently and stop any active updates. Use when you need to remove a pipeline completely. If the pipeline publishes to Unity Catalog, deletion will cascade to all pipeline tables. This action cannot be easily undone without Databricks support assistance.
Parámetros de entrada
pipeline_idstringObligatorioThe unique identifier of the pipeline to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Pipeline Permission LevelsDATABRICKS_PIPELINES_PIPELINES_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks Delta Live Tables pipeline. Use when you need to understand what permission levels can be assigned to users or groups for a specific pipeline. Returns permission levels like CAN_VIEW, CAN_RUN, CAN_MANAGE, and IS_OWNER with their descriptions.
DATABRICKS_PIPELINES_PIPELINES_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks Delta Live Tables pipeline. Use when you need to understand what permission levels can be assigned to users or groups for a specific pipeline. Returns permission levels like CAN_VIEW, CAN_RUN, CAN_MANAGE, and IS_OWNER with their descriptions.
Parámetros de entrada
pipeline_idstringObligatorioThe unique identifier of the pipeline for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Pipeline PermissionsDATABRICKS_PIPELINES_PIPELINES_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks Delta Live Tables pipeline. Use when you need to check who has access to a pipeline and their permission levels. Returns the complete permissions information including access control lists with user, group, and service principal permissions.
DATABRICKS_PIPELINES_PIPELINES_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks Delta Live Tables pipeline. Use when you need to check who has access to a pipeline and their permission levels. Returns the complete permissions information including access control lists with user, group, and service principal permissions.
Parámetros de entrada
pipeline_idstringObligatorioThe unique identifier of the pipeline for which to retrieve permissions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Pipeline UpdatesDATABRICKS_PIPELINES_PIPELINES_LIST_UPDATESAcciónTool to retrieve a paginated list of updates for a Databricks Delta Live Tables pipeline. Use when you need to view the update history for a specific pipeline. Returns information about each update including state, creation time, and configuration details such as full refresh and table selection.
DATABRICKS_PIPELINES_PIPELINES_LIST_UPDATESAcciónTool to retrieve a paginated list of updates for a Databricks Delta Live Tables pipeline. Use when you need to view the update history for a specific pipeline. Returns information about each update including state, creation time, and configuration details such as full refresh and table selection.
Parámetros de entrada
page_tokenstringOpaque pagination token returned by a previous call to fetch the next page of results.
max_resultsintegerMaximum number of updates to return in a single page. Use for pagination control.
pipeline_idstringObligatorioThe unique identifier of the pipeline for which to retrieve updates
until_update_idstringIf present, returns updates until and including this update_id. Useful for getting updates up to a specific point.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Pipeline PermissionsDATABRICKS_PIPELINES_PIPELINES_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks pipeline. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request. Pipelines can inherit permissions from root object.
DATABRICKS_PIPELINES_PIPELINES_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks pipeline. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request. Pipelines can inherit permissions from root object.
Parámetros de entrada
pipeline_idstringObligatorioIdentifier for the pipeline requiring permission modifications
access_control_listobject[]ObligatorioList of access control entries to update. This operation updates only the specified permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Quality Monitor V2DATABRICKS_QUALITYMONITORV2_QUALITY_MONITOR_V2_CREATE_QUALITY_MONITORAcciónTool to create a quality monitor for Unity Catalog table. Use when you need to set up monitoring for data quality metrics, track drift over time, or monitor ML inference logs. Monitor creation is asynchronous; dashboard and metric tables take 8-20 minutes to complete. Exactly one monitor type (snapshot, time_series, or inference_log) must be specified.
DATABRICKS_QUALITYMONITORV2_QUALITY_MONITOR_V2_CREATE_QUALITY_MONITORAcciónTool to create a quality monitor for Unity Catalog table. Use when you need to set up monitoring for data quality metrics, track drift over time, or monitor ML inference logs. Monitor creation is asynchronous; dashboard and metric tables take 8-20 minutes to complete. Exactly one monitor type (snapshot, time_series, or inference_log) must be specified.
Parámetros de entrada
scheduleobjectCron schedule configuration for automatic monitor refresh.
snapshotobjectSnapshot table monitoring configuration.
assets_dirstringObligatorioAbsolute workspace path for storing monitoring assets including dashboard and metric tables (e.g., /Workspace/Users/{email}/monitoring/)
table_namestringObligatorioFull name of Unity Catalog table to monitor in format catalog.schema.table_name (case insensitive, spaces disallowed)
time_seriesobjectTime series monitoring configuration.
warehouse_idstringWarehouse ID for dashboard query execution
inference_logobjectInference log monitoring configuration for ML models.
notificationsobjectNotification settings for quality monitor alerts.
slicing_exprsstring[]Column expressions for slicing data to enable targeted analysis on data segments
custom_metricsobject[]User-defined custom quality metrics for specialized monitoring needs
output_schema_namestringObligatorioSchema where output metric tables are created in 2-level format {catalog}.{schema}
baseline_table_namestringBaseline table name for computing drift metrics in format catalog.schema.table_name
skip_builtin_dashboardbooleanIf true, skips creation of default quality metrics dashboard
data_classification_configobjectData classification configuration for sensitive data detection.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Databricks Job Run OutputDATABRICKS_RUN_OUTPUTAcciónTool to retrieve output and metadata of a single Databricks task run. Use when you need to get the output value from dbutils.notebook.exit() or check task execution results. IMPORTANT: This only works on task-level run IDs, not top-level job run IDs for multi-task jobs. API returns first 5 MB of output; for larger results use cloud storage. Runs are auto-removed after 60 days.
DATABRICKS_RUN_OUTPUTAcciónTool to retrieve output and metadata of a single Databricks task run. Use when you need to get the output value from dbutils.notebook.exit() or check task execution results. IMPORTANT: This only works on task-level run IDs, not top-level job run IDs for multi-task jobs. API returns first 5 MB of output; for larger results use cloud storage. Runs are auto-removed after 60 days.
Parámetros de entrada
run_idintegerObligatorioThe canonical identifier for the run. For jobs with multiple tasks, this must be the run_id of a task run (not the top-level job run ID).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search MLflow ExperimentsDATABRICKS_SEARCH_MLFLOW_EXPERIMENTSAcciónTool to search for MLflow experiments with filtering, ordering, and pagination support. Use when you need to find experiments based on name patterns, tags, or other criteria. Supports SQL-like filtering expressions and ordering by experiment attributes.
DATABRICKS_SEARCH_MLFLOW_EXPERIMENTSAcciónTool to search for MLflow experiments with filtering, ordering, and pagination support. Use when you need to find experiments based on name patterns, tags, or other criteria. Supports SQL-like filtering expressions and ordering by experiment attributes.
Parámetros de entrada
filterstringSQL-like expression for filtering experiments using operators (=, !=, LIKE, ILIKE) against experiment attributes and tags. Example: "name LIKE 'test-%' AND tags.key = 'value'"
order_bystring[]List of columns for ordering search results, which can include experiment name and id with an optional 'DESC' or 'ASC' annotation. Example: ['name DESC', 'experiment_id ASC']
view_typestringenumQualifier for type of experiments to be returned. ACTIVE_ONLY returns only active experiments (default), DELETED_ONLY returns only deleted experiments, ALL returns all experiments regardless of deletion status.
ACTIVE_ONLYDELETED_ONLYALLpage_tokenstringToken indicating the page of experiments to fetch. Use the next_page_token from a previous response to retrieve the next page of results.
max_resultsintegerMaximum number of experiments desired. Servers may select a desired default max_results value. If not specified, the server will choose a default limit.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search MLflow RunsDATABRICKS_SEARCH_MLFLOW_RUNSAcciónTool to search for MLflow runs with filtering, ordering, and pagination support. Use when you need to find runs based on metrics, parameters, tags, or other criteria. Supports complex filter expressions with operators like =, !=, >, >=, <, <= for metrics, params, and tags.
DATABRICKS_SEARCH_MLFLOW_RUNSAcciónTool to search for MLflow runs with filtering, ordering, and pagination support. Use when you need to find runs based on metrics, parameters, tags, or other criteria. Supports complex filter expressions with operators like =, !=, >, >=, <, <= for metrics, params, and tags.
Parámetros de entrada
filterstringFilter expression for searching runs. Supports params, metrics, and tags with operators: =, !=, >, >=, <, <=. Special characters in column names require double quotes or backticks. Example: "metrics.rmse < 1 and params.model_class = 'LogisticRegression'". Multiple expressions can be joined with AND (no OR support).
order_bystring[]List of columns to be ordered by, including attributes, params, metrics, and tags with an optional DESC or ASC annotation, where ASC is the default. Example: ["params.input DESC", "metrics.rmse"]. When no ordering is specified, tiebreaks default to start_time DESC followed by run_id.
page_tokenstringPagination token for retrieving subsequent result pages. Use the next_page_token from a previous response to retrieve the next page of results.
max_resultsintegerMaximum number of runs desired. If unspecified, defaults to 1000. All servers are guaranteed to support a max_results threshold of at least 50,000.
run_view_typestringenumWhether to display only active, only deleted, or all runs. Defaults to ACTIVE_ONLY if not specified. ACTIVE_ONLY shows runs that are not marked for deletion, DELETED_ONLY shows runs marked for deletion, ALL shows all runs regardless of deletion status.
ACTIVE_ONLYDELETED_ONLYALLexperiment_idsstring[]ObligatorioList of experiment IDs to search over. At least one experiment ID must be provided.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Provisioned Throughput EndpointDATABRICKS_SERVING_SERVING_ENDPOINTS_CREATE_PROVISIONED_THROUGHPUT_ENDPOINTAcciónTool to create a provisioned throughput serving endpoint for AI models in Databricks. Use when you need to provision model units for production GenAI applications with guaranteed throughput. The endpoint name must be unique across the workspace and can consist of alphanumeric characters, dashes, and underscores. Returns a long-running operation that completes when the endpoint is ready.
DATABRICKS_SERVING_SERVING_ENDPOINTS_CREATE_PROVISIONED_THROUGHPUT_ENDPOINTAcciónTool to create a provisioned throughput serving endpoint for AI models in Databricks. Use when you need to provision model units for production GenAI applications with guaranteed throughput. The endpoint name must be unique across the workspace and can consist of alphanumeric characters, dashes, and underscores. Returns a long-running operation that completes when the endpoint is ready.
Parámetros de entrada
namestringObligatorioThe name of the serving endpoint. Must be unique across the Databricks workspace. Can consist of alphanumeric characters, dashes, and underscores
tagsobject[]Tags to be attached to the serving endpoint and automatically propagated to billing logs
configobjectObligatorioThe core configuration of the PT serving endpoint
ai_gatewayobjectThe AI Gateway configuration for the serving endpoint.
budget_policy_idstringThe budget policy associated with the endpoint
email_notificationsobjectEmail notification settings.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Serving EndpointDATABRICKS_SERVING_SERVING_ENDPOINTS_DELETEAcciónTool to delete a model serving endpoint and all associated data. Use when you need to permanently remove an endpoint. Deletion is permanent and cannot be undone. This operation disables usage and deletes all data associated with the endpoint.
DATABRICKS_SERVING_SERVING_ENDPOINTS_DELETEAcciónTool to delete a model serving endpoint and all associated data. Use when you need to permanently remove an endpoint. Deletion is permanent and cannot be undone. This operation disables usage and deletes all data associated with the endpoint.
Parámetros de entrada
namestringObligatorioThe name of the serving endpoint to delete. This is the user-defined name assigned when the endpoint was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Serving Endpoint DetailsDATABRICKS_SERVING_SERVING_ENDPOINTS_GETAcciónTool to retrieve detailed information about a specific serving endpoint by name. Use when you need to get comprehensive information about a serving endpoint including its configuration, state, served entities, traffic routing, and metadata.
DATABRICKS_SERVING_SERVING_ENDPOINTS_GETAcciónTool to retrieve detailed information about a specific serving endpoint by name. Use when you need to get comprehensive information about a serving endpoint including its configuration, state, served entities, traffic routing, and metadata.
Parámetros de entrada
namestringObligatorioThe name of the serving endpoint to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Serving Endpoint OpenAPI SpecDATABRICKS_SERVING_SERVING_ENDPOINTS_GET_OPEN_APIAcciónTool to retrieve the OpenAPI 3.1.0 specification for a serving endpoint. Use when you need to understand the endpoint's schema, generate client code, or visualize the API structure. The endpoint must be in a READY state and the served model must have a model signature logged.
DATABRICKS_SERVING_SERVING_ENDPOINTS_GET_OPEN_APIAcciónTool to retrieve the OpenAPI 3.1.0 specification for a serving endpoint. Use when you need to understand the endpoint's schema, generate client code, or visualize the API structure. The endpoint must be in a READY state and the served model must have a model signature logged.
Parámetros de entrada
namestringObligatorioThe name of the serving endpoint to retrieve the OpenAPI specification for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Serving Endpoint Permission LevelsDATABRICKS_SERVING_SERVING_ENDPOINTS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks serving endpoint. Use when you need to understand what permission levels can be assigned to users or groups for access control. Returns permission levels like CAN_MANAGE, CAN_QUERY, and CAN_VIEW with their descriptions.
DATABRICKS_SERVING_SERVING_ENDPOINTS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks serving endpoint. Use when you need to understand what permission levels can be assigned to users or groups for access control. Returns permission levels like CAN_MANAGE, CAN_QUERY, and CAN_VIEW with their descriptions.
Parámetros de entrada
idstringObligatorioThe unique identifier of the serving endpoint
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Serving Endpoint Rate LimitsDATABRICKS_SERVING_SERVING_ENDPOINTS_PUTAcciónTool to update rate limits for a Databricks serving endpoint. Use when you need to control the number of API calls allowed within a time period. Note: This endpoint is deprecated; consider using AI Gateway for rate limit management instead.
DATABRICKS_SERVING_SERVING_ENDPOINTS_PUTAcciónTool to update rate limits for a Databricks serving endpoint. Use when you need to control the number of API calls allowed within a time period. Note: This endpoint is deprecated; consider using AI Gateway for rate limit management instead.
Parámetros de entrada
namestringObligatorioThe name of the serving endpoint whose rate limits are being updated
rate_limitsobject[]List of rate limit configurations for the endpoint. Each configuration specifies calls allowed per renewal period
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Serving Endpoint AI GatewayDATABRICKS_SERVING_SERVING_ENDPOINTS_PUT_AI_GATEWAYAcciónTool to update AI Gateway configuration of a Databricks serving endpoint. Use when you need to configure traffic fallback, AI guardrails, payload logging, rate limits, or usage tracking. Supports external model, provisioned throughput, and pay-per-token endpoints; agent endpoints currently only support inference tables.
DATABRICKS_SERVING_SERVING_ENDPOINTS_PUT_AI_GATEWAYAcciónTool to update AI Gateway configuration of a Databricks serving endpoint. Use when you need to configure traffic fallback, AI guardrails, payload logging, rate limits, or usage tracking. Supports external model, provisioned throughput, and pay-per-token endpoints; agent endpoints currently only support inference tables.
Parámetros de entrada
idstringObligatorioThe name of the serving endpoint whose AI Gateway is being updated
guardrailsobjectConfiguration for AI Guardrails to prevent unwanted data in requests and responses.
rate_limitsobject[]Configuration for rate limits to control endpoint traffic and prevent overuse
fallback_configobjectConfiguration for traffic fallback which auto fallbacks to other served entities.
usage_tracking_configobjectConfiguration to enable usage tracking using system tables.
inference_table_configobjectConfiguration for payload logging using inference tables.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete AI/BI Dashboard Embedding Access PolicyDATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_ACCESS_POLICY_DELETEAcciónTool to delete AI/BI dashboard embedding access policy, reverting to default. Use when you need to remove the workspace-level policy for AI/BI published dashboard embedding. Upon deletion, the workspace reverts to the default setting (ALLOW_APPROVED_DOMAINS), conditionally permitting AI/BI dashboards to be embedded on approved domains.
DATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_ACCESS_POLICY_DELETEAcciónTool to delete AI/BI dashboard embedding access policy, reverting to default. Use when you need to remove the workspace-level policy for AI/BI published dashboard embedding. Upon deletion, the workspace reverts to the default setting (ALLOW_APPROVED_DOMAINS), conditionally permitting AI/BI dashboards to be embedded on approved domains.
Parámetros de entrada
etagstringUsed for versioning and optimistic concurrency control. The etag helps prevent simultaneous writes from overwriting each other. It is strongly recommended to use the etag in a read-delete pattern: first make a GET request to retrieve the current etag, then pass it with the DELETE request to identify the specific rule set version being deleted. If the setting is updated or deleted concurrently, the DELETE fails with a 409 status code, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AI/BI Dashboard Embedding Access PolicyDATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_ACCESS_POLICY_GETAcciónTool to retrieve workspace AI/BI dashboard embedding access policy setting. Use when you need to check whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled. The default setting is ALLOW_APPROVED_DOMAINS which permits AI/BI dashboards to be embedded on approved domains.
DATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_ACCESS_POLICY_GETAcciónTool to retrieve workspace AI/BI dashboard embedding access policy setting. Use when you need to check whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled. The default setting is ALLOW_APPROVED_DOMAINS which permits AI/BI dashboards to be embedded on approved domains.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control. The response will be at least as fresh as the provided etag. Used to help prevent simultaneous writes from overwriting each other.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update AI/BI Dashboard Embedding Access PolicyDATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_ACCESS_POLICY_UPDATEAcciónTool to update AI/BI dashboard embedding workspace access policy at the workspace level. Use when you need to control whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled. Follows read-modify-write workflow with etag-based optimistic concurrency control to prevent race conditions.
DATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_ACCESS_POLICY_UPDATEAcciónTool to update AI/BI dashboard embedding workspace access policy at the workspace level. Use when you need to control whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled. Follows read-modify-write workflow with etag-based optimistic concurrency control to prevent race conditions.
Parámetros de entrada
settingobjectObligatorioThe configuration object containing the policy settings to apply. Must include access_policy_type and optionally etag for concurrency control.
field_maskstringObligatorioSpecifies which fields are being updated in the request. Must be a single string with multiple fields separated by commas (no spaces). Supports dot notation to navigate nested fields (e.g., 'aibi_dashboard_embedding_access_policy.access_policy_type').
allow_missingbooleanShould always be set to true for Settings API. Added for AIP (Google API Improvement Proposals) compliance.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete AI/BI Dashboard Embedding Approved DomainsDATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_APPROVED_DOMAINS_DELETEAcciónTool to delete the list of approved domains for AI/BI dashboard embedding, reverting to default. Use when you need to remove the workspace-level approved domains list for hosting embedded AI/BI dashboards. Upon deletion, the workspace reverts to an empty approved domains list. The approved domains list cannot be modified when the current access policy is not configured to ALLOW_APPROVED_DOMAINS.
DATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_APPROVED_DOMAINS_DELETEAcciónTool to delete the list of approved domains for AI/BI dashboard embedding, reverting to default. Use when you need to remove the workspace-level approved domains list for hosting embedded AI/BI dashboards. Upon deletion, the workspace reverts to an empty approved domains list. The approved domains list cannot be modified when the current access policy is not configured to ALLOW_APPROVED_DOMAINS.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control. The etag helps prevent simultaneous writes from overwriting each other. It is strongly recommended to use the etag in a read-delete pattern: first make a GET request to retrieve the current etag, then pass it with the DELETE request to identify the specific version being deleted. If the setting is updated or deleted concurrently, the DELETE fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AI/BI Dashboard Embedding Approved DomainsDATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_APPROVED_DOMAINS_GETAcciónTool to retrieve the list of domains approved to host embedded AI/BI dashboards. Use when you need to check which external domains are permitted to embed AI/BI dashboards. The approved domains list cannot be modified unless the workspace access policy is set to ALLOW_APPROVED_DOMAINS.
DATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_APPROVED_DOMAINS_GETAcciónTool to retrieve the list of domains approved to host embedded AI/BI dashboards. Use when you need to check which external domains are permitted to embed AI/BI dashboards. The approved domains list cannot be modified unless the workspace access policy is set to ALLOW_APPROVED_DOMAINS.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control. The response will be at least as fresh as the provided etag. Used to help prevent simultaneous writes from overwriting each other.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update AI/BI Dashboard Embedding Approved DomainsDATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_APPROVED_DOMAINS_UPDATEAcciónTool to update the list of domains approved to host embedded AI/BI dashboards at the workspace level. Use when you need to modify the approved domains list. The approved domains list can only be modified when the current access policy is set to ALLOW_APPROVED_DOMAINS.
DATABRICKS_SETTINGS_AIBI_DASHBOARD_EMBEDDING_APPROVED_DOMAINS_UPDATEAcciónTool to update the list of domains approved to host embedded AI/BI dashboards at the workspace level. Use when you need to modify the approved domains list. The approved domains list can only be modified when the current access policy is set to ALLOW_APPROVED_DOMAINS.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing the values to update
field_maskstringObligatorioComma-separated list of field paths specifying which fields to update. Uses dot notation (.) to navigate sub-fields. Example: 'aibi_dashboard_embedding_approved_domains.approved_domains'. Using '*' indicates full replacement, though explicit field listing is recommended
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Determines behavior when the setting doesn't exist - if true, creates the setting (upsert behavior); if false, returns an error
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automatic Cluster Update SettingDATABRICKS_SETTINGS_AUTOMATIC_CLUSTER_UPDATE_GETAcciónTool to retrieve automatic cluster update setting for the workspace. Use when you need to check whether automatic cluster updates are enabled, view maintenance window configuration, or get restart behavior settings. This setting controls whether clusters automatically update during maintenance windows. Currently in Public Preview.
DATABRICKS_SETTINGS_AUTOMATIC_CLUSTER_UPDATE_GETAcciónTool to retrieve automatic cluster update setting for the workspace. Use when you need to check whether automatic cluster updates are enabled, view maintenance window configuration, or get restart behavior settings. This setting controls whether clusters automatically update during maintenance windows. Currently in Public Preview.
Parámetros de entrada
etagstringUsed for versioning to ensure the response is at least as fresh as the eTag provided. Used for optimistic concurrency control to help prevent simultaneous writes from overwriting each other
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Automatic Cluster Update SettingDATABRICKS_SETTINGS_AUTOMATIC_CLUSTER_UPDATE_UPDATEAcciónTool to update workspace automatic cluster update configuration with etag-based concurrency control. Use when you need to enable/disable automatic cluster updates, configure maintenance windows, or adjust restart behavior. Requires Premium pricing tier and admin access. If the setting is updated concurrently, the PATCH request fails with HTTP 409 requiring retry with fresh etag.
DATABRICKS_SETTINGS_AUTOMATIC_CLUSTER_UPDATE_UPDATEAcciónTool to update workspace automatic cluster update configuration with etag-based concurrency control. Use when you need to enable/disable automatic cluster updates, configure maintenance windows, or adjust restart behavior. Requires Premium pricing tier and admin access. If the setting is updated concurrently, the PATCH request fails with HTTP 409 requiring retry with fresh etag.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing automatic cluster update values to update
field_maskstringObligatorioComma-separated list of field names to update. Use dot notation for nested fields (e.g., 'automatic_cluster_update_workspace.enabled'). Can use '*' for full replacement, but explicit field specification is recommended
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Compliance Security Profile SettingDATABRICKS_SETTINGS_COMPLIANCE_SECURITY_PROFILE_GETAcciónTool to retrieve workspace compliance security profile setting. Use when you need to check whether CSP is enabled or view configured compliance standards. The CSP enables additional monitoring, enforced instance types for inter-node encryption, hardened compute images, and other security controls. Once enabled, this setting represents a permanent workspace change that cannot be disabled.
DATABRICKS_SETTINGS_COMPLIANCE_SECURITY_PROFILE_GETAcciónTool to retrieve workspace compliance security profile setting. Use when you need to check whether CSP is enabled or view configured compliance standards. The CSP enables additional monitoring, enforced instance types for inter-node encryption, hardened compute images, and other security controls. Once enabled, this setting represents a permanent workspace change that cannot be disabled.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control. Ensures responses are at least as fresh as the provided value, helping prevent simultaneous overwrites
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Dashboard Email Subscriptions SettingDATABRICKS_SETTINGS_DASHBOARD_EMAIL_SUBSCRIPTIONS_DELETEAcciónTool to delete the dashboard email subscriptions setting, reverting to default value. Use when you need to revert the workspace setting that controls whether schedules or workload tasks for refreshing AI/BI Dashboards can send subscription emails. Upon deletion, the setting reverts to its default value (enabled/true). This is a workspace-level setting.
DATABRICKS_SETTINGS_DASHBOARD_EMAIL_SUBSCRIPTIONS_DELETEAcciónTool to delete the dashboard email subscriptions setting, reverting to default value. Use when you need to revert the workspace setting that controls whether schedules or workload tasks for refreshing AI/BI Dashboards can send subscription emails. Upon deletion, the setting reverts to its default value (enabled/true). This is a workspace-level setting.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control. The etag helps prevent simultaneous writes from overwriting each other. It is strongly recommended to use the etag in a read-delete pattern: first make a GET request to retrieve the current etag, then pass it with the DELETE request to identify the specific version being deleted. If the setting is updated or deleted concurrently, the DELETE fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dashboard Email Subscriptions SettingDATABRICKS_SETTINGS_DASHBOARD_EMAIL_SUBSCRIPTIONS_GETAcciónTool to retrieve dashboard email subscriptions setting for the workspace. Use when you need to check whether schedules or workload tasks for refreshing AI/BI Dashboards can send subscription emails. By default, this setting is enabled.
DATABRICKS_SETTINGS_DASHBOARD_EMAIL_SUBSCRIPTIONS_GETAcciónTool to retrieve dashboard email subscriptions setting for the workspace. Use when you need to check whether schedules or workload tasks for refreshing AI/BI Dashboards can send subscription emails. By default, this setting is enabled.
Parámetros de entrada
etagstringETag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read pattern to perform setting reads in order to get versioning information.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Dashboard Email Subscriptions SettingDATABRICKS_SETTINGS_DASHBOARD_EMAIL_SUBSCRIPTIONS_UPDATEAcciónTool to update the Dashboard Email Subscriptions setting for the workspace with etag-based concurrency control. Use when you need to enable or disable whether dashboard schedules can send subscription emails. If the setting is updated concurrently, the PATCH request fails with HTTP 409 requiring retry with fresh etag.
DATABRICKS_SETTINGS_DASHBOARD_EMAIL_SUBSCRIPTIONS_UPDATEAcciónTool to update the Dashboard Email Subscriptions setting for the workspace with etag-based concurrency control. Use when you need to enable or disable whether dashboard schedules can send subscription emails. If the setting is updated concurrently, the PATCH request fails with HTTP 409 requiring retry with fresh etag.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing dashboard email subscriptions values to update
field_maskstringObligatorioComma-separated list of field names to update (no spaces). Use dot notation for nested fields. Example: 'boolean_val.value'
allow_missingbooleanShould always be set to true for Settings API. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Default Namespace SettingDATABRICKS_SETTINGS_DEFAULT_NAMESPACE_DELETEAcciónTool to delete the default namespace setting for the workspace, removing the default catalog configuration. Use when you need to remove the default catalog used for queries without fully qualified names. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
DATABRICKS_SETTINGS_DEFAULT_NAMESPACE_DELETEAcciónTool to delete the default namespace setting for the workspace, removing the default catalog configuration. Use when you need to remove the default catalog used for queries without fully qualified names. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Default Namespace SettingDATABRICKS_SETTINGS_DEFAULT_NAMESPACE_GETAcciónTool to retrieve the default catalog namespace setting for the workspace. Use when you need to check which catalog is used for unqualified table references in Unity Catalog-enabled compute. Changes to this setting require restart of clusters and SQL warehouses to take effect.
DATABRICKS_SETTINGS_DEFAULT_NAMESPACE_GETAcciónTool to retrieve the default catalog namespace setting for the workspace. Use when you need to check which catalog is used for unqualified table references in Unity Catalog-enabled compute. Changes to this setting require restart of clusters and SQL warehouses to take effect.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided eTag value. Used to ensure you're working with the latest version of the setting
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Default Namespace SettingDATABRICKS_SETTINGS_DEFAULT_NAMESPACE_UPDATEAcciónTool to update the default catalog namespace configuration for workspace queries with etag-based concurrency control. Use when you need to configure the default catalog used for queries without fully qualified three-level names. Requires a restart of clusters and SQL warehouses to take effect. Only applies to Unity Catalog-enabled compute. If concurrent updates occur, the request fails with 409 status requiring retry with fresh etag.
DATABRICKS_SETTINGS_DEFAULT_NAMESPACE_UPDATEAcciónTool to update the default catalog namespace configuration for workspace queries with etag-based concurrency control. Use when you need to configure the default catalog used for queries without fully qualified three-level names. Requires a restart of clusters and SQL warehouses to take effect. Only applies to Unity Catalog-enabled compute. If concurrent updates occur, the request fails with 409 status requiring retry with fresh etag.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing default namespace values to update. Must include etag obtained from a GET request
field_maskstringObligatorioField mask in dot notation specifying which fields to update. Supports comma-separated values (no spaces). Use '*' for full replacement. Field names must exactly match the resource field names
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Default Warehouse ID SettingDATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_DELETEAcciónTool to delete the default warehouse ID setting for the workspace, reverting to default state. Use when you need to remove the default SQL warehouse configuration. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
DATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_DELETEAcciónTool to delete the default warehouse ID setting for the workspace, reverting to default state. Use when you need to remove the default SQL warehouse configuration. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Default Warehouse ID SettingDATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_GETAcciónTool to retrieve the default SQL warehouse ID setting for the workspace. Use when you need to check which warehouse is configured as the default for SQL authoring surfaces, AI/BI dashboards, Genie, Alerts, and Catalog Explorer.
DATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_GETAcciónTool to retrieve the default SQL warehouse ID setting for the workspace. Use when you need to check which warehouse is configured as the default for SQL authoring surfaces, AI/BI dashboards, Genie, Alerts, and Catalog Explorer.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided eTag value. Used to ensure you're working with the latest version of the setting
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Default Warehouse ID SettingDATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_UPDATEAcciónTool to update the default SQL warehouse configuration for the workspace with etag-based concurrency control. Use when you need to configure which warehouse is used as the default for SQL operations and queries in the workspace. If concurrent updates occur, the request fails with 409 status requiring retry with fresh etag.
DATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_UPDATEAcciónTool to update the default SQL warehouse configuration for the workspace with etag-based concurrency control. Use when you need to configure which warehouse is used as the default for SQL operations and queries in the workspace. If concurrent updates occur, the request fails with 409 status requiring retry with fresh etag.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing default warehouse ID values to update. Must include etag obtained from a GET request
field_maskstringObligatorioField mask in dot notation specifying which fields to update. Supports comma-separated values (no spaces). Use '*' for full replacement. Field names must exactly match the resource field names
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Disable Legacy Access SettingDATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_DELETEAcciónTool to delete the disable legacy access workspace setting, re-enabling legacy features. Use when you need to revert to allowing legacy Databricks features. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409). Changes take up to 5 minutes and require cluster/warehouse restart.
DATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_DELETEAcciónTool to delete the disable legacy access workspace setting, re-enabling legacy features. Use when you need to revert to allowing legacy Databricks features. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409). Changes take up to 5 minutes and require cluster/warehouse restart.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Disable Legacy Access SettingDATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_GETAcciónTool to retrieve the disable legacy access workspace setting. Use when you need to check whether legacy feature access is disabled, including direct Hive Metastore access, Fallback Mode on external locations, and Databricks Runtime versions prior to 13.3 LTS.
DATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_GETAcciónTool to retrieve the disable legacy access workspace setting. Use when you need to check whether legacy feature access is disabled, including direct Hive Metastore access, Fallback Mode on external locations, and Databricks Runtime versions prior to 13.3 LTS.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided eTag value. Used to ensure you're working with the latest version of the setting
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Disable Legacy Access SettingDATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_UPDATEAcciónTool to update workspace disable legacy access setting with etag-based concurrency control. Use when you need to enable or disable legacy access features including direct Hive Metastore access, external location fallback mode, and Databricks Runtime versions prior to 13.3LTS. If concurrent updates occur, the request fails with HTTP 409 requiring retry with fresh etag from the error response.
DATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_UPDATEAcciónTool to update workspace disable legacy access setting with etag-based concurrency control. Use when you need to enable or disable legacy access features including direct Hive Metastore access, external location fallback mode, and Databricks Runtime versions prior to 13.3LTS. If concurrent updates occur, the request fails with HTTP 409 requiring retry with fresh etag from the error response.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing disable legacy access values to update. Include etag from GET request for concurrency control
field_maskstringObligatorioComma-separated list of field names to update (no spaces). Use dot notation for nested fields (e.g., 'disable_legacy_access.value'). Explicitly list fields instead of using '*' wildcards
allow_missingbooleanMust always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Disable Legacy DBFS SettingDATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_DELETEAcciónTool to delete the disable legacy DBFS workspace setting, reverting to default DBFS access behavior. Use when you need to re-enable access to legacy DBFS root and mounts. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
DATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_DELETEAcciónTool to delete the disable legacy DBFS workspace setting, reverting to default DBFS access behavior. Use when you need to re-enable access to legacy DBFS root and mounts. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Disable Legacy DBFS SettingDATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_GETAcciónTool to retrieve the disable legacy DBFS workspace setting. Use when you need to check whether legacy DBFS root and mount access is disabled across all interfaces (UI, APIs, CLI, FUSE). When enabled, this setting also disables Databricks Runtime versions prior to 13.3 LTS and requires manual restart of compute clusters and SQL warehouses to take effect.
DATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_GETAcciónTool to retrieve the disable legacy DBFS workspace setting. Use when you need to check whether legacy DBFS root and mount access is disabled across all interfaces (UI, APIs, CLI, FUSE). When enabled, this setting also disables Databricks Runtime versions prior to 13.3 LTS and requires manual restart of compute clusters and SQL warehouses to take effect.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided eTag value. Used to ensure you're working with the latest version of the setting
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Disable Legacy DBFS SettingDATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_UPDATEAcciónTool to update workspace disable legacy DBFS setting with etag-based concurrency control. Use when you need to enable or disable legacy DBFS features including DBFS root access, mounts, and legacy Databricks Runtime versions prior to 13.3 LTS. Changes take up to 20 minutes to take effect and require manual restart of compute clusters and SQL warehouses.
DATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_UPDATEAcciónTool to update workspace disable legacy DBFS setting with etag-based concurrency control. Use when you need to enable or disable legacy DBFS features including DBFS root access, mounts, and legacy Databricks Runtime versions prior to 13.3 LTS. Changes take up to 20 minutes to take effect and require manual restart of compute clusters and SQL warehouses.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing disable legacy DBFS values to update. Include etag from GET request for concurrency control
field_maskstringObligatorioComma-separated list of field names to update (no spaces). Use dot notation for nested fields (e.g., 'disable_legacy_dbfs.value'). Explicitly list fields instead of using '*' wildcards
allow_missingbooleanMust always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Enable Export Notebook SettingDATABRICKS_SETTINGS_ENABLE_EXPORT_NOTEBOOK_GET_ENABLE_EXPORT_NOTEBOOKAcciónTool to retrieve workspace setting controlling notebook export functionality. Use when you need to check whether users can export notebooks and files from the Workspace UI. Administrators use this setting to manage data exfiltration controls.
DATABRICKS_SETTINGS_ENABLE_EXPORT_NOTEBOOK_GET_ENABLE_EXPORT_NOTEBOOKAcciónTool to retrieve workspace setting controlling notebook export functionality. Use when you need to check whether users can export notebooks and files from the Workspace UI. Administrators use this setting to manage data exfiltration controls.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided etag value.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Enable Export NotebookDATABRICKS_SETTINGS_ENABLE_EXPORT_NOTEBOOK_PATCH_ENABLE_EXPORT_NOTEBOOKAcciónTool to update workspace notebook and file export setting. Use when you need to enable or disable users' ability to export notebooks and files from the Workspace UI. Requires admin access.
DATABRICKS_SETTINGS_ENABLE_EXPORT_NOTEBOOK_PATCH_ENABLE_EXPORT_NOTEBOOKAcciónTool to update workspace notebook and file export setting. Use when you need to enable or disable users' ability to export notebooks and files from the Workspace UI. Requires admin access.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing enable export notebook values to update
field_maskstringObligatorioComma-separated list of field names to update. Use dot notation for nested fields (e.g., 'boolean_val.value'). Can use '*' for full replacement, but explicit field specification is recommended
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Enable Notebook Table Clipboard SettingDATABRICKS_SETTINGS_ENABLE_NOTEBOOK_TABLE_CLIPBOARD_GET_ENABLE_NOTEBOOK_TABLE_CLIPBOARDAcciónTool to retrieve notebook table clipboard setting for the workspace. Use when you need to check whether notebook table clipboard functionality is enabled. This setting controls whether users can copy data from tables in notebooks to their clipboard.
DATABRICKS_SETTINGS_ENABLE_NOTEBOOK_TABLE_CLIPBOARD_GET_ENABLE_NOTEBOOK_TABLE_CLIPBOARDAcciónTool to retrieve notebook table clipboard setting for the workspace. Use when you need to check whether notebook table clipboard functionality is enabled. This setting controls whether users can copy data from tables in notebooks to their clipboard.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided etag value. Used to help prevent simultaneous writes from overwriting each other.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Enable Notebook Table ClipboardDATABRICKS_SETTINGS_ENABLE_NOTEBOOK_TABLE_CLIPBOARD_PATCH_ENABLE_NOTEBOOK_TABLE_CLIPBOARDAcciónTool to update workspace setting for notebook table clipboard. Use when you need to enable or disable users' ability to copy tabular data from notebook result tables to clipboard. Requires workspace admin privileges.
DATABRICKS_SETTINGS_ENABLE_NOTEBOOK_TABLE_CLIPBOARD_PATCH_ENABLE_NOTEBOOK_TABLE_CLIPBOARDAcciónTool to update workspace setting for notebook table clipboard. Use when you need to enable or disable users' ability to copy tabular data from notebook result tables to clipboard. Requires workspace admin privileges.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing enable notebook table clipboard values to update
field_maskstringObligatorioComma-separated list of field names to update. Use dot notation for nested fields (e.g., 'boolean_val.value'). Can use '*' for full replacement, but explicit field specification is recommended
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Enable Results Downloading SettingDATABRICKS_SETTINGS_ENABLE_RESULTS_DOWNLOADING_GET_ENABLE_RESULTS_DOWNLOADINGAcciónTool to retrieve workspace setting controlling notebook results download functionality. Use when you need to check whether users can download notebook query results. Requires workspace administrator privileges to access.
DATABRICKS_SETTINGS_ENABLE_RESULTS_DOWNLOADING_GET_ENABLE_RESULTS_DOWNLOADINGAcciónTool to retrieve workspace setting controlling notebook results download functionality. Use when you need to check whether users can download notebook query results. Requires workspace administrator privileges to access.
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. The response will be at least as fresh as the provided etag value.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Enable Results DownloadingDATABRICKS_SETTINGS_ENABLE_RESULTS_DOWNLOADING_PATCHAcciónTool to update workspace notebook results download setting. Use when you need to enable or disable users' ability to download notebook results. Requires admin access.
DATABRICKS_SETTINGS_ENABLE_RESULTS_DOWNLOADING_PATCHAcciónTool to update workspace notebook results download setting. Use when you need to enable or disable users' ability to download notebook results. Requires admin access.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing enable results downloading values to update
field_maskstringObligatorioComma-separated list of field names to update. Use dot notation for nested fields (e.g., 'setting.boolean_val.value'). Can use '*' for full replacement, but explicit field specification is recommended
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Enhanced Security Monitoring SettingDATABRICKS_SETTINGS_ENHANCED_SECURITY_MONITORING_GETAcciónTool to retrieve enhanced security monitoring workspace setting. Use when you need to check whether Enhanced Security Monitoring is enabled for the workspace. Enhanced Security Monitoring provides a hardened disk image and additional security monitoring agents. It is automatically enabled when compliance security profile is active, and can be manually toggled when compliance security profile is disabled.
DATABRICKS_SETTINGS_ENHANCED_SECURITY_MONITORING_GETAcciónTool to retrieve enhanced security monitoring workspace setting. Use when you need to check whether Enhanced Security Monitoring is enabled for the workspace. Enhanced Security Monitoring provides a hardened disk image and additional security monitoring agents. It is automatically enabled when compliance security profile is active, and can be manually toggled when compliance security profile is disabled.
Parámetros de entrada
etagstringUsed for versioning to ensure the response is at least as fresh as the eTag provided. Used for optimistic concurrency control to help prevent simultaneous writes from overwriting each other
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Enhanced Security MonitoringDATABRICKS_SETTINGS_ENHANCED_SECURITY_MONITORING_UPDATEAcciónTool to update enhanced security monitoring workspace settings. Use when you need to enable or disable Enhanced Security Monitoring (ESM) for the workspace. Requires the etag from a previous GET request for optimistic concurrency control.
DATABRICKS_SETTINGS_ENHANCED_SECURITY_MONITORING_UPDATEAcciónTool to update enhanced security monitoring workspace settings. Use when you need to enable or disable Enhanced Security Monitoring (ESM) for the workspace. Requires the etag from a previous GET request for optimistic concurrency control.
Parámetros de entrada
settingobjectObligatorioThe enhanced security monitoring setting configuration object.
field_maskstringObligatorioComma-separated list of field paths to update (no spaces). Supports dot notation for nested fields (e.g., 'enhanced_security_monitoring_workspace.is_enabled'). Cannot specify individual sequence or map elements. Use '*' for full replacement.
allow_missingbooleanObligatorioThis should always be set to true for Settings API. Added for AIP compliance.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create IP Access ListDATABRICKS_SETTINGS_IP_ACCESS_LISTS_CREATEAcciónTool to create a new IP access list for workspace access control. Use when you need to allow or block specific IP addresses and CIDR ranges from accessing the Databricks workspace. The API will reject creation if the resulting list would block the caller's current IP address. Changes may take a few minutes to take effect.
DATABRICKS_SETTINGS_IP_ACCESS_LISTS_CREATEAcciónTool to create a new IP access list for workspace access control. Use when you need to allow or block specific IP addresses and CIDR ranges from accessing the Databricks workspace. The API will reject creation if the resulting list would block the caller's current IP address. Changes may take a few minutes to take effect.
Parámetros de entrada
labelstringObligatorioLabel for the IP access list. This cannot be empty. A descriptive name for the IP access list (e.g., 'office', 'vpn-users')
enabledbooleanSpecifies whether this list is enabled. Pass true or false. Defaults to true if not specified
list_typestringObligatorioenumType of IP access list. 'ALLOW' creates an allow list to include IP addresses/ranges. 'BLOCK' creates a block list to exclude IP addresses/ranges (IPs in block list are excluded even if included in an allow list)
ALLOWBLOCKip_addressesstring[]A JSON array of IP addresses and CIDR ranges as string values. Example: ['1.1.1.0/24', '2.2.2.2/32']. Maximum of 1000 IP/CIDR values combined across all allow and block lists. Only IPv4 addresses are supported
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get IP Access ListDATABRICKS_SETTINGS_IP_ACCESS_LISTS_GETAcciónTool to retrieve details of a specific IP access list by its ID. Use when you need to view the configuration of allowed or blocked IP addresses and subnets for accessing the workspace or workspace-level APIs. Requires workspace admin privileges.
DATABRICKS_SETTINGS_IP_ACCESS_LISTS_GETAcciónTool to retrieve details of a specific IP access list by its ID. Use when you need to view the configuration of allowed or blocked IP addresses and subnets for accessing the workspace or workspace-level APIs. Requires workspace admin privileges.
Parámetros de entrada
ip_access_list_idstringObligatorioThe unique identifier (UUID) for the IP access list to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete LLM Proxy Partner Powered SettingDATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_DELETEAcciónTool to delete (revert to default) the partner-powered AI features workspace setting. Use when you need to revert the workspace to default configuration for AI features powered by partner providers. By default, this setting is enabled for workspaces without a compliance security profile. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_DELETEAcciónTool to delete (revert to default) the partner-powered AI features workspace setting. Use when you need to revert the workspace to default configuration for AI features powered by partner providers. By default, this setting is enabled for workspaces without a compliance security profile. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get LLM Proxy Partner Powered SettingDATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_GETAcciónTool to retrieve workspace-level setting that controls whether partner-powered AI features are enabled. Use when you need to check if features like Databricks Assistant, Genie, and Data Science Agent can use models hosted by partner providers (Azure OpenAI or Anthropic). By default, this setting is enabled for non-CSP workspaces.
DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_GETAcciónTool to retrieve workspace-level setting that controls whether partner-powered AI features are enabled. Use when you need to check if features like Databricks Assistant, Genie, and Data Science Agent can use models hosted by partner providers (Azure OpenAI or Anthropic). By default, this setting is enabled for non-CSP workspaces.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control to prevent simultaneous writes from overwriting each other. Should be retrieved from GET and passed with subsequent PATCH requests
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update LLM Proxy Partner Powered SettingDATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_UPDATEAcciónTool to update workspace-level setting controlling whether AI features are powered by partner-hosted models with etag-based concurrency control. Use when you need to enable or disable partner-powered AI features (Azure OpenAI or Anthropic). When disabled, Databricks-hosted models are used. If concurrent updates occur, the request fails with 409 status requiring retry with fresh etag.
DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_UPDATEAcciónTool to update workspace-level setting controlling whether AI features are powered by partner-hosted models with etag-based concurrency control. Use when you need to enable or disable partner-powered AI features (Azure OpenAI or Anthropic). When disabled, Databricks-hosted models are used. If concurrent updates occur, the request fails with 409 status requiring retry with fresh etag.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing LLM proxy partner powered values to update. Must include etag obtained from a GET request
field_maskstringObligatorioComma-separated list of fields to update (no spaces). Field paths are relative to the setting object using dot notation for sub-fields (e.g., 'boolean_val.value'). A field mask of '*' indicates full replacement, but it's recommended to explicitly list fields being updated
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the setting to be created if it doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Notification DestinationDATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_CREATEAcciónTool to create a notification destination for alerts and jobs. Use when you need to set up destinations for sending notifications outside of Databricks (email, Slack, PagerDuty, Microsoft Teams, or webhooks). Only workspace admins can create notification destinations. Requires HTTPS for webhooks with SSL certificates signed by a trusted certificate authority.
DATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_CREATEAcciónTool to create a notification destination for alerts and jobs. Use when you need to set up destinations for sending notifications outside of Databricks (email, Slack, PagerDuty, Microsoft Teams, or webhooks). Only workspace admins can create notification destinations. Requires HTTPS for webhooks with SSL certificates signed by a trusted certificate authority.
Parámetros de entrada
configobjectObligatorioThe configuration for the notification destination. Must contain exactly one destination type (email, slack, microsoft_teams, pagerduty, or generic_webhook)
display_namestringThe display name for the notification destination
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Notification DestinationDATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_DELETEAcciónTool to delete a notification destination from the Databricks workspace. Use when you need to permanently remove a notification destination. Only workspace administrators have permission to perform this delete operation.
DATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_DELETEAcciónTool to delete a notification destination from the Databricks workspace. Use when you need to permanently remove a notification destination. Only workspace administrators have permission to perform this delete operation.
Parámetros de entrada
idstringObligatorioThe UUID identifying the notification destination to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Notification DestinationDATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_GETAcciónTool to retrieve details of a notification destination by its UUID identifier. Use when you need to get configuration details, display name, and type information for a specific notification destination. Only users with workspace admin permissions will see the full configuration details.
DATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_GETAcciónTool to retrieve details of a notification destination by its UUID identifier. Use when you need to get configuration details, display name, and type information for a specific notification destination. Only users with workspace admin permissions will see the full configuration details.
Parámetros de entrada
idstringObligatorioThe UUID identifying the notification destination to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Notification DestinationDATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_UPDATEAcciónTool to update an existing notification destination configuration. Use when you need to modify display name or configuration settings for email, Slack, PagerDuty, Microsoft Teams, or webhook destinations. Requires workspace admin permissions. At least one field (display_name or config) must be provided.
DATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_UPDATEAcciónTool to update an existing notification destination configuration. Use when you need to modify display name or configuration settings for email, Slack, PagerDuty, Microsoft Teams, or webhook destinations. Requires workspace admin permissions. At least one field (display_name or config) must be provided.
Parámetros de entrada
idstringObligatorioUUID identifying the notification destination to update
configobjectConfiguration for notification destination update. Must contain exactly one destination type.
display_namestringThe display name for the notification destination
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Restrict Workspace Admins SettingDATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_DELETEAcciónTool to delete/revert the restrict workspace admins setting to its default state. Use when you need to restore default workspace administrator capabilities for service principal token creation and job ownership settings. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
DATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_DELETEAcciónTool to delete/revert the restrict workspace admins setting to its default state. Use when you need to restore default workspace administrator capabilities for service principal token creation and job ownership settings. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Restrict Workspace Admins SettingDATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_GETAcciónTool to retrieve the restrict workspace admins setting for the workspace. Use when you need to check whether workspace administrators are restricted in their ability to create service principal tokens, change job owners, or modify job run_as settings. This setting controls security boundaries for admin privileges.
DATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_GETAcciónTool to retrieve the restrict workspace admins setting for the workspace. Use when you need to check whether workspace administrators are restricted in their ability to create service principal tokens, change job owners, or modify job run_as settings. This setting controls security boundaries for admin privileges.
Parámetros de entrada
etagstringUsed for versioning to ensure the response is at least as fresh as the eTag provided. Used for optimistic concurrency control to help prevent simultaneous writes from overwriting each other
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Restrict Workspace Admins SettingDATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_UPDATEAcciónTool to update the restrict workspace admins setting with etag-based concurrency control. Use when you need to modify workspace administrator capabilities for service principal token creation and job ownership/run-as settings. Requires account admin permissions and workspace membership. If concurrent updates occur, the request fails with HTTP 409 requiring retry with fresh etag.
DATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_UPDATEAcciónTool to update the restrict workspace admins setting with etag-based concurrency control. Use when you need to modify workspace administrator capabilities for service principal token creation and job ownership/run-as settings. Requires account admin permissions and workspace membership. If concurrent updates occur, the request fails with HTTP 409 requiring retry with fresh etag.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing restrict workspace admins values to update
field_maskstringObligatorioComma-separated list of field names to update. Use dot notation for nested fields. No spaces between fields
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SQL Results Download SettingDATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_DELETEAcciónTool to delete SQL results download workspace setting, reverting to default state where users are permitted to download results. Use when you need to restore the factory default configuration. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
DATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_DELETEAcciónTool to delete SQL results download workspace setting, reverting to default state where users are permitted to download results. Use when you need to restore the factory default configuration. Strongly recommended to use etag in a read-delete pattern to prevent concurrent modification conflicts (HTTP 409).
Parámetros de entrada
etagstringVersion identifier used for optimistic concurrency control. Helps prevent simultaneous writes from overwriting each other. Should be obtained from a preceding GET request. If concurrent modification occurs, the request fails with HTTP 409 Conflict status, requiring retry with the fresh etag from the 409 response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Results Download SettingDATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_GETAcciónTool to retrieve SQL results download workspace setting. Use when you need to check whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs. By default, this setting is enabled (set to true). Returns etag for use in subsequent update/delete operations.
DATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_GETAcciónTool to retrieve SQL results download workspace setting. Use when you need to check whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs. By default, this setting is enabled (set to true). Returns etag for use in subsequent update/delete operations.
Parámetros de entrada
etagstringVersion identifier for optimistic concurrency control. Used to ensure the response is at least as fresh as the provided eTag. Recommended for read-then-delete patterns to prevent race conditions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SQL Results Download SettingDATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_UPDATEAcciónTool to update workspace SQL results download setting controlling whether users can download results from SQL Editor and AI/BI Dashboards. Use when you need to enable or disable SQL query results download capability. Requires workspace admin access and uses etag-based optimistic concurrency control to prevent conflicting updates.
DATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_UPDATEAcciónTool to update workspace SQL results download setting controlling whether users can download results from SQL Editor and AI/BI Dashboards. Use when you need to enable or disable SQL query results download capability. Requires workspace admin access and uses etag-based optimistic concurrency control to prevent conflicting updates.
Parámetros de entrada
settingobjectObligatorioThe setting configuration object containing SQL results download values to update
field_maskstringObligatorioComma-separated list of field names to update. Use dot notation for nested fields (e.g., 'boolean_val.value'). Can use '*' for full replacement, but explicit field specification is recommended
allow_missingbooleanShould always be set to true for Settings API. Added for AIP compliance. Allows the update to proceed even if the setting doesn't exist yet
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Token via Token ManagementDATABRICKS_SETTINGS_TOKEN_MANAGEMENT_DELETEAcciónTool to delete a token specified by ID via token management. Use when you need to revoke or remove access tokens. Admins can delete tokens for any user.
DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_DELETEAcciónTool to delete a token specified by ID via token management. Use when you need to revoke or remove access tokens. Admins can delete tokens for any user.
Parámetros de entrada
token_idstringObligatorioThe ID of the token to delete/revoke. Admins can delete tokens for any user
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Token InformationDATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GETAcciónTool to retrieve detailed information about a specific token by its ID from the token management system. Use when you need to get token metadata including creation time, expiry, owner, and usage information. Requires appropriate permissions to access token information.
DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GETAcciónTool to retrieve detailed information about a specific token by its ID from the token management system. Use when you need to get token metadata including creation time, expiry, owner, and usage information. Requires appropriate permissions to access token information.
Parámetros de entrada
token_idstringObligatorioThe ID of the token to retrieve. This is the unique identifier for the token in the token management system
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Token Management Permission LevelsDATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for personal access token management. Use when you need to understand what permission levels can be assigned for managing tokens in the workspace. Returns permission levels like CAN_USE and CAN_MANAGE with their descriptions.
DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for personal access token management. Use when you need to understand what permission levels can be assigned for managing tokens in the workspace. Returns permission levels like CAN_USE and CAN_MANAGE with their descriptions.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Token Management PermissionsDATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GET_PERMISSIONSAcciónTool to retrieve permissions for workspace token management. Use when you need to check which users, groups, and service principals have permissions to create and manage personal access tokens. Requires workspace admin privileges and is available only in Databricks Premium plan.
DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GET_PERMISSIONSAcciónTool to retrieve permissions for workspace token management. Use when you need to check which users, groups, and service principals have permissions to create and manage personal access tokens. Requires workspace admin privileges and is available only in Databricks Premium plan.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Token Management PermissionsDATABRICKS_SETTINGS_TOKEN_MANAGEMENT_SET_PERMISSIONSAcciónTool to set permissions for personal access token management, replacing all existing permissions. Use when configuring which users, groups, and service principals can create and use tokens. This operation replaces ALL existing permissions; if you need to add or modify permissions without replacing existing ones, use the update_permissions method instead. Workspace admins always retain CAN_MANAGE permissions.
DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_SET_PERMISSIONSAcciónTool to set permissions for personal access token management, replacing all existing permissions. Use when configuring which users, groups, and service principals can create and use tokens. This operation replaces ALL existing permissions; if you need to add or modify permissions without replacing existing ones, use the update_permissions method instead. Workspace admins always retain CAN_MANAGE permissions.
Parámetros de entrada
access_control_listobject[]ObligatorioArray of access control entries. This replaces ALL existing permissions. For each entry, only one of user_name, group_name, or service_principal_name should be specified. If none are specified, all direct permissions are deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Token Management PermissionsDATABRICKS_SETTINGS_TOKEN_MANAGEMENT_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for personal access token management. Use when you need to modify who can create and use personal access tokens. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for personal access token management. Use when you need to modify who can create and use personal access tokens. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request.
Parámetros de entrada
access_control_listobject[]ObligatorioList of access control entries to update. This operation updates only the specified permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Personal Access TokenDATABRICKS_SETTINGS_TOKENS_CREATEAcciónTool to create a personal access token (PAT) for Databricks API authentication. Use when you need to generate a new token for REST API requests. Each PAT is valid for only one workspace. Users can create up to 600 PATs per workspace. Databricks automatically revokes PATs that haven't been used for 90 days.
DATABRICKS_SETTINGS_TOKENS_CREATEAcciónTool to create a personal access token (PAT) for Databricks API authentication. Use when you need to generate a new token for REST API requests. Each PAT is valid for only one workspace. Users can create up to 600 PATs per workspace. Databricks automatically revokes PATs that haven't been used for 90 days.
Parámetros de entrada
commentstringA comment or description to attach to the token for identification purposes. This will appear on the user's settings page
lifetime_secondsintegerThe lifetime of the token in seconds. If not specified or set to 0, the token will not expire (or will use the maximum allowed by workspace configuration). Example: 7776000 for 90 days
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Public Workspace SettingDATABRICKS_SETTINGSV2_WORKSPACE_SETTINGS_V2_GET_PUBLIC_WORKSPACE_SETTINGAcciónTool to retrieve workspace-level settings by setting ID. Use when you need to get the current value of a specific workspace setting along with its version (etag) for subsequent updates. Returns setting value with etag for optimistic concurrency control.
DATABRICKS_SETTINGSV2_WORKSPACE_SETTINGS_V2_GET_PUBLIC_WORKSPACE_SETTINGAcciónTool to retrieve workspace-level settings by setting ID. Use when you need to get the current value of a specific workspace setting along with its version (etag) for subsequent updates. Returns setting value with etag for optimistic concurrency control.
Parámetros de entrada
idstringObligatorioThe setting identifier. Can be a simple name (e.g., 'default') or a composite path (e.g., 'types/restrict_workspace_admins/names/default'). The path structure allows hierarchical navigation of setting types and names
etagstringUsed for versioning. When provided, the response will be at least as fresh as the eTag provided
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Workspace Configuration StatusDATABRICKS_SETTINGS_WORKSPACE_CONF_SET_STATUSAcciónTool to set workspace configuration settings for a Databricks workspace. Use when you need to enable/disable workspace features or update configuration values. Requires workspace admin permissions. Invalid configuration keys will cause the entire request to fail.
DATABRICKS_SETTINGS_WORKSPACE_CONF_SET_STATUSAcciónTool to set workspace configuration settings for a Databricks workspace. Use when you need to enable/disable workspace features or update configuration values. Requires workspace admin permissions. Invalid configuration keys will cause the entire request to fail.
Parámetros de entrada
configurationsobjectObligatorioDictionary of workspace configuration key-value pairs to set. All values must be strings. Common keys include: maxTokenLifetimeDays (e.g., '90'), enableWorkspaceFileSystem ('true'/'false'), enableNotebookTableClipboard ('true'/'false'), enableIpAccessLists ('true'/'false'), enableJobViewAcls ('true'/'false'), enforceWorkspaceViewAcls ('true'/'false'), enableClusterAclsConfig ('true'/'false'), enableJobAclsConfig ('true'/'false'), enableWorkspaceAclsConfig ('true'/'false'). Setting to '0' or 'false' can reset configurations to defaults.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Sharing ProviderDATABRICKS_SHARING_PROVIDERS_CREATEAcciónTool to create a new authentication provider in Unity Catalog for Delta Sharing. Use when establishing a provider object for receiving data from external sources that aren't Unity Catalog-enabled. Requires metastore admin privileges or CREATE_PROVIDER permission on the metastore. Most recipients should not need to create provider objects manually as they are typically auto-created during Delta Sharing.
DATABRICKS_SHARING_PROVIDERS_CREATEAcciónTool to create a new authentication provider in Unity Catalog for Delta Sharing. Use when establishing a provider object for receiving data from external sources that aren't Unity Catalog-enabled. Requires metastore admin privileges or CREATE_PROVIDER permission on the metastore. Most recipients should not need to create provider objects manually as they are typically auto-created during Delta Sharing.
Parámetros de entrada
namestringObligatorioThe name of the provider. Must be unique within the metastore
commentstringDescription about the provider for documentation purposes
authentication_typestringObligatorioenumAuthentication mechanism for the provider. TOKEN for Delta Sharing open protocol, DATABRICKS for Databricks-to-Databricks sharing, OAUTH_CLIENT_CREDENTIALS for OAuth, OIDC_FEDERATION for OpenID Connect
TOKENDATABRICKSOAUTH_CLIENT_CREDENTIALSOIDC_FEDERATIONrecipient_profile_strstringJSON string containing Delta Sharing credentials (required for TOKEN, OAUTH_CLIENT_CREDENTIALS authentication types). Should include shareCredentialsVersion, endpoint, and bearerToken. For DATABRICKS authentication, this is the sharing identifier in format <cloud>:<region>:<metastore-uuid>
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sharing ProviderDATABRICKS_SHARING_PROVIDERS_GETAcciónTool to retrieve information about a specific Delta Sharing provider in Unity Catalog. Use when you need to get provider details including authentication type, ownership, and connection information. Requires metastore admin privileges or provider ownership.
DATABRICKS_SHARING_PROVIDERS_GETAcciónTool to retrieve information about a specific Delta Sharing provider in Unity Catalog. Use when you need to get provider details including authentication type, ownership, and connection information. Requires metastore admin privileges or provider ownership.
Parámetros de entrada
namestringObligatorioThe name of the provider to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Sharing ProviderDATABRICKS_SHARING_PROVIDERS_UPDATEAcciónTool to update an existing Delta Sharing authentication provider in Unity Catalog. Use when you need to modify provider properties like comment, owner, or name. The caller must be either a metastore admin or the owner of the provider. To rename the provider, the caller must be BOTH a metastore admin AND the owner.
DATABRICKS_SHARING_PROVIDERS_UPDATEAcciónTool to update an existing Delta Sharing authentication provider in Unity Catalog. Use when you need to modify provider properties like comment, owner, or name. The caller must be either a metastore admin or the owner of the provider. To rename the provider, the caller must be BOTH a metastore admin AND the owner.
Parámetros de entrada
namestringObligatorioThe current name of the provider to update. This is used in the path parameter to identify the provider
ownerstringUsername of the new provider owner. Must be the current provider owner to change this
commentstringDescription or comment about the provider
new_namestringNew name for the provider if renaming. Requires both metastore admin and owner privileges
recipient_profile_strstringJSON string containing recipient profile configuration. Required when authentication_type is TOKEN, OAUTH_CLIENT_CREDENTIALS, or not provided. Format: {"shareCredentialsVersion":1,"bearerToken":"<token>","endpoint":"<delta-sharing-endpoint-url>"}
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Sharing RecipientDATABRICKS_SHARING_RECIPIENTS_CREATEAcciónTool to create a Delta Sharing recipient in Unity Catalog metastore. Use when you need to create a recipient object representing an identity who will consume shared data. Recipients can be configured for Databricks-to-Databricks sharing or open sharing with token authentication. Requires metastore admin or CREATE_RECIPIENT privilege.
DATABRICKS_SHARING_RECIPIENTS_CREATEAcciónTool to create a Delta Sharing recipient in Unity Catalog metastore. Use when you need to create a recipient object representing an identity who will consume shared data. Recipients can be configured for Databricks-to-Databricks sharing or open sharing with token authentication. Requires metastore admin or CREATE_RECIPIENT privilege.
Parámetros de entrada
namestringObligatorioName of the recipient. Must be unique within the metastore
ownerstringUsername/groupname/service principal application_id of the recipient owner
commentstringDescription about the recipient
sharing_codestringThe one-time sharing code provided by the data recipient. Used with DATABRICKS authentication
ip_access_listobjectIP access list configuration for recipient.
expiration_timeintegerExpiration timestamp of the token in epoch milliseconds. Used with TOKEN authentication
properties_kvpairsobjectRecipient properties object.
authentication_typestringObligatorioenumThe delta sharing authentication type
DATABRICKSOAUTH_CLIENT_CREDENTIALSOIDC_FEDERATIONTOKENdata_recipient_global_metastore_idstringRequired when authentication_type is DATABRICKS. The global Unity Catalog metastore id provided by the data recipient
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Sharing RecipientDATABRICKS_SHARING_RECIPIENTS_DELETEAcciónTool to delete a Delta Sharing recipient from Unity Catalog metastore. Use when you need to permanently remove a recipient object. Deletion invalidates all access tokens and immediately revokes access to shared data for users represented by the recipient. Requires recipient owner privileges.
DATABRICKS_SHARING_RECIPIENTS_DELETEAcciónTool to delete a Delta Sharing recipient from Unity Catalog metastore. Use when you need to permanently remove a recipient object. Deletion invalidates all access tokens and immediately revokes access to shared data for users represented by the recipient. Requires recipient owner privileges.
Parámetros de entrada
namestringObligatorioThe name of the recipient to delete. The caller must be the owner of the recipient
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sharing RecipientDATABRICKS_SHARING_RECIPIENTS_GETAcciónTool to retrieve a Delta Sharing recipient from Unity Catalog metastore by name. Use when you need to get information about a recipient object representing an entity that receives shared data. Requires recipient ownership or metastore admin privileges.
DATABRICKS_SHARING_RECIPIENTS_GETAcciónTool to retrieve a Delta Sharing recipient from Unity Catalog metastore by name. Use when you need to get information about a recipient object representing an entity that receives shared data. Requires recipient ownership or metastore admin privileges.
Parámetros de entrada
namestringObligatorioName of the recipient to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ShareDATABRICKS_SHARING_SHARES_CREATEAcciónTool to create a new share for data objects in Unity Catalog. Use when you need to establish a share for distributing data assets via Delta Sharing protocol. Data objects can be added after creation with update. Requires metastore admin or CREATE_SHARE privilege on the metastore.
DATABRICKS_SHARING_SHARES_CREATEAcciónTool to create a new share for data objects in Unity Catalog. Use when you need to establish a share for distributing data assets via Delta Sharing protocol. Data objects can be added after creation with update. Requires metastore admin or CREATE_SHARE privilege on the metastore.
Parámetros de entrada
namestringObligatorioName of the share. Must be unique within the metastore
commentstringUser-provided free-form text description of the share
storage_rootstringStorage root URL for the share (e.g., s3://bucket/path, abfss://container@storage.dfs.core.windows.net/path)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ShareDATABRICKS_SHARING_SHARES_DELETEAcciónTool to delete a Unity Catalog share from the metastore. Use when you need to permanently remove a share object. Deletion immediately revokes recipient access to the shared data. This operation is permanent and requires share owner privileges.
DATABRICKS_SHARING_SHARES_DELETEAcciónTool to delete a Unity Catalog share from the metastore. Use when you need to permanently remove a share object. Deletion immediately revokes recipient access to the shared data. This operation is permanent and requires share owner privileges.
Parámetros de entrada
namestringObligatorioThe name of the share to delete. The caller must be an owner of the share. This is the unique identifier for the share object in the Unity Catalog metastore
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Share DetailsDATABRICKS_SHARING_SHARES_GETAcciónTool to retrieve details of a specific share from Unity Catalog. Use when you need to get information about a share including its metadata, owner, and optionally the list of shared data objects. Requires metastore admin privileges or share ownership.
DATABRICKS_SHARING_SHARES_GETAcciónTool to retrieve details of a specific share from Unity Catalog. Use when you need to get information about a share including its metadata, owner, and optionally the list of shared data objects. Requires metastore admin privileges or share ownership.
Parámetros de entrada
namestringObligatorioThe name of the share to retrieve. Must be unique within the metastore
include_shared_databooleanQuery for data to include in the share. When set to true, returns the list of shared data objects within the share
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Share PermissionsDATABRICKS_SHARING_SHARES_SHARE_PERMISSIONSAcciónTool to retrieve permissions for a Delta Sharing share from Unity Catalog. Use when you need to check which principals have been granted privileges on a share. Requires metastore admin privileges or share ownership.
DATABRICKS_SHARING_SHARES_SHARE_PERMISSIONSAcciónTool to retrieve permissions for a Delta Sharing share from Unity Catalog. Use when you need to check which principals have been granted privileges on a share. Requires metastore admin privileges or share ownership.
Parámetros de entrada
namestringObligatorioThe name of the share. This is the unique identifier for the Delta Sharing share in the Unity Catalog metastore
page_tokenstringOpaque pagination token to retrieve the next page of results based on a previous query
max_resultsintegerMaximum number of permissions to return. When set to 0, uses server-configured page length; when greater than 0, uses minimum of this value and server-configured value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ShareDATABRICKS_SHARING_SHARES_UPDATEAcciónTool to update an existing share in Unity Catalog with changes to metadata or data objects. Use when you need to modify share properties (comment, owner, name) or manage shared data objects (add, remove, or update tables/views/volumes). The caller must be a metastore admin or the owner of the share. For table additions, the owner must have SELECT privilege on the table.
DATABRICKS_SHARING_SHARES_UPDATEAcciónTool to update an existing share in Unity Catalog with changes to metadata or data objects. Use when you need to modify share properties (comment, owner, name) or manage shared data objects (add, remove, or update tables/views/volumes). The caller must be a metastore admin or the owner of the share. For table additions, the owner must have SELECT privilege on the table.
Parámetros de entrada
namestringObligatorioThe name of the share to update. This is used in the path parameter to identify the share
ownerstringUsername of current owner of share. Only metastore admins can update this field alone
commentstringUser-provided free-form text description of the share
updatesobject[]Array of shared data object updates (ADD, REMOVE, UPDATE). Maximum 100 update data objects allowed. For ADD operations, the share owner must have SELECT privilege on the table. For UPDATE operations, specify the action and the data object with the changes
new_namestringNew name for the share (for renaming). Requires CREATE_SHARE privilege
storage_rootstringStorage root URL for the share. Cannot be updated if there are notebook files in the share
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Spark VersionsDATABRICKS_SPARK_VERSIONSAcciónTool to retrieve all available Databricks Runtime and Spark versions for cluster creation. Use when you need to determine which Spark versions are available for creating or configuring clusters.
DATABRICKS_SPARK_VERSIONSAcciónTool to retrieve all available Databricks Runtime and Spark versions for cluster creation. Use when you need to determine which Spark versions are available for creating or configuring clusters.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SQL AlertDATABRICKS_SQL_ALERTS_CREATEAcciónTool to create a new Databricks SQL alert for query monitoring. Use when you need to set up alerts that monitor query results and trigger notifications when specified conditions are met. The alert will evaluate the query results and send notifications when the condition threshold is crossed.
DATABRICKS_SQL_ALERTS_CREATEAcciónTool to create a new Databricks SQL alert for query monitoring. Use when you need to set up alerts that monitor query results and trigger notifications when specified conditions are met. The alert will evaluate the query results and send notifications when the condition threshold is crossed.
Parámetros de entrada
alertobjectObligatorioThe alert configuration object containing all alert settings
auto_resolve_display_namebooleanIf true, automatically resolve alert display name conflicts. Otherwise, fail the request if display name conflicts with existing alert
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SQL AlertDATABRICKS_SQL_ALERTS_DELETEAcciónTool to delete a Databricks SQL alert (soft delete to trash). Use when you need to remove an alert from active monitoring. The alert is moved to trash and can be restored through the UI within 30 days, after which it is permanently deleted.
DATABRICKS_SQL_ALERTS_DELETEAcciónTool to delete a Databricks SQL alert (soft delete to trash). Use when you need to remove an alert from active monitoring. The alert is moved to trash and can be restored through the UI within 30 days, after which it is permanently deleted.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL alert to delete. The alert will be moved to trash (soft delete) and can be restored within 30 days
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Alert DetailsDATABRICKS_SQL_ALERTS_GETAcciónTool to retrieve details of a specific Databricks SQL alert by its UUID. Use when you need to get information about an alert including its configuration, trigger conditions, state, and notification settings.
DATABRICKS_SQL_ALERTS_GETAcciónTool to retrieve details of a specific Databricks SQL alert by its UUID. Use when you need to get information about an alert including its configuration, trigger conditions, state, and notification settings.
Parámetros de entrada
idstringObligatorioThe UUID identifying the alert to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Legacy SQL AlertDATABRICKS_SQL_ALERTS_LEGACY_CREATEAcciónTool to create a legacy SQL alert that periodically runs a query and notifies when conditions are met. Use when you need to create alerts using the legacy API endpoint. Note: This is a legacy endpoint that has been replaced by /api/2.0/sql/alerts and is deprecated.
DATABRICKS_SQL_ALERTS_LEGACY_CREATEAcciónTool to create a legacy SQL alert that periodically runs a query and notifies when conditions are met. Use when you need to create alerts using the legacy API endpoint. Note: This is a legacy endpoint that has been replaced by /api/2.0/sql/alerts and is deprecated.
Parámetros de entrada
namestringObligatorioName of the alert
rearmintegerNumber of seconds after being triggered before the alert rearms itself and can be triggered again. If not defined, alert will never be triggered again
parentstringThe identifier of the workspace folder containing the alert. Default is the user's home folder. Format: folders/<folder_id>
optionsobjectObligatorioAlert configuration options including column, operator, and comparison value
query_idstringObligatorioID of the query evaluated by the alert
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Legacy SQL AlertDATABRICKS_SQL_ALERTS_LEGACY_DELETEAcciónTool to permanently delete a legacy SQL alert (permanent deletion). Use when you need to permanently remove an alert using the legacy API endpoint. Note: This is a legacy endpoint that permanently deletes alerts. Unlike the newer /api/2.0/sql/alerts endpoint, deleted alerts cannot be restored from trash.
DATABRICKS_SQL_ALERTS_LEGACY_DELETEAcciónTool to permanently delete a legacy SQL alert (permanent deletion). Use when you need to permanently remove an alert using the legacy API endpoint. Note: This is a legacy endpoint that permanently deletes alerts. Unlike the newer /api/2.0/sql/alerts endpoint, deleted alerts cannot be restored from trash.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID or numeric ID) of the SQL alert to permanently delete. This is a legacy API endpoint that permanently deletes alerts without moving them to trash
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Legacy SQL AlertDATABRICKS_SQL_ALERTS_LEGACY_GETAcciónTool to retrieve details of a specific legacy SQL alert by its ID. Use when you need to get information about a legacy alert including its configuration, state, query details, and notification settings. Note: This is a legacy endpoint (/api/2.0/preview/sql/alerts) that is deprecated and being replaced by /api/2.0/sql/alerts.
DATABRICKS_SQL_ALERTS_LEGACY_GETAcciónTool to retrieve details of a specific legacy SQL alert by its ID. Use when you need to get information about a legacy alert including its configuration, state, query details, and notification settings. Note: This is a legacy endpoint (/api/2.0/preview/sql/alerts) that is deprecated and being replaced by /api/2.0/sql/alerts.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL alert to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Legacy SQL AlertsDATABRICKS_SQL_ALERTS_LEGACY_LISTAcciónTool to list all legacy SQL alerts accessible to the authenticated user. Use when you need to retrieve a list of all legacy alerts in the workspace. Note: This is a legacy endpoint (/api/2.0/preview/sql/alerts) that is deprecated and being replaced by /api/2.0/sql/alerts.
DATABRICKS_SQL_ALERTS_LEGACY_LISTAcciónTool to list all legacy SQL alerts accessible to the authenticated user. Use when you need to retrieve a list of all legacy alerts in the workspace. Note: This is a legacy endpoint (/api/2.0/preview/sql/alerts) that is deprecated and being replaced by /api/2.0/sql/alerts.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Legacy SQL AlertDATABRICKS_SQL_ALERTS_LEGACY_UPDATEAcciónTool to update a legacy SQL alert configuration including name, query reference, trigger conditions, and notification settings. Use when you need to modify existing alerts using the legacy API endpoint. Note: This is a legacy endpoint that has been replaced by /api/2.0/sql/alerts and is deprecated.
DATABRICKS_SQL_ALERTS_LEGACY_UPDATEAcciónTool to update a legacy SQL alert configuration including name, query reference, trigger conditions, and notification settings. Use when you need to modify existing alerts using the legacy API endpoint. Note: This is a legacy endpoint that has been replaced by /api/2.0/sql/alerts and is deprecated.
Parámetros de entrada
idstringObligatorioThe unique identifier of the alert to update
namestringName of the alert
rearmintegerNumber of seconds after being triggered before the alert rearms itself and can be triggered again. If not defined, alert will never be triggered again
parentstringThe identifier of the workspace folder containing the alert. Format: folders/<folder_id>
optionsobjectObligatorioAlert configuration options including column, operator, and comparison value (required for update)
query_idstringObligatorioID of the query evaluated by the alert (required for update)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SQL AlertDATABRICKS_SQL_ALERTS_UPDATEAcciónTool to update an existing Databricks SQL alert using partial update with field mask. Use when you need to modify alert properties including display name, query reference, trigger conditions, notification settings, or ownership.
DATABRICKS_SQL_ALERTS_UPDATEAcciónTool to update an existing Databricks SQL alert using partial update with field mask. Use when you need to modify alert properties including display name, query reference, trigger conditions, notification settings, or ownership.
Parámetros de entrada
idstringObligatorioUUID identifying the alert to update
alertobjectAlert object containing fields to update.
update_maskstringObligatorioComma-separated field names to update (no spaces). Use dot notation for nested fields (e.g., 'condition.op'). Field names must match resource field names exactly
auto_resolve_display_namebooleanWhen true, automatically resolves display name conflicts; when false, fails if conflict exists
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SQL DashboardDATABRICKS_SQL_DASHBOARDS_DELETEAcciónTool to delete a legacy Databricks SQL dashboard by moving it to trash (soft delete). Use when you need to remove a dashboard from active use. The dashboard is moved to trash and can be restored later through the UI. Trashed dashboards do not appear in searches and cannot be shared.
DATABRICKS_SQL_DASHBOARDS_DELETEAcciónTool to delete a legacy Databricks SQL dashboard by moving it to trash (soft delete). Use when you need to remove a dashboard from active use. The dashboard is moved to trash and can be restored later through the UI. Trashed dashboards do not appear in searches and cannot be shared.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the legacy SQL dashboard to delete. The dashboard will be moved to trash (soft delete) and can be restored later. Trashed dashboards do not appear in list views or searches and cannot be shared until restored
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL DashboardDATABRICKS_SQL_DASHBOARDS_GETAcciónTool to retrieve complete legacy dashboard definition with metadata, widgets, and queries. Use when you need to get detailed information about a SQL dashboard. Note: Legacy dashboards API deprecated as of January 12, 2026. Databricks recommends using AI/BI dashboards (Lakeview API) for new implementations.
DATABRICKS_SQL_DASHBOARDS_GETAcciónTool to retrieve complete legacy dashboard definition with metadata, widgets, and queries. Use when you need to get detailed information about a SQL dashboard. Note: Legacy dashboards API deprecated as of January 12, 2026. Databricks recommends using AI/BI dashboards (Lakeview API) for new implementations.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the legacy SQL dashboard to retrieve. This ID identifies the dashboard across Databricks REST API services
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SQL DashboardDATABRICKS_SQL_DASHBOARDS_UPDATEAcciónTool to update legacy Databricks SQL dashboard attributes (name, run_as_role, tags). Use when you need to modify dashboard metadata. Note: This operation only affects dashboard object attributes and does NOT add, modify, or remove widgets.
DATABRICKS_SQL_DASHBOARDS_UPDATEAcciónTool to update legacy Databricks SQL dashboard attributes (name, run_as_role, tags). Use when you need to modify dashboard metadata. Note: This operation only affects dashboard object attributes and does NOT add, modify, or remove widgets.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the legacy SQL dashboard to update. This operation updates dashboard attributes only and does not modify widgets
namestringThe title of the dashboard that appears in list views and at the top of the dashboard page
tagsstring[]Tag labels to associate with the dashboard for organization and filtering
run_as_rolestringSets the Run as role for the dashboard. Must be 'viewer' (run as viewer) or 'owner' (run as owner). This determines whose permissions are used when executing queries
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Object PermissionsDATABRICKS_SQL_DBSQL_PERMISSIONS_GETAcciónTool to retrieve the access control list for a specified SQL object (alerts, dashboards, queries, or data_sources). Use when you need to check who has access to a SQL object and their permission levels. Note: This API is deprecated; use the Workspace API for new implementations.
DATABRICKS_SQL_DBSQL_PERMISSIONS_GETAcciónTool to retrieve the access control list for a specified SQL object (alerts, dashboards, queries, or data_sources). Use when you need to check who has access to a SQL object and their permission levels. Note: This API is deprecated; use the Workspace API for new implementations.
Parámetros de entrada
object_idstringObligatorioThe UUID identifying the specific object
object_typestringObligatorioThe type of object for which to retrieve permissions. Valid values: alerts, dashboards, queries, data_sources
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set SQL Object PermissionsDATABRICKS_SQL_DBSQL_PERMISSIONS_SETAcciónTool to set access control list for SQL objects (alerts, dashboards, queries, or data_sources). Use when you need to configure permissions for a SQL object. IMPORTANT: This operation REPLACES ALL existing permissions. To retain existing permissions, include them in the access_control_list. Note: This is a legacy/deprecated API; Databricks recommends using the Workspace API instead.
DATABRICKS_SQL_DBSQL_PERMISSIONS_SETAcciónTool to set access control list for SQL objects (alerts, dashboards, queries, or data_sources). Use when you need to configure permissions for a SQL object. IMPORTANT: This operation REPLACES ALL existing permissions. To retain existing permissions, include them in the access_control_list. Note: This is a legacy/deprecated API; Databricks recommends using the Workspace API instead.
Parámetros de entrada
object_idstringObligatorioUnique identifier of the SQL object for which to set permissions
object_typestringObligatorioenumType of SQL object. Valid values: alerts, dashboards, queries, data_sources
alertsdashboardsqueriesdata_sourcesaccess_control_listobject[]ObligatorioArray of access control entries. This operation REPLACES ALL existing permissions with the specified list. To retain existing permissions, include them in this array. Each entry must specify exactly one of user_name, group_name, or service_principal_name
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SQL QueryDATABRICKS_SQL_QUERIES_CREATEAcciónTool to create a saved SQL query object in Databricks. Use when you need to create a new saved query definition that includes the target SQL warehouse, query text, name, description, tags, and parameters. Note: This creates a saved query object, not an immediate execution. Use Statement Execution API for immediate query execution.
DATABRICKS_SQL_QUERIES_CREATEAcciónTool to create a saved SQL query object in Databricks. Use when you need to create a new saved query definition that includes the target SQL warehouse, query text, name, description, tags, and parameters. Note: This creates a saved query object, not an immediate execution. Use Statement Execution API for immediate query execution.
Parámetros de entrada
queryobjectQuery configuration object.
auto_resolve_display_namebooleanIf true, automatically resolve query display name conflicts. Otherwise, fail the request if the query's display name conflicts with an existing query's display name
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SQL QueryDATABRICKS_SQL_QUERIES_DELETEAcciónTool to delete a Databricks SQL query (soft delete to trash). Use when you need to remove a query from searches and list views. The query is moved to trash and can be restored through the UI within 30 days, after which it is permanently deleted.
DATABRICKS_SQL_QUERIES_DELETEAcciónTool to delete a Databricks SQL query (soft delete to trash). Use when you need to remove a query from searches and list views. The query is moved to trash and can be restored through the UI within 30 days, after which it is permanently deleted.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL query to delete. The query will be moved to trash (soft delete) and can be restored through the UI within 30 days
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Query DetailsDATABRICKS_SQL_QUERIES_GETAcciónTool to retrieve detailed information about a specific SQL query by its UUID. Use when you need to get query configuration including SQL text, warehouse ID, parameters, ownership, and metadata.
DATABRICKS_SQL_QUERIES_GETAcciónTool to retrieve detailed information about a specific SQL query by its UUID. Use when you need to get query configuration including SQL text, warehouse ID, parameters, ownership, and metadata.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL query to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Legacy SQL QueryDATABRICKS_SQL_QUERIES_LEGACY_CREATEAcciónTool to create a new SQL query definition using the legacy API. Use when you need to create queries with the legacy /preview/sql/queries endpoint that uses data_source_id. Note: This is a legacy endpoint. The API has been replaced by /api/2.0/sql/queries which uses warehouse_id instead of data_source_id.
DATABRICKS_SQL_QUERIES_LEGACY_CREATEAcciónTool to create a new SQL query definition using the legacy API. Use when you need to create queries with the legacy /preview/sql/queries endpoint that uses data_source_id. Note: This is a legacy endpoint. The API has been replaced by /api/2.0/sql/queries which uses warehouse_id instead of data_source_id.
Parámetros de entrada
namestringThe title/display name of the query that appears in list views, widget headings, and on the query page
querystringObligatorioThe text of the SQL query to be executed
optionsobjectQuery configuration options for legacy SQL queries.
is_draftbooleanWhether this query is a draft. Queries are created as drafts by default (true)
schedulestringExecution schedule interval in seconds, if the query should run on a schedule
descriptionstringGeneral description that conveys additional information about this query such as usage notes
is_archivedbooleanWhether this query is archived/hidden from indexes and search results
data_source_idstringObligatorioThe ID of the data source (SQL warehouse) used by the query. This is a required parameter for the legacy API
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Legacy SQL QueryDATABRICKS_SQL_QUERIES_LEGACY_DELETEAcciónTool to delete a legacy SQL query (soft delete to trash). Use when you need to remove a legacy query from searches and list views. The query is moved to trash and permanently deleted after 30 days. Note: This is a deprecated legacy API that will be phased out; use the non-legacy endpoint instead.
DATABRICKS_SQL_QUERIES_LEGACY_DELETEAcciónTool to delete a legacy SQL query (soft delete to trash). Use when you need to remove a legacy query from searches and list views. The query is moved to trash and permanently deleted after 30 days. Note: This is a deprecated legacy API that will be phased out; use the non-legacy endpoint instead.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL query to delete. The query will be moved to trash (soft delete) and permanently deleted after 30 days
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Legacy SQL QueryDATABRICKS_SQL_QUERIES_LEGACY_GETAcciónTool to retrieve details of a specific legacy SQL query by its UUID. Use when you need to get information about a legacy query including its SQL text, parameters, configuration, and metadata. Note: This is a legacy endpoint (/api/2.0/preview/sql/queries) that has been replaced by /api/2.0/sql/queries and will be supported for six months to allow migration time.
DATABRICKS_SQL_QUERIES_LEGACY_GETAcciónTool to retrieve details of a specific legacy SQL query by its UUID. Use when you need to get information about a legacy query including its SQL text, parameters, configuration, and metadata. Note: This is a legacy endpoint (/api/2.0/preview/sql/queries) that has been replaced by /api/2.0/sql/queries and will be supported for six months to allow migration time.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL query to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Restore SQL Query (Legacy)DATABRICKS_SQL_QUERIES_LEGACY_RESTOREAcciónTool to restore a trashed SQL query to active state. Use when you need to recover a deleted query within 30 days of deletion. Once restored, the query reappears in list views and searches and can be used for alerts again. This is a legacy/deprecated API endpoint.
DATABRICKS_SQL_QUERIES_LEGACY_RESTOREAcciónTool to restore a trashed SQL query to active state. Use when you need to recover a deleted query within 30 days of deletion. Once restored, the query reappears in list views and searches and can be used for alerts again. This is a legacy/deprecated API endpoint.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SQL query to restore from trash. The query must be in trash state and not permanently deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Legacy SQL QueryDATABRICKS_SQL_QUERIES_LEGACY_UPDATEAcciónTool to update an existing SQL query definition using the legacy API. Use when you need to modify queries with the legacy /preview/sql/queries endpoint. Note: This is a legacy/deprecated endpoint. The newer API uses PATCH /api/2.0/sql/queries/{id} instead.
DATABRICKS_SQL_QUERIES_LEGACY_UPDATEAcciónTool to update an existing SQL query definition using the legacy API. Use when you need to modify queries with the legacy /preview/sql/queries endpoint. Note: This is a legacy/deprecated endpoint. The newer API uses PATCH /api/2.0/sql/queries/{id} instead.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL query to update
namestringThe title/display name of the query that appears in list views, widget headings, and on the query page
tagsstring[]Tags for the query
querystringThe text of the SQL query to be executed
parentstringThe identifier of the workspace folder containing the object
optionsobjectQuery configuration options for legacy SQL queries.
descriptionstringGeneral description that conveys additional information about this query such as usage notes
run_as_rolestringSets the Run as role for the object. Must be set to one of 'viewer' (run as viewer) or 'owner' (run as owner)
data_source_idstringData source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SQL QueryDATABRICKS_SQL_QUERIES_UPDATEAcciónTool to update a saved SQL query object in Databricks using partial field updates. Use when you need to modify specific fields of an existing query without replacing the entire object. Requires update_mask parameter to specify which fields to update. Supports updating query text, configuration, parameters, and metadata.
DATABRICKS_SQL_QUERIES_UPDATEAcciónTool to update a saved SQL query object in Databricks using partial field updates. Use when you need to modify specific fields of an existing query without replacing the entire object. Requires update_mask parameter to specify which fields to update. Supports updating query text, configuration, parameters, and metadata.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the SQL query to update
queryobjectQuery configuration object for update operation.
update_maskstringObligatorioComma-separated list of fields to update with NO spaces. Use dot notation for nested fields (e.g., 'display_name,description,query_text'). Specify only the fields you want to update
auto_resolve_display_namebooleanIf true, automatically resolve query display name conflicts. If false or not specified, the request fails on naming conflicts
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SQL Query HistoryDATABRICKS_SQL_QUERY_HISTORY_LISTAcciónTool to retrieve the history of SQL queries executed against SQL warehouses and serverless compute. Use when you need to list queries by time range, status, user, or warehouse. Returns most recently started queries first (up to max_results). Supports filtering and pagination.
DATABRICKS_SQL_QUERY_HISTORY_LISTAcciónTool to retrieve the history of SQL queries executed against SQL warehouses and serverless compute. Use when you need to list queries by time range, status, user, or warehouse. Returns most recently started queries first (up to max_results). Supports filtering and pagination.
Parámetros de entrada
filter_byobjectFilter object to limit query history results.
page_tokenstringToken to get the next page of results. Obtained from previous response for pagination
max_resultsintegerLimit the number of results returned in one page. Must be less than 1000. Defaults to 100
include_metricsbooleanWhether to include query metrics with each query. Recommended for small result sets only due to response size. Defaults to false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SQL Query VisualizationDATABRICKS_SQL_QUERY_VISUALIZATIONS_CREATEAcciónTool to create a new visualization for a Databricks SQL query. Use when you need to add a visual representation (table, chart, counter, funnel, or pivot table) to an existing saved query. The visualization will be attached to the specified query and can be added to dashboards.
DATABRICKS_SQL_QUERY_VISUALIZATIONS_CREATEAcciónTool to create a new visualization for a Databricks SQL query. Use when you need to add a visual representation (table, chart, counter, funnel, or pivot table) to an existing saved query. The visualization will be attached to the specified query and can be added to dashboards.
Parámetros de entrada
visualizationobjectObligatorioThe visualization configuration object containing all visualization settings
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Legacy SQL Query VisualizationDATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_CREATEAcciónTool to create a visualization in a SQL query using the legacy API. Use when you need to add a visual representation (table, chart, counter, pivot, etc.) to an existing saved query. Note: This is a deprecated endpoint; users should migrate to the current /api/2.0/sql/visualizations API. Databricks does not recommend modifying visualization settings in JSON.
DATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_CREATEAcciónTool to create a visualization in a SQL query using the legacy API. Use when you need to add a visual representation (table, chart, counter, pivot, etc.) to an existing saved query. Note: This is a deprecated endpoint; users should migrate to the current /api/2.0/sql/visualizations API. Databricks does not recommend modifying visualization settings in JSON.
Parámetros de entrada
namestringThe name of the visualization that appears on dashboards and the query screen
typestringObligatorioThe type/category of visualization (e.g., CHART, TABLE, PIVOT, COUNTER, etc.)
optionsobjectObligatorioVisualization-specific configuration object that varies widely depending on the visualization type. Databricks does not recommend modifying this object directly in JSON as its structure is unsupported and varies by visualization type
query_idstringObligatorioThe identifier of the query to which the visualization will be added. This identifier is obtained from the queries/create endpoint
descriptionstringA short description of the visualization. This is not displayed in the UI
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Legacy SQL Query VisualizationDATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_DELETEAcciónTool to permanently delete a legacy SQL query visualization. Use when you need to remove a visualization from a SQL query using the legacy API endpoint. Note: This is a deprecated legacy endpoint. Databricks recommends migrating to /api/2.0/sql/visualizations/{id} instead.
DATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_DELETEAcciónTool to permanently delete a legacy SQL query visualization. Use when you need to remove a visualization from a SQL query using the legacy API endpoint. Note: This is a deprecated legacy endpoint. Databricks recommends migrating to /api/2.0/sql/visualizations/{id} instead.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID) of the visualization to permanently delete. This is the widget/visualization ID returned by the queryvisualizations/create endpoint
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Legacy SQL Query VisualizationDATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_UPDATEAcciónTool to update a visualization in a SQL query using the legacy API. Use when you need to modify visualization properties such as name, description, type, and options. Note: This is a deprecated endpoint; users should migrate to the current queryvisualizations/update method. Databricks does not recommend modifying visualization settings in JSON.
DATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_UPDATEAcciónTool to update a visualization in a SQL query using the legacy API. Use when you need to modify visualization properties such as name, description, type, and options. Note: This is a deprecated endpoint; users should migrate to the current queryvisualizations/update method. Databricks does not recommend modifying visualization settings in JSON.
Parámetros de entrada
idstringObligatorioThe UUID identifier of the visualization to update
namestringThe name of the visualization that appears on dashboards and the query screen
typestringThe type of visualization: chart, table, pivot table, and so on
optionsobjectThe options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying this
descriptionstringA short description of this visualization. This is not displayed in the UI
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SQL Query VisualizationDATABRICKS_SQL_QUERY_VISUALIZATIONS_UPDATEAcciónTool to update an existing Databricks SQL query visualization using partial update with field mask. Use when you need to modify visualization properties such as display name, description, type, or query attachment.
DATABRICKS_SQL_QUERY_VISUALIZATIONS_UPDATEAcciónTool to update an existing Databricks SQL query visualization using partial update with field mask. Use when you need to modify visualization properties such as display name, description, type, or query attachment.
Parámetros de entrada
idstringObligatorioUUID identifying the visualization to update
update_maskstringObligatorioComma-separated field names to update (no spaces). Use dot notation for nested fields. Field names must match resource field names exactly. Do not use wildcards (*)
visualizationobjectVisualization object containing fields to update.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Redash V2 ConfigDATABRICKS_SQL_REDASH_CONFIG_GET_CONFIGAcciónTool to retrieve workspace configuration for Redash V2 in Databricks SQL. Use when you need to get Redash configuration settings for the current workspace.
DATABRICKS_SQL_REDASH_CONFIG_GET_CONFIGAcciónTool to retrieve workspace configuration for Redash V2 in Databricks SQL. Use when you need to get Redash configuration settings for the current workspace.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Cancel SQL Statement ExecutionDATABRICKS_SQL_STATEMENT_EXECUTION_CANCEL_EXECUTIONAcciónTool to cancel an executing SQL statement on a Databricks warehouse. Use when you need to terminate a running SQL query. The response indicates successful receipt of the cancel request, but does not guarantee cancellation. Callers must poll the statement status to confirm the terminal state (CANCELED, SUCCEEDED, FAILED, or CLOSED).
DATABRICKS_SQL_STATEMENT_EXECUTION_CANCEL_EXECUTIONAcciónTool to cancel an executing SQL statement on a Databricks warehouse. Use when you need to terminate a running SQL query. The response indicates successful receipt of the cancel request, but does not guarantee cancellation. Callers must poll the statement status to confirm the terminal state (CANCELED, SUCCEEDED, FAILED, or CLOSED).
Parámetros de entrada
statement_idstringObligatorioThe statement ID returned upon successfully submitting a SQL statement. Required reference for canceling the execution.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SQL WarehouseDATABRICKS_SQL_WAREHOUSES_DELETEAcciónTool to delete a SQL warehouse from the Databricks workspace. Use when you need to permanently remove a SQL compute resource. Deleted warehouses may be restored within 14 days by contacting Databricks support.
DATABRICKS_SQL_WAREHOUSES_DELETEAcciónTool to delete a SQL warehouse from the Databricks workspace. Use when you need to permanently remove a SQL compute resource. Deleted warehouses may be restored within 14 days by contacting Databricks support.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SQL warehouse to delete. This is the warehouse ID that can be obtained from listing warehouses
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit SQL WarehouseDATABRICKS_SQL_WAREHOUSES_EDITAcciónTool to update the configuration of an existing SQL warehouse. Use when you need to modify warehouse settings like cluster size, scaling parameters, auto-stop behavior, or enable features like Photon acceleration and serverless compute. The warehouse is identified by its ID, and you can update various properties including resource allocation and performance optimizations.
DATABRICKS_SQL_WAREHOUSES_EDITAcciónTool to update the configuration of an existing SQL warehouse. Use when you need to modify warehouse settings like cluster size, scaling parameters, auto-stop behavior, or enable features like Photon acceleration and serverless compute. The warehouse is identified by its ID, and you can update various properties including resource allocation and performance optimizations.
Parámetros de entrada
idstringObligatorioRequired. The warehouse ID to edit/configure
namestringLogical name for the warehouse. Must be unique within the workspace and less than 100 characters
tagsobjectTags for the warehouse.
channelobjectChannel information for the warehouse.
cluster_sizestringSize of the clusters allocated for this warehouse. Available sizes: 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large
creator_namestringWarehouse creator name
enable_photonbooleanConfigures whether the warehouse should use Photon optimized clusters. Defaults to false
auto_stop_minsintegerThe amount of time in minutes that a SQL warehouse must be idle (no RUNNING queries) before it is automatically stopped. Supports values == 0 or >= 10 mins. Defaults to 120 mins. Note: Using the API, you can set this as low as 1 minute for serverless warehouses
warehouse_typestringenumSQL warehouse type designation. PRO is required for serverless compute
PROCLASSICTYPE_UNSPECIFIEDmax_num_clustersintegerMaximum number of clusters that the autoscaler will create to handle concurrent queries. Must be <= 40 and must exceed min_num_clusters
min_num_clustersintegerMinimum number of available clusters that will be maintained for this SQL warehouse. Must be > 0 and <= min(max_num_clusters, 30). Defaults to 1
instance_profile_arnstring(Deprecated) AWS only - The instance profile used to pass an IAM role to the SQL warehouse
spot_instance_policystringenumConfigurations for spot instance usage. COST_OPTIMIZED uses spot instances when possible, RELIABILITY_OPTIMIZED uses on-demand instances
COST_OPTIMIZEDRELIABILITY_OPTIMIZEDPOLICY_UNSPECIFIEDenable_serverless_computebooleanConfigures whether the warehouse should use serverless compute
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Warehouse DetailsDATABRICKS_SQL_WAREHOUSES_GETAcciónTool to retrieve detailed information about a specific SQL warehouse by its ID. Use when you need to get configuration, state, connection details, and resource allocation for a SQL warehouse. Returns comprehensive warehouse information including cluster settings, JDBC/ODBC connection strings, and health status.
DATABRICKS_SQL_WAREHOUSES_GETAcciónTool to retrieve detailed information about a specific SQL warehouse by its ID. Use when you need to get configuration, state, connection details, and resource allocation for a SQL warehouse. Returns comprehensive warehouse information including cluster settings, JDBC/ODBC connection strings, and health status.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SQL warehouse to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Warehouse Permission LevelsDATABRICKS_SQL_WAREHOUSES_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks SQL warehouse. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific SQL warehouse. Returns permission levels like CAN_USE, CAN_MANAGE, IS_OWNER, CAN_VIEW, and CAN_MONITOR with their descriptions.
DATABRICKS_SQL_WAREHOUSES_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks SQL warehouse. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific SQL warehouse. Returns permission levels like CAN_USE, CAN_MANAGE, IS_OWNER, CAN_VIEW, and CAN_MONITOR with their descriptions.
Parámetros de entrada
warehouse_idstringObligatorioThe unique identifier of the SQL warehouse for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SQL Warehouse PermissionsDATABRICKS_SQL_WAREHOUSES_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks SQL warehouse. Use when you need to check who has access to a specific SQL warehouse and their permission levels. Returns the access control list with user, group, and service principal permissions, including inherited permissions from parent objects.
DATABRICKS_SQL_WAREHOUSES_GET_PERMISSIONSAcciónTool to retrieve permissions for a Databricks SQL warehouse. Use when you need to check who has access to a specific SQL warehouse and their permission levels. Returns the access control list with user, group, and service principal permissions, including inherited permissions from parent objects.
Parámetros de entrada
warehouse_idstringObligatorioThe unique identifier (UUID) of the SQL warehouse for which to retrieve permissions
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace Warehouse ConfigDATABRICKS_SQL_WAREHOUSES_GET_WORKSPACE_WAREHOUSE_CONFIGAcciónTool to retrieve workspace-level SQL warehouse configuration settings. Use when you need to check security policies, serverless compute settings, channel versions, or warehouse type restrictions that apply to all SQL warehouses in the workspace.
DATABRICKS_SQL_WAREHOUSES_GET_WORKSPACE_WAREHOUSE_CONFIGAcciónTool to retrieve workspace-level SQL warehouse configuration settings. Use when you need to check security policies, serverless compute settings, channel versions, or warehouse type restrictions that apply to all SQL warehouses in the workspace.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set SQL Warehouse PermissionsDATABRICKS_SQL_WAREHOUSES_SET_PERMISSIONSAcciónTool to set permissions for a Databricks SQL warehouse, replacing all existing permissions. Use when you need to configure access control for a SQL warehouse. This operation is authoritative and overwrites all existing permissions. Exactly one IS_OWNER must be specified. Groups cannot have IS_OWNER permission.
DATABRICKS_SQL_WAREHOUSES_SET_PERMISSIONSAcciónTool to set permissions for a Databricks SQL warehouse, replacing all existing permissions. Use when you need to configure access control for a SQL warehouse. This operation is authoritative and overwrites all existing permissions. Exactly one IS_OWNER must be specified. Groups cannot have IS_OWNER permission.
Parámetros de entrada
warehouse_idstringObligatorioThe unique identifier (UUID) of the SQL warehouse for which to set permissions
access_control_listobject[]ObligatorioArray of access control entries. This operation is authoritative and replaces ALL existing permissions. Must include exactly one IS_OWNER permission. For each entry, specify only one of user_name, group_name, or service_principal_name
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Workspace Warehouse ConfigDATABRICKS_SQL_WAREHOUSES_SET_WORKSPACE_WAREHOUSE_CONFIGAcciónTool to configure workspace-level SQL warehouse settings shared by all SQL warehouses. Use when you need to set security policies, enable serverless compute, configure channel versions, or manage warehouse type restrictions across the workspace.
DATABRICKS_SQL_WAREHOUSES_SET_WORKSPACE_WAREHOUSE_CONFIGAcciónTool to configure workspace-level SQL warehouse settings shared by all SQL warehouses. Use when you need to set security policies, enable serverless compute, configure channel versions, or manage warehouse type restrictions across the workspace.
Parámetros de entrada
channelobjectChannel information for SQL warehouses.
security_policystringenumSecurity policy for warehouses. DATA_ACCESS_CONTROL enforces role-based access restrictions, NONE applies no restrictions, PASSTHROUGH allows credentials to pass through to underlying data sources
DATA_ACCESS_CONTROLNONEPASSTHROUGHdata_access_configobject[]Spark confs for external hive metastore configuration. JSON serialized size must be less than or equal to 512K
instance_profile_arnstringAWS Only - The instance profile used to pass an IAM role to the SQL warehouses
google_service_accountstringGCP only - Google Service Account used to pass to cluster to access Google Cloud Storage
enabled_warehouse_typesobject[]List of warehouse types allowed in this workspace. Limits allowed values for the type field in CreateWarehouse and EditWarehouse. Disabling a type may cause existing warehouses to be converted to another type
enable_serverless_computebooleanEnable Serverless compute for SQL warehouses
sql_configuration_parametersobjectSQL configuration parameters for warehouses.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Start SQL WarehouseDATABRICKS_SQL_WAREHOUSES_STARTAcciónTool to start a stopped Databricks SQL warehouse asynchronously. Use when you need to restart a stopped warehouse. The warehouse transitions through STARTING state before reaching RUNNING. Requires CAN MONITOR permissions or higher.
DATABRICKS_SQL_WAREHOUSES_STARTAcciónTool to start a stopped Databricks SQL warehouse asynchronously. Use when you need to restart a stopped warehouse. The warehouse transitions through STARTING state before reaching RUNNING. Requires CAN MONITOR permissions or higher.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SQL warehouse to start. This is the string of letters and numbers in the warehouse's HTTP path. If the warehouse is already running, the request has no effect.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SQL Warehouse PermissionsDATABRICKS_SQL_WAREHOUSES_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for a Databricks SQL warehouse. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request. For replacing all permissions, use SetPermissions instead.
DATABRICKS_SQL_WAREHOUSES_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions for a Databricks SQL warehouse. Use when you need to modify specific permissions without replacing the entire permission set. This PATCH operation updates only the specified permissions, preserving existing permissions not included in the request. For replacing all permissions, use SetPermissions instead.
Parámetros de entrada
warehouse_idstringObligatorioThe unique identifier (UUID) of the SQL warehouse for which to update permissions
access_control_listobject[]ObligatorioArray of access control entries to update. This operation updates only the specified permissions incrementally, preserving existing permissions not included in the request. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified. Note: PATCH requests containing a warehouse owner (IS_OWNER) will be rejected with a NOT_IMPLEMENTED error
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Submit One-Time RunDATABRICKS_SUBMIT_RUNAcciónTool to submit a one-time run without creating a job. Use when you need to execute a task directly without saving it as a job definition. After submission, use the jobs/runs/get API with the returned run_id to check the run state and monitor progress.
DATABRICKS_SUBMIT_RUNAcciónTool to submit a one-time run without creating a job. Use when you need to execute a task directly without saving it as a job definition. After submission, use the jobs/runs/get API with the returned run_id to check the run state and monitor progress.
Parámetros de entrada
tasksobject[]ObligatorioList of tasks to execute in the run. At least one task is required
run_namestringName for the run (default: 'Untitled')
librariesobject[]Libraries to install on cluster (default: empty list)
new_clusterobjectCluster specification to create for each run.
environmentsobject[]List of environment configurations for the run
timeout_secondsintegerTimeout per run (default: no timeout)
idempotency_tokenstringToken (max 64 characters) to guarantee idempotency
existing_cluster_idstringID of an existing cluster to use for all tasks
notification_settingsobjectEmail and webhook notification preferences.
webhook_notificationsobjectSystem destinations for run state changes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Tag PolicyDATABRICKS_TAGS_TAG_POLICIES_CREATE_TAG_POLICYAcciónTool to create a new tag policy (governed tag) in Databricks with built-in rules for consistency and control. Use when you need to establish governed tags with restricted values and define who can assign them. Maximum of 1,000 governed tags per account. Each governed tag can have up to 50 allowed values. Requires appropriate account-level permissions.
DATABRICKS_TAGS_TAG_POLICIES_CREATE_TAG_POLICYAcciónTool to create a new tag policy (governed tag) in Databricks with built-in rules for consistency and control. Use when you need to establish governed tags with restricted values and define who can assign them. Maximum of 1,000 governed tags per account. Each governed tag can have up to 50 allowed values. Requires appropriate account-level permissions.
Parámetros de entrada
valuesobject[]One or more allowed values for the tag. Only these values can be assigned to this tag key. Maximum of 50 allowed values per governed tag. Each value must be a TagValue object with a 'name' field
tag_keystringObligatorioThe tag key name (case sensitive). This is the governed tag identifier. No special characters are allowed. Tag keys must be unique within the account
descriptionstringA description or explanation for the governed tag policy
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Tag PolicyDATABRICKS_TAGS_TAG_POLICIES_DELETE_TAG_POLICYAcciónTool to delete a tag policy by its key, making the tag ungoverned. Use when you need to remove governance from a tag without deleting the tag itself. Requires MANAGE permission on the governed tag. System governed tags cannot be deleted.
DATABRICKS_TAGS_TAG_POLICIES_DELETE_TAG_POLICYAcciónTool to delete a tag policy by its key, making the tag ungoverned. Use when you need to remove governance from a tag without deleting the tag itself. Requires MANAGE permission on the governed tag. System governed tags cannot be deleted.
Parámetros de entrada
tag_keystringObligatorioThe key of the governed tag whose policy should be removed. This is the unique identifier for the tag policy to delete. When deleted, the tag becomes ungoverned but remains on objects
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Tag PolicyDATABRICKS_TAGS_TAG_POLICIES_GET_TAG_POLICYAcciónTool to retrieve a specific tag policy by its associated governed tag's key. Use when you need to get details about tag governance policies including allowed values and metadata.
DATABRICKS_TAGS_TAG_POLICIES_GET_TAG_POLICYAcciónTool to retrieve a specific tag policy by its associated governed tag's key. Use when you need to get details about tag governance policies including allowed values and metadata.
Parámetros de entrada
tag_keystringObligatorioThe unique key identifier of the governed tag whose policy you want to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Tag PolicyDATABRICKS_TAGS_TAG_POLICIES_UPDATE_TAG_POLICYAcciónTool to update an existing tag policy (governed tag) with specified fields. Use when you need to modify tag policy properties like description, tag key, or allowed values. Users must have MANAGE permission on the governed tag to edit it.
DATABRICKS_TAGS_TAG_POLICIES_UPDATE_TAG_POLICYAcciónTool to update an existing tag policy (governed tag) with specified fields. Use when you need to modify tag policy properties like description, tag key, or allowed values. Users must have MANAGE permission on the governed tag to edit it.
Parámetros de entrada
valuesobject[]A collection of allowed values for the tag. Each governed tag can have a maximum of 50 allowed values
tag_keystringObligatorioThe tag key name (identifier) of the tag policy to update. Tag keys are case sensitive (e.g., 'Sales' and 'sales' are distinct). Tag keys can only contain letters, spaces, numbers, or the characters +, -, =, ., _, :, /, @. Note: tag_key is immutable and cannot be changed after creation
descriptionstringA text field describing the policy
update_maskstringObligatorioA field mask specifying which fields to update. Must be a single string with multiple fields separated by commas (no spaces). Uses dot notation for nested fields (e.g., 'description,values'). Valid updatable fields are 'description' and 'values'. A field mask of '*' indicates full replacement, though explicitly listing fields is recommended
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update GroupDATABRICKS_UPDATE_GROUPAcciónTool to update a Databricks group using SCIM 2.0 PATCH operations. Use when you need to modify group properties like displayName, add/remove members, or update roles.
DATABRICKS_UPDATE_GROUPAcciónTool to update a Databricks group using SCIM 2.0 PATCH operations. Use when you need to modify group properties like displayName, add/remove members, or update roles.
Parámetros de entrada
idstringObligatorioUnique ID of the group in the Databricks workspace
Operationsobject[]ObligatorioArray of PATCH operations to apply. All operations are atomic - if any fails, all are rolled back. Maximum of 5000 members per group.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Group CopyDATABRICKS_UPDATE_GROUP_COPYAcciónTool to delete a group from Databricks workspace using SCIM v2 protocol. Use when you need to remove a group resource. Users in the group are not removed when the group is deleted.
DATABRICKS_UPDATE_GROUP_COPYAcciónTool to delete a group from Databricks workspace using SCIM v2 protocol. Use when you need to remove a group resource. Users in the group are not removed when the group is deleted.
Parámetros de entrada
idstringObligatorioUnique identifier of the group to delete. This is the Databricks-generated group ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Databricks Job By IDDATABRICKS_UPDATE_JOB_BY_IDAcciónTool to completely reset all settings for a Databricks job. Use when you need to overwrite all job configuration at once. Changes to timeout_seconds apply immediately to active runs; other changes apply to future runs only. Consider using the update endpoint for partial updates instead of reset to minimize disruption.
DATABRICKS_UPDATE_JOB_BY_IDAcciónTool to completely reset all settings for a Databricks job. Use when you need to overwrite all job configuration at once. Changes to timeout_seconds apply immediately to active runs; other changes apply to future runs only. Consider using the update endpoint for partial updates instead of reset to minimize disruption.
Parámetros de entrada
job_idintegerObligatorioThe canonical identifier of the job to reset. This field is required.
new_settingsobjectObligatorioThe new settings that completely replace all existing settings for the job. Changes to timeout_seconds apply to active runs; other changes apply to future runs only. Must include at least a cluster specification (existing_cluster_id or new_cluster) and a task type (notebook_task, spark_jar_task, etc.) or tasks array.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update User by ID (PATCH)DATABRICKS_UPDATE_USER_BY_ID_PATCHAcciónTool to update a Databricks user by applying SCIM 2.0 PATCH operations on specific user attributes. Use when you need to modify user properties like active status, displayName, entitlements, roles, or other user attributes.
DATABRICKS_UPDATE_USER_BY_ID_PATCHAcciónTool to update a Databricks user by applying SCIM 2.0 PATCH operations on specific user attributes. Use when you need to modify user properties like active status, displayName, entitlements, roles, or other user attributes.
Parámetros de entrada
idstringObligatorioUnique ID of the user in the Databricks workspace
Operationsobject[]ObligatorioArray of PATCH operations to apply. All operations execute sequentially and atomically - if any fails, all are rolled back.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Vector Search EndpointDATABRICKS_VECTORSEARCH_VECTOR_SEARCH_ENDPOINTS_CREATE_ENDPOINTAcciónTool to create a new vector search endpoint to host indexes in Databricks Mosaic AI Vector Search. Use when you need to provision compute resources for hosting vector search indexes. The endpoint will be in PROVISIONING state initially and transition to ONLINE when ready.
DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_ENDPOINTS_CREATE_ENDPOINTAcciónTool to create a new vector search endpoint to host indexes in Databricks Mosaic AI Vector Search. Use when you need to provision compute resources for hosting vector search indexes. The endpoint will be in PROVISIONING state initially and transition to ONLINE when ready.
Parámetros de entrada
namestringObligatorioName of the vector search endpoint. Must be unique within the workspace
endpoint_typestringObligatorioType of endpoint. Currently only STANDARD is supported
usage_policy_idstringThe id of the usage policy to assign to the endpoint
budget_policy_idstringThe id of the budget policy to assign to the endpoint. Deprecated, use usage_policy_id instead
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Vector Search IndexDATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_DELETE_INDEXAcciónTool to delete a vector search index from Databricks workspace. Use when you need to remove unused or obsolete vector search indexes. When an index is deleted, any associated writeback tables are automatically removed. This operation is irreversible.
DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_DELETE_INDEXAcciónTool to delete a vector search index from Databricks workspace. Use when you need to remove unused or obsolete vector search indexes. When an index is deleted, any associated writeback tables are automatically removed. This operation is irreversible.
Parámetros de entrada
index_namestringObligatorioThe fully qualified name of the vector search index to delete. Must be in the format: catalog.schema.index_name (e.g., 'test_catalog.test_schema.test_index'). Deleting an index will also automatically delete any associated writeback tables. This operation is irreversible.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Query Vector Search IndexDATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_QUERY_INDEXAcciónTool to query vector search index to find similar vectors and return associated documents. Use when performing similarity search, hybrid keyword-similarity search, or full-text search on Databricks Vector Search indexes. Supports filtering, reranking, and returns configurable columns from matched documents with similarity scores. Must provide either query_vector or query_text.
DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_QUERY_INDEXAcciónTool to query vector search index to find similar vectors and return associated documents. Use when performing similarity search, hybrid keyword-similarity search, or full-text search on Databricks Vector Search indexes. Supports filtering, reranking, and returns configurable columns from matched documents with similarity scores. Must provide either query_vector or query_text.
Parámetros de entrada
columnsstring[]ObligatorioList of column names to include in the response. These columns will be returned along with the similarity scores for matched documents
filtersobjectFilter conditions to apply to results. Use dictionary format for standard endpoints (e.g., {'field': value}), or SQL string format for storage-optimized endpoints (e.g., "field = 'value'")
rerankerobjectReranking configuration object.
index_namestringObligatorioName of the vector index to query. Use the full three-level name format (catalog.schema.index_name)
query_textstringText query to search with. Required for Delta Sync Index using model endpoint. Automatically converted to embeddings. Must provide either query_vector or query_text
query_typestringenumType of search to perform. ANN (default): Approximate nearest neighbor search. HYBRID: Combines keyword and similarity search. FULL_TEXT: Full-text search mode
ANNHYBRIDFULL_TEXTdebug_levelintegerSet to ≥1 to get latency information in response. Required for reranker timing information
num_resultsintegerObligatorioMaximum number of results to return. Maximum is 200 for hybrid search, 10,000 total retrievable with pagination
filters_jsonstringJSON string representing query filters (alternative format)
query_vectornumber[]Vector embeddings to search with. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors. Must provide either query_vector or query_text
score_thresholdnumberMinimum similarity score threshold for results. Defaults to 0.0. Only results with similarity scores above this threshold will be returned
columns_to_rerankstring[]Column names to retrieve data for sending to the reranker. This is used when reranking is desired but not using the reranker object
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upsert Data Vector IndexDATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_UPSERT_DATA_VECTOR_INDEXAcciónTool to upsert (insert or update) data into a Direct Vector Access Index. Use when you need to manually add or update vectors in a Databricks vector search index. The index must be a Direct Vector Access Index type where updates are managed via REST API or SDK calls. Data structure must match the schema defined when the index was created, including the primary key field.
DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_UPSERT_DATA_VECTOR_INDEXAcciónTool to upsert (insert or update) data into a Direct Vector Access Index. Use when you need to manually add or update vectors in a Databricks vector search index. The index must be a Direct Vector Access Index type where updates are managed via REST API or SDK calls. Data structure must match the schema defined when the index was created, including the primary key field.
Parámetros de entrada
vectorsobject[]ObligatorioArray of vector objects to upsert into the index. Each entry must contain an id (matching the primary key), vector array, and optional metadata fields that match the index schema
index_namestringObligatorioThe fully qualified name of the Direct Vector Access Index where data will be upserted. Must be in the format: catalog.schema.index_name (e.g., 'main.default.test_index'). The index must be a Direct Vector Access Index type, not a Delta Sync Index
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Workspace Git CredentialsDATABRICKS_WORKSPACE_GIT_CREDENTIALS_CREATEAcciónTool to create Git credentials for authenticating with remote Git repositories in Databricks. Use when you need to set up Git integration for version control operations. Only one credential per user is supported - attempts to create when one already exists will fail.
DATABRICKS_WORKSPACE_GIT_CREDENTIALS_CREATEAcciónTool to create Git credentials for authenticating with remote Git repositories in Databricks. Use when you need to set up Git integration for version control operations. Only one credential per user is supported - attempts to create when one already exists will fail.
Parámetros de entrada
namestringIdentifier used for looking up the git credential. Useful for organizing multiple credentials
git_emailstringThe authenticating email associated with your Git provider user account. Used for authentication with the remote repository and sets the author & committer identity for commits. Required for most providers except AWS CodeCommit
git_providerstringObligatorioenumThe Git provider name. Case-insensitive. Valid values include gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise, bitbucketServer, gitLabEnterpriseEdition, and awsCodeCommit
gitHubbitbucketCloudgitLabazureDevOpsServicesgitHubEnterprisebitbucketServergitLabEnterpriseEditionawsCodeCommitgit_usernamestringThe username provided with your Git provider account. Used to set the Git committer & author names for commits. Required for AWS CodeCommit
personal_access_tokenstringThe personal access token used to authenticate to the corresponding Git provider. Required for most providers
is_default_for_providerbooleanIf true, this credential serves as the default for the given provider. Only one credential can be default per provider
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Workspace Git CredentialsDATABRICKS_WORKSPACE_GIT_CREDENTIALS_DELETEAcciónTool to delete Git credentials for remote repository authentication in Databricks. Use when you need to remove a Git credential entry from the workspace. Only one Git credential per user is supported in Databricks, making this useful for credential lifecycle management when credentials need to be revoked or replaced.
DATABRICKS_WORKSPACE_GIT_CREDENTIALS_DELETEAcciónTool to delete Git credentials for remote repository authentication in Databricks. Use when you need to remove a Git credential entry from the workspace. Only one Git credential per user is supported in Databricks, making this useful for credential lifecycle management when credentials need to be revoked or replaced.
Parámetros de entrada
credential_idintegerObligatorioThe ID for the corresponding credential to delete. This is the unique identifier of the Git credential object in the workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace Git CredentialsDATABRICKS_WORKSPACE_GIT_CREDENTIALS_GETAcciónTool to retrieve Git credentials for authenticating with remote Git repositories in Databricks. Use when you need to get details of existing Git integration credentials by credential ID.
DATABRICKS_WORKSPACE_GIT_CREDENTIALS_GETAcciónTool to retrieve Git credentials for authenticating with remote Git repositories in Databricks. Use when you need to get details of existing Git integration credentials by credential ID.
Parámetros de entrada
credential_idintegerObligatorioThe ID for the corresponding credential to access. This is the unique identifier of the credential object in the workspace
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Workspace Git CredentialsDATABRICKS_WORKSPACE_GIT_CREDENTIALS_UPDATEAcciónTool to update existing Git credentials for authenticating with remote Git repositories in Databricks. Use when you need to modify Git provider credentials, email, username, or access tokens. Note that the git_provider field cannot be changed after initial creation. For azureDevOpsServicesAad provider, do not specify personal_access_token or git_username.
DATABRICKS_WORKSPACE_GIT_CREDENTIALS_UPDATEAcciónTool to update existing Git credentials for authenticating with remote Git repositories in Databricks. Use when you need to modify Git provider credentials, email, username, or access tokens. Note that the git_provider field cannot be changed after initial creation. For azureDevOpsServicesAad provider, do not specify personal_access_token or git_username.
Parámetros de entrada
namestringThe name of the git credential, used for identification and ease of lookup
git_emailstringThe authenticating email associated with your Git provider user account. Used for authentication with the remote repository and sets the author & committer identity for commits. Required for most Git providers except AWS CodeCommit
git_providerstringObligatorioenumThe Git provider name. Case-insensitive. This field cannot be changed after initial creation. Valid values include gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise, bitbucketServer, gitLabEnterpriseEdition, awsCodeCommit, and azureDevOpsServicesAad
gitHubbitbucketCloudgitLabazureDevOpsServicesgitHubEnterprisebitbucketServergitLabEnterpriseEditionawsCodeCommitazureDevOpsServicesAadgit_usernamestringThe username provided with your Git provider account. Used to set the Git committer & author names for commits. Required for AWS CodeCommit. For azureDevOpsServicesAad provider, do NOT specify this field
credential_idintegerObligatorioThe ID for the corresponding credential to access. This is the unique identifier of the credential object in the workspace
personal_access_tokenstringThe personal access token used to authenticate to the corresponding Git provider. For azureDevOpsServicesAad provider, do NOT specify this field. The token is stored securely and not returned in responses
is_default_for_providerbooleanFlag indicating if the credential is the default for the given provider. Only one credential can be default per provider
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Workspace DirectoryDATABRICKS_WORKSPACE_LISTAcciónTool to list the contents of a directory in Databricks workspace. Use when you need to view notebooks, files, directories, libraries, or repos at a specific path. Returns object information including paths, types, and metadata. Use object_id for setting permissions via the Permissions API.
DATABRICKS_WORKSPACE_LISTAcciónTool to list the contents of a directory in Databricks workspace. Use when you need to view notebooks, files, directories, libraries, or repos at a specific path. Returns object information including paths, types, and metadata. Use object_id for setting permissions via the Permissions API.
Parámetros de entrada
pathstringObligatorioThe absolute path of the notebook or directory to list. Must be an absolute path starting with '/'
recursivebooleanWhether to recursively traverse subdirectories. Defaults to false
notebooks_modified_afterintegerUTC timestamp in milliseconds to filter notebooks modified after this time
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Workspace RepoDATABRICKS_WORKSPACE_REPOS_CREATEAcciónTool to create and optionally checkout a Databricks Repo linking a Git repository to the workspace. Use when you need to connect a Git repository to Databricks for collaborative development. Can optionally specify branch or tag to checkout after creation and configure sparse checkout for performance.
DATABRICKS_WORKSPACE_REPOS_CREATEAcciónTool to create and optionally checkout a Databricks Repo linking a Git repository to the workspace. Use when you need to connect a Git repository to Databricks for collaborative development. Can optionally specify branch or tag to checkout after creation and configure sparse checkout for performance.
Parámetros de entrada
tagstringName of existing Git tag to checkout after creation
urlstringObligatorioHTTPS URL of a Git repository to be linked
pathstringDesired path for the repo in the workspace. Almost any path in the workspace can be chosen. If repo is created in /Repos, path must be in the format /Repos/{folder}/{repo-name}. If not specified, it will be created in the user's directory
branchstringName of existing Git branch to checkout after creation
providerstringenumGit provider name. Case-insensitive. Must be provided if cannot be guessed from URL. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit
gitHubgitHubEnterprisebitbucketCloudbitbucketServerazureDevOpsServicesgitLabgitLabEnterpriseEditionawsCodeCommitsparse_checkoutobjectConfiguration for sparse checkout.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Workspace RepoDATABRICKS_WORKSPACE_REPOS_DELETEAcciónTool to delete a Git repository from Databricks workspace. Use when you need to permanently remove a repository. The repository cannot be recovered after deletion completes successfully.
DATABRICKS_WORKSPACE_REPOS_DELETEAcciónTool to delete a Git repository from Databricks workspace. Use when you need to permanently remove a repository. The repository cannot be recovered after deletion completes successfully.
Parámetros de entrada
repo_idstringObligatorioThe unique numeric identifier of the repository to delete. This ID can be obtained by listing repos or getting repo details
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace Repo Permission LevelsDATABRICKS_WORKSPACE_REPOS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks workspace repository. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific Git repository. Returns permission levels like CAN_READ, CAN_RUN, CAN_EDIT, and CAN_MANAGE with their descriptions.
DATABRICKS_WORKSPACE_REPOS_GET_PERMISSION_LEVELSAcciónTool to retrieve available permission levels for a Databricks workspace repository. Use when you need to understand what permission levels can be assigned to users, groups, or service principals for a specific Git repository. Returns permission levels like CAN_READ, CAN_RUN, CAN_EDIT, and CAN_MANAGE with their descriptions.
Parámetros de entrada
repo_idstringObligatorioThe unique identifier of the repository for which to retrieve available permission levels
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Workspace Repo PermissionsDATABRICKS_WORKSPACE_REPOS_SET_PERMISSIONSAcciónTool to set permissions for a workspace repository, replacing all existing permissions. Use when you need to configure access control for a workspace repo. This operation replaces ALL existing permissions; admin users cannot have their permissions lowered. Repos can inherit permissions from their root object.
DATABRICKS_WORKSPACE_REPOS_SET_PERMISSIONSAcciónTool to set permissions for a workspace repository, replacing all existing permissions. Use when you need to configure access control for a workspace repo. This operation replaces ALL existing permissions; admin users cannot have their permissions lowered. Repos can inherit permissions from their root object.
Parámetros de entrada
repo_idstringObligatorioThe identifier of the repository for which to set permissions
access_control_listobject[]Array of access control entries. This replaces ALL existing permissions. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified. When omitted or empty, all direct permissions are removed
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Workspace RepoDATABRICKS_WORKSPACE_REPOS_UPDATEAcciónTool to update a workspace repo to a different branch or tag. Use when you need to switch branches, pull latest changes, or update sparse checkout settings. When updating to a tag, the repo enters a detached HEAD state and must be switched back to a branch before committing.
DATABRICKS_WORKSPACE_REPOS_UPDATEAcciónTool to update a workspace repo to a different branch or tag. Use when you need to switch branches, pull latest changes, or update sparse checkout settings. When updating to a tag, the repo enters a detached HEAD state and must be switched back to a branch before committing.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Git folder (repo) object in the workspace
tagstringTag name that the local version of the repo should be checked out to. Updating the repo to a tag puts the repo in a detached HEAD state. Before committing new changes, you must update the repo to a branch. Exactly one of 'branch' or 'tag' must be specified
branchstringBranch name that the local version of the repo should be checked out to. If this refers to the currently checked out branch, Databricks performs a pull operation to update to the latest commit. Exactly one of 'branch' or 'tag' must be specified
sparse_checkoutobjectConfiguration for sparse checkout.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Workspace Repo PermissionsDATABRICKS_WORKSPACE_REPOS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks workspace repository. Use when you need to modify specific permissions for users, groups, or service principals without replacing the entire permission set. This PATCH operation only modifies the permissions specified while leaving other existing permissions intact. Repos can inherit permissions from their root object.
DATABRICKS_WORKSPACE_REPOS_UPDATE_PERMISSIONSAcciónTool to incrementally update permissions on a Databricks workspace repository. Use when you need to modify specific permissions for users, groups, or service principals without replacing the entire permission set. This PATCH operation only modifies the permissions specified while leaving other existing permissions intact. Repos can inherit permissions from their root object.
Parámetros de entrada
repo_idstringObligatorioThe unique identifier of the repository to update permissions for
access_control_listobject[]ObligatorioList of access control entries to update. This operation updates permissions incrementally without replacing existing permissions. At least one access control entry is required. For each entry, exactly one of user_name, group_name, or service_principal_name must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Secret ScopeDATABRICKS_WORKSPACE_SECRETS_CREATE_SCOPEAcciónTool to create a new secret scope in Databricks workspace. Use when you need to establish a secure location to store credentials and sensitive information. Scope names must be unique, case-insensitive, and cannot exceed 128 characters. By default, the scope is Databricks-backed with MANAGE permission for the creator.
DATABRICKS_WORKSPACE_SECRETS_CREATE_SCOPEAcciónTool to create a new secret scope in Databricks workspace. Use when you need to establish a secure location to store credentials and sensitive information. Scope names must be unique, case-insensitive, and cannot exceed 128 characters. By default, the scope is Databricks-backed with MANAGE permission for the creator.
Parámetros de entrada
scopestringObligatorioThe name of the secret scope to create. Must be unique within the workspace, consist of alphanumeric characters, dashes, underscores, @, and periods, and cannot exceed 128 characters. Case insensitive
scope_backend_typestringenumThe backend type for the scope. DATABRICKS (default) stores secrets in Databricks' own storage. AZURE_KEYVAULT is for Azure deployments. If not specified, defaults to DATABRICKS
DATABRICKSAZURE_KEYVAULTbackend_azure_keyvaultobjectAzure Key Vault backend configuration for secret scope.
initial_manage_principalstringThe principal that is initially granted MANAGE permission to the created scope. The only supported value is 'users', which contains all users in the workspace. If not specified, the API request issuer's user identity receives MANAGE permission
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Secrets ACLDATABRICKS_WORKSPACE_SECRETS_DELETE_ACLAcciónTool to delete an access control list from a Databricks secret scope. Use when you need to revoke permissions for a principal on a secret scope. Requires MANAGE permission on the scope. Fails if the ACL does not exist.
DATABRICKS_WORKSPACE_SECRETS_DELETE_ACLAcciónTool to delete an access control list from a Databricks secret scope. Use when you need to revoke permissions for a principal on a secret scope. Requires MANAGE permission on the scope. Fails if the ACL does not exist.
Parámetros de entrada
scopestringObligatorioThe name of the secret scope from which to revoke access. This is the scope that contains the ACL to be removed
principalstringObligatorioThe principal to remove an existing ACL from. Specify a user by email (e.g., someone@example.com), a service principal by applicationId, or a group by group name (e.g., data-scientists)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Secret ScopeDATABRICKS_WORKSPACE_SECRETS_DELETE_SCOPEAcciónTool to delete a secret scope and all associated secrets and ACLs. Use when you need to permanently remove a secret scope. This operation cannot be undone. The API throws errors if the scope does not exist or the user lacks authorization.
DATABRICKS_WORKSPACE_SECRETS_DELETE_SCOPEAcciónTool to delete a secret scope and all associated secrets and ACLs. Use when you need to permanently remove a secret scope. This operation cannot be undone. The API throws errors if the scope does not exist or the user lacks authorization.
Parámetros de entrada
scopestringObligatorioName of the scope to delete. This operation permanently removes the scope along with all secrets stored within it and any associated access control lists (ACLs). The operation cannot be undone
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Workspace SecretDATABRICKS_WORKSPACE_SECRETS_DELETE_SECRETAcciónTool to delete a secret from a Databricks secret scope. Use when you need to remove a secret stored in a scope. Requires WRITE or MANAGE permission on the scope. Not supported for Azure KeyVault-backed scopes.
DATABRICKS_WORKSPACE_SECRETS_DELETE_SECRETAcciónTool to delete a secret from a Databricks secret scope. Use when you need to remove a secret stored in a scope. Requires WRITE or MANAGE permission on the scope. Not supported for Azure KeyVault-backed scopes.
Parámetros de entrada
keystringObligatorioName of the secret to delete. This is the unique identifier for the secret within the specified scope
scopestringObligatorioThe name of the scope that contains the secret to delete. This identifies the secret scope where the secret is stored
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Secrets ACLDATABRICKS_WORKSPACE_SECRETS_GET_ACLAcciónTool to retrieve ACL details for a principal on a Databricks secret scope. Use when you need to check the permission level granted to a specific user, service principal, or group. Requires MANAGE permission on the scope. Each permission level is hierarchical - WRITE includes READ, and MANAGE includes both WRITE and READ.
DATABRICKS_WORKSPACE_SECRETS_GET_ACLAcciónTool to retrieve ACL details for a principal on a Databricks secret scope. Use when you need to check the permission level granted to a specific user, service principal, or group. Requires MANAGE permission on the scope. Each permission level is hierarchical - WRITE includes READ, and MANAGE includes both WRITE and READ.
Parámetros de entrada
scopestringObligatorioThe name of the secret scope to fetch ACL information from
principalstringObligatorioThe principal to fetch ACL information for. Specify a user by email address (e.g., someone@example.com), a service principal by its applicationId value, or a group by its group name (e.g., data-scientists)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Secret ValueDATABRICKS_WORKSPACE_SECRETS_GET_SECRETAcciónTool to get a secret value from a Databricks secret scope. Use when you need to retrieve the actual value of a secret stored in a scope. Important: This API can only be called from the DBUtils interface (from within a cluster/notebook). There is no API to read the actual secret value outside of a cluster. Requires READ permission on the scope.
DATABRICKS_WORKSPACE_SECRETS_GET_SECRETAcciónTool to get a secret value from a Databricks secret scope. Use when you need to retrieve the actual value of a secret stored in a scope. Important: This API can only be called from the DBUtils interface (from within a cluster/notebook). There is no API to read the actual secret value outside of a cluster. Requires READ permission on the scope.
Parámetros de entrada
keystringObligatorioName of the secret to fetch value information. The key to fetch the secret for within the specified scope
scopestringObligatorioThe name of the scope that contains the secret. This is the name of the secret scope to fetch secret information from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Put Secrets ACLDATABRICKS_WORKSPACE_SECRETS_PUT_ACLAcciónTool to create or overwrite access control list for a principal on a Databricks secret scope. Use when you need to grant or modify permissions for a user, group, or service principal on a secret scope. Requires MANAGE permission on the scope. Overwrites existing permission level for the principal if one already exists.
DATABRICKS_WORKSPACE_SECRETS_PUT_ACLAcciónTool to create or overwrite access control list for a principal on a Databricks secret scope. Use when you need to grant or modify permissions for a user, group, or service principal on a secret scope. Requires MANAGE permission on the scope. Overwrites existing permission level for the principal if one already exists.
Parámetros de entrada
scopestringObligatorioThe name of the secret scope to apply permissions to. Must reference an existing secret scope
principalstringObligatorioThe principal (user or group) to receive the permission. Specify a user by email address (e.g., someone@example.com), a service principal by its applicationId value, or a group by its group name (e.g., users, data-scientists). Must correspond to an existing Databricks principal
permissionstringObligatorioenumThe permission level to apply to the principal. MANAGE: allowed to change ACLs, read and write to this secret scope. WRITE: allowed to read and write to this secret scope. READ: allowed to read this secret scope and list available secrets
MANAGEWRITEREAD
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Put Secret in ScopeDATABRICKS_WORKSPACE_SECRETS_PUT_SECRETAcciónTool to insert or update a secret in a Databricks secret scope. Use when you need to store sensitive information like passwords, API keys, or credentials. Overwrites existing secrets with the same key. Requires WRITE or MANAGE permission on the scope. Maximum 1,000 secrets per scope with 128 KB limit per secret.
DATABRICKS_WORKSPACE_SECRETS_PUT_SECRETAcciónTool to insert or update a secret in a Databricks secret scope. Use when you need to store sensitive information like passwords, API keys, or credentials. Overwrites existing secrets with the same key. Requires WRITE or MANAGE permission on the scope. Maximum 1,000 secrets per scope with 128 KB limit per secret.
Parámetros de entrada
keystringObligatorioA unique name to identify the secret. Must consist of alphanumeric characters, dashes, underscores, and periods, and cannot exceed 128 characters
scopestringObligatorioThe name of the scope to which the secret will be associated with. Must consist of alphanumeric characters, dashes, underscores, and periods, and cannot exceed 128 characters
bytes_valuestringIf specified, value will be stored as bytes. Maximum size 128 KB. Exactly one of string_value or bytes_value must be specified
string_valuestringIf specified, the value will be stored in UTF-8 (MB4) form. Maximum size 128 KB. Exactly one of string_value or bytes_value must be specified
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Workspace ObjectDATABRICKS_WORKSPACE_WORKSPACE_DELETEAcciónTool to permanently delete a workspace object or directory. Use when you need to remove notebooks, files, or directories from the workspace. This is a hard delete operation that cannot be undone. Recursive deletion of non-empty directories is not atomic and may partially complete if it fails.
DATABRICKS_WORKSPACE_WORKSPACE_DELETEAcciónTool to permanently delete a workspace object or directory. Use when you need to remove notebooks, files, or directories from the workspace. This is a hard delete operation that cannot be undone. Recursive deletion of non-empty directories is not atomic and may partially complete if it fails.
Parámetros de entrada
pathstringObligatorioThe absolute path of the notebook or directory to delete. Must be an absolute path starting with '/' (e.g., '/Users/user@example.com/project')
recursivebooleanWhether to delete the object recursively. Must be set to true when deleting non-empty directories. Defaults to false. WARNING: Recursive directory deletion is not atomic - if it fails partway through, some objects may be deleted and cannot be recovered
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export Workspace ObjectDATABRICKS_WORKSPACE_WORKSPACE_EXPORTAcciónTool to export a workspace object (notebook, dashboard, or file) as file content or base64-encoded string. Use when you need to retrieve the content of workspace objects for backup, migration, or analysis. By default, returns base64-encoded content with file type information. Set direct_download=true to get raw file content directly.
DATABRICKS_WORKSPACE_WORKSPACE_EXPORTAcciónTool to export a workspace object (notebook, dashboard, or file) as file content or base64-encoded string. Use when you need to retrieve the content of workspace objects for backup, migration, or analysis. By default, returns base64-encoded content with file type information. Set direct_download=true to get raw file content directly.
Parámetros de entrada
pathstringObligatorioThe absolute path of the workspace object to export. Must be a valid workspace path
formatstringenumSpecifies the exported file format (case-sensitive). SOURCE exports notebooks as source code, HTML exports as HTML files, JUPYTER exports as Jupyter/IPython Notebook format, DBC exports in Databricks archive format, R_MARKDOWN exports to R Markdown format, AUTO exports based on automatic object type detection. Defaults to SOURCE if not specified
SOURCEHTMLJUPYTERDBCR_MARKDOWNAUTOdirect_downloadbooleanWhen true, response is the exported file content directly. When false (default), content is returned as base64-encoded string with file_type field
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace Object StatusDATABRICKS_WORKSPACE_WORKSPACE_GET_STATUSAcciónTool to retrieve status and metadata for any workspace object including notebooks, directories, dashboards, and files. Use when you need to get object type, path, identifier, and additional metadata fields. Returns error with code RESOURCE_DOES_NOT_EXIST if the specified path does not exist.
DATABRICKS_WORKSPACE_WORKSPACE_GET_STATUSAcciónTool to retrieve status and metadata for any workspace object including notebooks, directories, dashboards, and files. Use when you need to get object type, path, identifier, and additional metadata fields. Returns error with code RESOURCE_DOES_NOT_EXIST if the specified path does not exist.
Parámetros de entrada
pathstringObligatorioThe absolute path of the notebook, directory, dashboard, or file in the workspace. Must be an absolute path starting with '/' (e.g., '/Users/me@example.com/MyFolder' or '/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import Workspace ObjectDATABRICKS_WORKSPACE_WORKSPACE_IMPORTAcciónTool to import a notebook or file into the Databricks workspace. Use when you need to import base64-encoded content as notebooks, files, or directories. The content must be base64-encoded and can be imported in various formats including SOURCE, HTML, JUPYTER, DBC, and R_MARKDOWN. Maximum content size is 10 MB.
DATABRICKS_WORKSPACE_WORKSPACE_IMPORTAcciónTool to import a notebook or file into the Databricks workspace. Use when you need to import base64-encoded content as notebooks, files, or directories. The content must be base64-encoded and can be imported in various formats including SOURCE, HTML, JUPYTER, DBC, and R_MARKDOWN. Maximum content size is 10 MB.
Parámetros de entrada
pathstringObligatorioThe absolute path of the object or directory where content will be imported in the workspace. Must be an absolute path prefixed with '/'
formatstringenumSpecifies the format of the file to be imported. Use AUTO to automatically detect the asset type (recommended for AI/BI dashboards with .lvdash.json extension). For directories: use DBC or SOURCE format with language field unset. For single files as SOURCE: must set the language field. Defaults to SOURCE if not specified
SOURCEHTMLJUPYTERDBCR_MARKDOWNAUTOcontentstringBase64-encoded content to be imported. Maximum size: 10 MB. If this limit is exceeded, the API throws MAX_NOTEBOOK_SIZE_EXCEEDED exception
languagestringenumThe language of the object. This value is set only if the object type is NOTEBOOK. Required when importing a single file as SOURCE format. Should be unset when importing directories
PYTHONSQLSCALARoverwritebooleanFlag that specifies whether to overwrite existing object. Default: false. Note: For DBC format, overwrite is not supported since it may contain a directory. If path already exists and overwrite is false, the API returns RESOURCE_ALREADY_EXISTS error
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Workspace DirectoryDATABRICKS_WORKSPACE_WORKSPACE_MKDIRSAcciónTool to create a directory and necessary parent directories in the workspace. Use when you need to create new directories. The operation is idempotent - if the directory already exists, the command succeeds without action. Returns error RESOURCE_ALREADY_EXISTS if a file (not directory) exists at any prefix of the path.
DATABRICKS_WORKSPACE_WORKSPACE_MKDIRSAcciónTool to create a directory and necessary parent directories in the workspace. Use when you need to create new directories. The operation is idempotent - if the directory already exists, the command succeeds without action. Returns error RESOURCE_ALREADY_EXISTS if a file (not directory) exists at any prefix of the path.
Parámetros de entrada
pathstringObligatorioThe absolute path of the directory to create. Must be an absolute path prefixed with '/'. If parent directories do not exist, they will be created automatically
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not