Skip to main content
Databricks logo
  • Category: developer tools
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 427
  • Triggers: 0
  • Slug: DATABRICKS
  • Version: 20261101_00

Tools

Slug: DATABRICKS_ADD_MEMBER_TO_SECURITY_GROUPTool 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.

Input Parameters

string
The email address of a user to add to the parent group. Either user_name or group_name must be provided (not both).
string
The 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).
string
required
Name of the parent group to which the new member will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_AGENTBRICKS_AGENT_BRICKS_DELETE_CUSTOM_LLMDelete a Custom LLM agent created through Agent Bricks and its associated data, including temporary transformations, model checkpoints, and internal metadata; this operation is irreversible. The tool also reports success when the API returns 404, so success does not confirm that deletion occurred.

Input Parameters

string
required
The ID of the custom LLM agent to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_CREATETool 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.

Input Parameters

string
required
The 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
array
App resources configuration including database connections, Genie Spaces, jobs, secrets, serving endpoints, SQL warehouses, and Unity Catalog securables
string
The description of the app providing additional context about its purpose
array
Access control list for app users specifying CAN_MANAGE or CAN_USE access levels applicable to users, groups, or service principals
string ("MEDIUM" | "LARGE")
Compute resource allocation for the app. MEDIUM for moderate workloads, LARGE for intensive workloads
array
API access permissions for the app
string
Associated budget policy identifier for cost management
string
Workspace 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}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_DELETETool 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.

Input Parameters

string
required
The name of the app to delete. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_DEPLOYTool 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.

Input Parameters

string ("AUTO_SYNC" | "SNAPSHOT")
The 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
string
required
The name of the app for which the deployment is created
string
required
Workspace 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}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_GETTool 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.

Input Parameters

string
required
The name of the app. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_GET_PERMISSION_LEVELSTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the Databricks app

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_GET_PERMISSIONSTool 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.

Input Parameters

string
required
The name of the app. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_GET_UPDATERetrieves the current update status of a Databricks app. This endpoint returns whether the app’s most recent configuration update succeeded, failed, is in progress, or has never been updated. Use this to monitor the status of app configuration changes (such as description, compute size, or resource modifications) rather than deployment status.

Input Parameters

string
required
The name of the app to retrieve update status for. Must contain only lowercase alphanumeric characters and hyphens

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_SET_PERMISSIONSTool 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.

Input Parameters

string
required
The name of the app. Must contain only lowercase alphanumeric characters and hyphens, and must be unique within the workspace
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_STARTTool 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.

Input Parameters

string
required
The name of the app to start. Must contain only lowercase alphanumeric characters and hyphens

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_STOPTool 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.

Input Parameters

string
required
The name of the app to stop. Must contain only lowercase alphanumeric characters and hyphens

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_UPDATEUpdate an existing Databricks app configuration, including its description, resources, budget policy, or user API scopes. The request sends only supplied non-null settings.

Input Parameters

string
required
The name of the app to update. Must contain only lowercase alphanumeric characters and hyphens
array
List of accessible system components and resources for the app. When provided, replaces the existing resources configuration
string
Application summary or description. When provided, replaces the existing description
string
Usage policy identifier for the application. When provided, replaces the existing usage policy
array
API access grants for application users. List of permission scopes. When provided, replaces the existing user API scopes
string
Associated budget policy identifier for cost management. When provided, replaces the existing budget policy
string
Workspace path tracking the last active deployment source code. When provided, replaces the existing source code path

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_APPS_APPS_UPDATE_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier or name of the app. Must contain only lowercase alphanumeric characters and hyphens
array
required
List 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_ARTIFACT_ALLOWLISTS_GETTool 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.

Input Parameters

string ("INIT_SCRIPT" | "LIBRARY_JAR" | "LIBRARY_MAVEN")
required
The artifact type of the allowlist to retrieve. Supported values are INIT_SCRIPT, LIBRARY_JAR, or LIBRARY_MAVEN

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CATALOGS_DELETETool 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.

Input Parameters

string
required
The name of the catalog to delete. The caller must be a metastore admin or the owner of the catalog
boolean
Force 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CATALOGS_GETTool 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.

Input Parameters

string
required
The name of the catalog to retrieve
boolean
Whether to include catalogs in the response for which the principal can only access selective metadata through the BROWSE privilege

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CONNECTIONS_CREATETool 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.

Input Parameters

string
required
Name of the connection. This is the unique identifier for the connection within the metastore
string
User-provided free-form text description of the connection
object
required
A map of key-value properties containing connection-type specific parameters needed to establish the connection. Property keys must be unique and are case-sensitive. Required options vary by connection type: HTTP requires ‘host’ and ‘bearer_token’; MYSQL requires ‘host’, ‘port’, ‘user’, and ‘password’; POSTGRESQL requires ‘host’, ‘port’, ‘database’, ‘user’, and ‘password’; SNOWFLAKE requires ‘host’, ‘user’, and ‘password’. Refer to Databricks documentation for complete requirements per connection type
boolean
If true, the connection is read-only and cannot be used for write operations
object
A map of key-value properties attached to the securable object for custom metadata
string ("BIGQUERY" | "DATABRICKS" | "GA4_RAW_DATA" | "GLUE" | "HIVE_METASTORE" | "HTTP" | "MYSQL" | "ORACLE" | "POSTGRESQL" | "POWER_BI" | "REDSHIFT" | "SALESFORCE" | "SALESFORCE_DATA_CLOUD" | "SERVICENOW" | "SNOWFLAKE" | "SQLDW" | "SQLSERVER" | "TERADATA" | "WORKDAY_RAAS")
required
The type of connection to create. Must be one of the supported connection types

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CONNECTIONS_DELETETool 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.

Input Parameters

string
required
The name of the connection to delete. This is the unique identifier for the connection resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CONNECTIONS_GETTool 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.

Input Parameters

string
required
Name of the connection to retrieve. This is the unique identifier for the connection within the metastore

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CONNECTIONS_UPDATETool to update an existing Unity Catalog connection configuration. Use when you need to modify connection properties, credentials, ownership, or metadata for external data sources.

Input Parameters

string
Username of the new owner of the connection
string
User-provided free-form text description of the connection
object
required
A 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)
string
New name for the connection if renaming is desired
string
required
Name or unique identifier of the connection to update
object
Additional key-value properties attached to the connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CREDENTIALS_CREATE_CREDENTIALTool 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.

Input Parameters

string
required
The credential name. Must be unique among storage and service credentials within the metastore
string
Comment associated with the credential
string ("SERVICE" | "STORAGE")
required
Indicates the purpose of the credential. Valid values are SERVICE (for accessing external cloud services) or STORAGE (for accessing cloud storage locations)
boolean
Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE
object
AWS IAM role configuration for credential.
boolean
Supplying true to this argument skips validation of the created credential
object
Azure managed identity configuration for credential.
object
Azure service principal configuration for credential.
object
GCP service account configuration for credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CREDENTIALS_DELETE_CREDENTIALTool 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.

Input Parameters

boolean
Force 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
string
required
The name or ID of the credential to delete. This is the unique identifier for the credential resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CREDENTIALS_GET_CREDENTIALTool 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.

Input Parameters

string
required
Name of the credential to retrieve. This is the unique identifier for the credential within the metastore

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CREDENTIALS_UPDATE_CREDENTIALTool 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.

Input Parameters

boolean
Force update even if there are dependent external locations or external tables
string
Username of the new owner of the credential. If the caller is a metastore admin, only this field can be changed
string
Comment associated with the credential
string
New name for the credential
boolean
Whether the storage credential is only usable for read operations. Only applicable when purpose is STORAGE
string
required
The name or ID of the credential to update. This is the unique identifier for the credential resource
object
AWS IAM role configuration for credential.
string ("ISOLATION_MODE_ISOLATED" | "ISOLATION_MODE_OPEN")
Whether the credential is accessible from all workspaces or a specific set of workspaces
boolean
Supplying true skips validation of the updated credential
object
Cloudflare API token configuration for credential.
object
Azure managed identity configuration for credential.
object
Azure service principal configuration for credential.
object
GCP service account configuration for credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CREDS_GENERATE_TEMP_SERVICE_CREDTool 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.

Input Parameters

object
GCP-specific configuration options for temporary credential generation.
object
Azure-specific configuration options for temporary credential generation.
string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_CREDS_VALIDATE_CREDTool 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.

Input Parameters

string
The external location URL to validate. Only applicable when purpose is STORAGE. If both url and external_location_name are provided, url takes precedence
string ("SERVICE" | "STORAGE")
The purpose of the credential. Use SERVICE for accessing external cloud services or STORAGE for cloud storage locations. Determines which validation logic is applied
boolean
Whether the credential should be validated for read-only access. Only applicable when purpose is STORAGE
object
AWS IAM role configuration for credential validation.
string
The name of an existing credential to validate. Either this or a cloud-specific credential must be provided
object
Cloudflare API token configuration for credential validation.
object
Azure managed identity configuration for credential validation.
string
The 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
object
Azure service principal configuration for credential validation.
object
GCP service account configuration for credential validation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_ENTITY_TAG_ASSIGNMENTS_GETTool 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.

Input Parameters

string
required
The key of the tag to retrieve. Tag keys can contain letters, spaces, numbers, or the characters +, -, =, ., _, :, /, @
string
required
The fully qualified name of the entity to which the tag is assigned (e.g., ‘samples.nyctaxi.trips’ for a table)
string ("catalogs" | "schemas" | "tables" | "columns" | "volumes")
required
The type of the entity to which the tag is assigned. Must be one of: catalogs, schemas, tables, columns, volumes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_CREATETool 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.

Input Parameters

string
required
Path URL of the external location (e.g., s3://bucket-name/path, abfss://container@storage.dfs.core.windows.net/path, gs://bucket-name/path)
string
required
Name of the external location. This is the identifier used to reference the location
string
User-provided free-form text description of the external location
boolean
Allows fallback to cluster credentials when Unity Catalog credentials are insufficient. Enables support for legacy workloads
boolean
Indicates whether the external location is read-only. When true, restricts the location to read-only access. Default is false
string
required
Name of the storage credential to use with this location. The credential authorizes access to the cloud storage path
boolean
Skips validation of the storage credential associated with the external location. Default is false
object
File event queue configuration.
boolean
Whether to enable file event tracking at this location. If enabled, file_event_queue must be provided
object
Server-side encryption configuration for AWS S3 communication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_DELETETool 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.

Input Parameters

string
required
The 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
boolean
Force 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_GETTool 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.

Input Parameters

string
required
Name or identifier of the external location to retrieve
boolean
Whether to include external locations in the response for which the principal can only access selective metadata through the BROWSE privilege

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_EXTERNAL_LOCATIONS_UPDATETool 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.

Input Parameters

string
Cloud storage path URL (e.g., s3://bucket-name/path, abfss://container@storage.dfs.core.windows.net/path, gs://bucket-name/path)
string
required
Name or identifier of the external location to update
boolean
Force update even if changing URL invalidates dependent external tables or mounts. Use with caution as this may break existing dependencies
string
Username, group name, or service principal name/ID for ownership assignment
string
User-provided free-form text description
boolean
Enable fallback to cluster credentials for access when Unity Catalog credentials are insufficient
string
New name for the external location if renaming is desired
boolean
Whether the external location is read-only. When true, restricts write access to the location
string
Isolation configuration. Use ‘ISOLATION_MODE_ISOLATED’ for isolated mode or ‘ISOLATION_MODE_OPEN’ for open mode
string
Name of the storage credential to use with this location
boolean
Suppress validation errors and force save the external location. Bypasses storage credential validation during update
object
File event queue configuration.
boolean
Activate managed file events for this location. If enabled, file_event_queue must be provided
object
Server-side encryption configuration for AWS S3 communication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_EXTERNAL_METADATA_UPDATE_EXTERNALTool 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.

Input Parameters

string
required
Unique identifier of the external metadata object to be modified
string
URL associated with the external metadata object
string
Name of the external metadata object
string
Owner of the external metadata object. Cannot be updated with other fields in the same request
array
List of columns associated with the external metadata object
object
Key-value properties attached to the external metadata object
string
User-provided free-form text description
string
Type of entity within the external system
string
Type of external system (e.g., DATABRICKS, SNOWFLAKE, BIGQUERY)
string
required
A 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_FUNCTIONS_UPDATETool 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.

Input Parameters

string
required
The fully-qualified name of the function in the form catalog_name.schema_name.function_name
string
Username of the new owner of the function. This is the only field that can be updated via this endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_GRANTS_GETTool 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.

Input Parameters

string
required
Full name of the securable. For catalog: ‘my_catalog’, for table: ‘catalog.schema.table’
string
If provided, only the permissions for the specified principal (user email, group name, or service principal) are returned
string
Opaque token for retrieving the next page of results
integer
Maximum 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
string
required
Type of securable object. For catalogs, use ‘catalog’. Valid values: catalog, schema, table, metastore, volume, function, model, connection, share, recipient, provider, storage_credential, external_location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_GRANTS_GET_EFFECTIVETool 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).

Input Parameters

string
required
Full name of the securable. For catalog: ‘my_catalog’, for table: ‘catalog.schema.table’
string
If provided, only the effective permissions for the specified principal (user email or group name) are returned
string
Opaque token for retrieving the next page of results
integer
Maximum 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
string
required
Type of securable object. Valid values: CATALOG, SCHEMA, TABLE, METASTORE, VOLUME, FUNCTION, MODEL, CONNECTION, SHARE, RECIPIENT, PROVIDER, STORAGE_CREDENTIAL, EXTERNAL_LOCATION

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_GRANTS_UPDATETool 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.

Input Parameters

array
required
Array of permission changes to apply. Each change specifies a principal and which privileges to add or remove for that principal
string
required
Full name of the securable. For catalog: ‘my_catalog’, for schema: ‘catalog.schema’, for table: ‘catalog.schema.table’
string
required
Type 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_ASSIGNTool 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.

Input Parameters

string
required
The unique ID of the metastore to assign. Unique identifier of the parent metastore to assign to the workspace
integer
required
The unique workspace identifier. The ID of the workspace to assign the metastore to
string
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_CREATETool 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.

Input Parameters

string
required
The user-specified name of the metastore. Must be unique within the region
string
Cloud provider identifier
string
Username/groupname/service principal application_id of the metastore owner. Empty string assigns to System User
string
Cloud region which the metastore serves (e.g., us-west-2, westus)
string
The storage root URL for metastore (supports S3, Azure Blob, GCS paths)
string ("INTERNAL" | "INTERNAL_AND_EXTERNAL")
Scope of Delta Sharing enabled for the metastore
string
UUID of the storage credential used to access the metastore storage root
string
Default data access configuration ID
string
Organization name of a Delta Sharing entity for Databricks-to-Databricks Delta Sharing. Cannot be removed once set
integer
Lifetime of delta sharing recipient token in seconds. Set to 0 for unlimited

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_CURRENTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_DELETETool 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.

Input Parameters

string
required
Unique identifier of the metastore to delete. The caller must be a metastore admin
boolean
Force 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_GETRetrieves comprehensive details about a Unity Catalog metastore by its unique ID. Returns metastore configuration including name, cloud provider, region, owner, storage settings, Delta Sharing configuration, privilege model version, and audit metadata (creation/update timestamps and users). Use this to inspect metastore properties, verify configurations, or gather information for metastore management operations. Note: Requires appropriate metastore access permissions.

Input Parameters

string
required
The unique UUID of the metastore to retrieve. Use DATABRICKS_CATALOG_METASTORES_CURRENT to get the current workspace’s metastore ID if needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_SUMMARYTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_UNASSIGNTool 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.

Input Parameters

string
required
The unique identifier of the Unity Catalog metastore to unassign from the workspace. This identifies which metastore assignment to remove
integer
required
The unique identifier of the workspace from which to unassign the metastore. This is the ID of the workspace to remove the metastore assignment from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_UPDATETool 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.

Input Parameters

string
required
Unique identifier of the metastore to update
string
The owner of the metastore. If set to empty string, ownership is updated to the System User
string
New name for the metastore
string ("INTERNAL" | "INTERNAL_AND_EXTERNAL")
The scope of Delta Sharing enabled for the metastore. INTERNAL allows sharing within the same organization only, INTERNAL_AND_EXTERNAL allows sharing with external organizations
boolean
Whether to enable external data access on the metastore. When true, allows the metastore to access external data sources
string
Privilege model version of the metastore, of the form major.minor (e.g., 1.0)
string
UUID of storage credential to access the metastore storage_root
string
The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name
integer
The lifetime of delta sharing recipient token in seconds

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_METASTORES_UPDATE_ASSIGNMENTTool 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.

Input Parameters

string
The 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
string
required
The unique workspace identifier. A workspace ID to update the metastore assignment for
string
The name of the default catalog in the metastore. DEPRECATED: Use the Default Namespace API to configure the default catalog for a Databricks workspace instead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_MODEL_VERSIONS_GETTool 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.

Input Parameters

integer
required
The integer version number of the model version to retrieve
string
required
The three-level (fully qualified) name of the model (format: catalog.schema.model_name)
boolean
Whether to include model versions for which the principal can only access selective metadata
boolean
Whether to include aliases associated with the model version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_MODEL_VERSIONS_UPDATETool 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.

Input Parameters

string
required
The comment to attach to the model version. This is currently the only field that can be updated. Provide the new comment value you want to set
integer
required
The integer version number of the model version to update
string
required
The three-level (fully qualified) name of the model (e.g., ‘catalog.schema.model_name’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_ONLINE_TABLES_DELETEDelete an online table by name, permanently removing its data and stopping synchronization; the tool reports success for any HTTP 404 response as well as a successful deletion. Online tables are deprecated and will not be accessible after January 15, 2026.

Input Parameters

string
required
Full 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_QUALITY_MONITORS_GETTool 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.

Input Parameters

string
required
Unity Catalog table name in format ‘catalog.schema.table_name’. Case insensitive, spaces disallowed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_QUALITY_MONITORS_LIST_REFRESHESTool 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.

Input Parameters

string
required
Full 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’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_REGISTERED_MODELS_GETTool 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.

Input Parameters

string
required
The three-level (fully qualified) name of the registered model in the format catalog.schema.model_name
boolean
Whether to include models where the principal has selective metadata access through the BROWSE privilege
boolean
Whether to include registered model aliases in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_RESOURCE_QUOTAS_GET_QUOTATool 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.

Input Parameters

string
required
Name 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’.
string
required
Full name of the parent resource. For example, the ‘main.default’ schema or ‘samples’ catalog. If the parent is a metastore, use the metastore ID.
string ("CATALOG" | "SCHEMA" | "METASTORE")
required
Securable type of the quota parent. Type of the parent object. Valid values include: CATALOG, SCHEMA, METASTORE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_RFA_BATCH_CREATE_ACCESS_REQUESTSTool 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.

Input Parameters

array
required
List of individual access requests. Maximum 30 requests per API call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_RFA_GET_ACCESS_REQUEST_DESTSTool 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.

Input Parameters

string
required
The 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’
string ("metastore" | "catalog" | "schema" | "table" | "external_location" | "connection" | "credential" | "function" | "registered_model" | "volume")
required
The type of the securable object. Supported values: metastore, catalog, schema, table, external_location, connection, credential, function, registered_model, volume

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_RFA_UPDATE_ACCESS_REQUEST_DESTSTool 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, external locations, connections, or credentials. Requires metastore admin, owner privileges, or MANAGE permission on the securable. Maximum 5 emails and 5 external destinations allowed per securable. Note: Destinations cannot be updated for securables underneath schemas (tables, volumes, functions, models) as they inherit from parent securables.

Input Parameters

object
required
The securable object for which to update access request destinations
string
Field mask indicating which fields to update. Use ‘destinations’ to update the destinations list
array
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_SCHEMAS_GETTool 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.

Input Parameters

string
required
Full name of the schema in the format ‘catalog_name.schema_name’ (e.g., ‘main.analytics’ or ‘samples.nyctaxi’)
boolean
Whether to include schemas in the response for which the principal can only access selective metadata via BROWSE privilege

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_STORAGE_CREDENTIALS_CREATETool 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.

Input Parameters

string
required
The credential name. Must be unique among storage and service credentials within the metastore
string
Comment associated with the credential
boolean
Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE
object
AWS IAM role configuration for storage credential.
boolean
Supplying true skips validation of the created credential
object
Cloudflare API token configuration for storage credential.
object
Azure managed identity configuration for storage credential.
object
Azure service principal configuration for storage credential.
object
GCP service account configuration for storage credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_STORAGE_CREDENTIALS_DELETETool 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.

Input Parameters

string
required
The name of the storage credential to delete. The caller must be the owner of the storage credential to perform this operation
boolean
Force 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_STORAGE_CREDENTIALS_GETTool 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.

Input Parameters

string
required
Name of the storage credential to retrieve. Must be unique within the metastore

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_STORAGE_CREDENTIALS_UPDATETool 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.

Input Parameters

string
required
The name of the storage credential to update. This is used in the path parameter to identify the credential
boolean
Force update even if there are dependent external locations, external tables (when purpose is STORAGE), or dependent services (when purpose is SERVICE)
string
Username, group name, or service principal application_id of the storage credential owner. Metastore admins can only change this field
string
Comment associated with the credential
string
New name for the storage credential if renaming is desired
boolean
Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE
object
AWS IAM role configuration for storage credential.
string
Whether the current securable is accessible from all workspaces or a specific set. Use ‘ISOLATION_MODE_ISOLATED’ or ‘ISOLATION_MODE_OPEN’
boolean
Skip validation of the updated credential
object
Cloudflare API token configuration for storage credential.
object
Azure managed identity configuration for storage credential.
object
Azure service principal configuration for storage credential.
object
GCP service account configuration for storage credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_STORAGE_CREDENTIALS_VALIDATETool 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.

Input Parameters

string
The 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
boolean
Whether the storage credential is usable only for read operations
object
AWS IAM role configuration for storage credential validation.
object
Cloudflare API token configuration for storage credential validation.
object
Azure managed identity configuration for storage credential validation.
string
Name of an existing external location to validate. At least one of external_location_name or url must be provided
object
Azure service principal configuration for storage credential validation.
string
Name of an existing storage credential to validate. Either this or a cloud-specific credential must be provided
object
GCP service account configuration for storage credential validation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_SYSTEM_SCHEMAS_DISABLEDisable a system schema in a Unity Catalog metastore, removing it from the system catalog; requires account admin or metastore admin privileges. The tool reports success for any HTTP 404 response as well as a successful deletion.

Input Parameters

string
required
Full name of the system schema to disable. Valid system schema names include: access, billing, compute, storage, lineage, marketplace
string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_SYSTEM_SCHEMAS_ENABLETool 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.

Input Parameters

string
required
Full name of the system schema to enable. Valid system schema names include: access, billing, compute, storage, lineage, marketplace, information_schema, operational_data
string
The catalog for which the system schema is to be enabled in. Optional parameter to specify a particular catalog
string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_TABLES_DELETEDelete a table from its parent Unity Catalog catalog and schema. The operation requires appropriate permissions.

Input Parameters

string
required
Full 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_TABLES_EXISTSTool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_TABLES_GETTool 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.

Input Parameters

string
required
The 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
boolean
Whether to include tables in the response for which the principal can only access selective metadata through the BROWSE privilege
boolean
Whether delta metadata should be included in the response. Delta metadata includes information about table version, data files, and statistics
boolean
Whether to include a manifest containing table capabilities in the response. Capabilities describe what operations are supported on the table

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_TABLES_UPDATETool 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.

Input Parameters

string
Username of the new owner of the table. This is the primary field that can be updated via this endpoint
string
User-provided free-form text description for the table
string
required
The three-level (fully qualified) name of the table in the format ‘catalog_name.schema_name.table_name’ (e.g., ‘samples.nyctaxi.trips’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_TEMP_PATH_CREDS_GENERATE_TEMP_PATH_CREDSTool 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.

Input Parameters

string
required
The 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
boolean
When set to true, the service will not validate that the generated credentials can perform write operations. Default is false
string ("PATH_READ" | "PATH_READ_WRITE" | "PATH_CREATE_TABLE")
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_VOLUMES_READTool 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.

Input Parameters

string
required
The 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)
boolean
Whether to include volumes in the response for which the principal can only access selective metadata through the BROWSE privilege

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CATALOG_WORKSPACE_BINDINGS_UPDATE_BINDINGSTool 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.

Input Parameters

array
List of workspace bindings to add or update. Each binding specifies a workspace ID and the access level (read-write or read-only)
string
required
The name of the catalog to update workspace bindings for
array
List of workspace bindings to remove. Each binding specifies a workspace ID and the access level to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CLEANROOMS_CLEAN_ROOM_ASSETS_GETTool 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.

Input Parameters

string
required
The fully qualified name of the asset. For Unity Catalog assets, format is: shared_catalog.shared_schema.asset_name
string ("FOREIGN_TABLE" | "NOTEBOOK_FILE" | "TABLE" | "VIEW" | "VOLUME")
required
The type of the asset. Supported values: FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME
string
required
Name of the clean room

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CLEANROOMS_CLEAN_ROOM_AUTO_APPROVAL_RULES_CREATETool 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.

Input Parameters

string
Scope 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
string
required
The name of the clean room where the auto-approval rule will be created
string
Collaborator 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
string
Collaborator alias of the runner who will execute the auto-approved notebooks. This designates a single runner for the approved notebook
string
The owner of the rule to whom the rule applies. This identifies the collaborator who owns this auto-approval rule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CLEANROOMS_CLEAN_ROOMS_CREATETool 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.

Input Parameters

string
required
The name of the clean room. Cannot include spaces, periods, or forward slashes. Cannot be changed after creation
string
User-provided free-form text description of the clean room
object
required
Central clean room configuration including cloud provider, region, and collaborator details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_CREATETool 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.

Input Parameters

string
required
Cluster Policy name requested by the user. Must be unique within the workspace. Length must be between 1 and 100 characters
array
List of libraries to be automatically installed on clusters using this policy. Libraries are installed on next cluster restart. Maximum of 500 libraries allowed
string
required
Policy definition document expressed in Databricks Cluster Policy Definition Language (JSON string). Cannot be used together with policy_family_id
string
Additional human-readable description of the cluster policy
string
ID of the policy family. The cluster policy’s definition inherits from the policy family’s definition. Cannot be used together with definition parameter
integer
Maximum 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
string
Policy 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_DELETEDelete a workspace cluster policy by ID. Only workspace admins can delete policies; clusters governed by the deleted policy can still run but cannot be edited. A policy-not-found response is treated as success.

Input Parameters

string
required
The ID of the policy to delete. Canonical unique identifier for the cluster policy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_EDITTool 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.

Input Parameters

string
required
Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100 characters
array
A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500
string
required
The ID of the policy to update. This is a required parameter
string
Policy definition document expressed in Databricks Cluster Policy Definition Language (JSON string). Required unless policy_family_id is provided. Cannot be used with policy_family_id.
string
Additional human-readable description of the cluster policy
string
ID of the policy family. The cluster policy’s policy definition inherits the policy family’s policy definition. Cannot be used with definition
integer
Max number of clusters per user that can be active using this policy. If not present, there is no max limit. Must be greater than 0 if specified
string
Policy definition JSON document for customizing inherited policy family definitions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_GETTool 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.

Input Parameters

string
required
Canonical unique identifier for the cluster policy to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_GET_PERM_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the cluster policy for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_GET_PERMSTool 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.

Input Parameters

string
required
The unique identifier of the cluster policy for which to retrieve permissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_SET_PERMSTool 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.

Input Parameters

string
required
The unique identifier of the cluster policy for which to set permissions
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTER_POLICIES_UPDATE_PERMSTool 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.

Input Parameters

string
required
The cluster policy resource identifier for which permissions are being modified
array
required
Collection 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_GET_PERMISSION_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the cluster for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_LIST_NODE_TYPESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_LIST_ZONESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_PERMANENT_DELETETool 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.

Input Parameters

string
required
The unique identifier of the cluster to permanently delete. This operation is irreversible and will asynchronously remove all cluster resources

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_PINTool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_SPARK_VERSIONSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_STARTTool 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.

Input Parameters

string
required
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_UNPINTool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_CLUSTERS_UPDATETool 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.

Input Parameters

object
Autoscaling configuration for cluster workers.
string
References cluster policy for validation and defaults. Only applied if ‘policy_id’ is in update_mask.
string
required
The unique identifier of the cluster to update. The cluster must be in RUNNING or TERMINATED state.
object
Spark configuration key-value pairs. Only applied if ‘spark_conf’ is in update_mask.
object
Additional tags for cluster resources (max 45 tags). Only applied if ‘custom_tags’ is in update_mask.
integer
Number of worker nodes. Use 0 for single-node clusters. Only applied if ‘num_workers’ is in update_mask.
string
required
Comma-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.
string
Cluster name requested by the user. Only applied if ‘cluster_name’ is in update_mask.
object
Docker container configuration.
array
Scripts executing during cluster startup. Only applied if ‘init_scripts’ is in update_mask.
string
Instance type for worker nodes. Only applied if ‘node_type_id’ is in update_mask.
string
The 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.
object
Workload type restrictions for cluster usage.
object
AWS-specific cluster configuration.
object
GCP-specific cluster configuration.
string ("STANDARD" | "PHOTON")
Runtime engine type. Only applied if ‘runtime_engine’ is in update_mask.
object
Environment variables for Spark processes. Only applied if ‘spark_env_vars’ is in update_mask.
array
List of SSH public keys (up to 10). Only applied if ‘ssh_public_keys’ is in update_mask.
object
Azure-specific cluster configuration.
object
Cluster log delivery configuration.
string
Instance pool identifier for worker nodes. Only applied if ‘instance_pool_id’ is in update_mask.
string
Required when using SINGLE_USER security mode. Only applied if ‘single_user_name’ is in update_mask.
string ("SINGLE_USER" | "USER_ISOLATION" | "LEGACY_TABLE_ACL" | "LEGACY_PASSTHROUGH" | "LEGACY_SINGLE_USER")
Access control mode for the cluster. Only applied if ‘data_security_mode’ is in update_mask.
string
The node type of the Spark driver. Only applied if ‘driver_node_type_id’ is in update_mask.
boolean
Enables autoscaling storage, monitors free disk space. Only applied if ‘enable_elastic_disk’ is in update_mask.
integer
Automatically terminate the cluster after it is inactive for this time in minutes. Only applied if ‘autotermination_minutes’ is in update_mask.
string
Instance pool identifier for driver node. Only applied if ‘driver_instance_pool_id’ is in update_mask.
boolean
When 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.
boolean
Encrypts temporary cluster storage using LUKS. Only applied if ‘enable_local_disk_encryption’ is in update_mask.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_CREATECreate a global initialization script in a Databricks workspace; only workspace admins can create them. Enabled scripts run on cluster nodes in position order, except on model serving clusters; existing clusters must restart to apply changes, and decoded script content cannot exceed 64KB.

Input Parameters

string
required
The name of the script. Must be provided and should be descriptive of the script’s purpose
string
required
The Base64-encoded content of the script. The decoded script content must not exceed 64KB in size
boolean
Specifies whether the script is enabled. The script runs only if enabled. If not specified, the default behavior applies
integer
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_DELETEDelete a global initialization script from a Databricks workspace. Requires workspace administrator privileges; clusters must restart to reflect the removal.

Input Parameters

string
required
The unique identifier of the global init script to delete. This is the ID returned when the script was created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_GETTool 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.

Input Parameters

string
required
The unique identifier of the global init script to retrieve. This is the ID returned when the script was created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_GLOBAL_INIT_SCRIPTS_UPDATEUpdate a global initialization script in a Databricks workspace by script ID, optionally modifying its content, name, enabled status, or execution order; unspecified fields retain their current value. Existing clusters must be restarted to pick up changes.

Input Parameters

string
The name of the script. It should be unique
string
The Base64-encoded content of the script
boolean
Specifies whether the script is enabled. The script runs only if enabled
integer
The 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
string
required
The unique identifier of the global init script to update. This is the ID returned when the script was created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_CREATETool 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.

Input Parameters

object
Specification of disks attached to all spark containers.
object
Additional 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
integer
Maximum 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
string
required
Encodes 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
object
AWS-specific attributes for the instance pool.
object
GCP-specific attributes for the instance pool.
object
Azure-specific attributes for the instance pool.
string
required
Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100 characters
integer
Minimum number of idle instances to keep in the instance pool. This is in addition to any instances in use by active clusters
boolean
Autoscaling 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
integer
GCP HYPERDISK throughput in Mb/s
array
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
array
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
object
Fleet-related settings to power the instance pool.
integer
Initial remote disk volume size in GB
integer
required
Automatically 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_DELETETool 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.

Input Parameters

string
required
The unique identifier of the instance pool to delete. The idle instances in the pool are terminated asynchronously

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_EDITTool 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.

Input Parameters

object
Specification of disks attached to all spark containers.
object
Additional tags for pool resources. Maximum 45 custom tags allowed
integer
Maximum number of outstanding instances (active + idle) to keep in the pool
string
required
Encodes resources available to each Spark node (e.g., i3.xlarge). Must match existing node type as it cannot be changed after pool creation
object
AWS-specific attributes for the instance pool.
object
GCP-specific attributes for the instance pool.
object
Azure-specific attributes for the instance pool.
string
required
Instance pool ID that identifies the pool to be modified
string
required
Pool name requested by the user. Must be unique, non-empty, length between 1-100 characters
integer
Minimum number of idle instances to keep in the pool. Default: 0
boolean
When enabled, instances dynamically acquire additional disk space when running low
array
Custom Docker images to preload on pool instances
array
List of Spark versions to preload for faster cluster starts
object
Fleet-related settings to power the instance pool.
integer
Automatically terminates extra idle instances after inactive for this time in minutes. Range: 0-10000. Value of 0 instantly removes idle instances

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_GETTool 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.

Input Parameters

string
required
The canonical unique identifier for the instance pool

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_GET_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier of the instance pool for which to retrieve permissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_GET_PERM_LEVELSTool 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.

Input Parameters

string
required
The canonical unique identifier for the instance pool for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_SET_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier of the instance pool for which to set permissions
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_POOLS_UPDATE_PERMSTool 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.

Input Parameters

string
required
The instance pool resource identifier for which permissions are being modified
array
required
Collection 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_PROFILES_ADDTool 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.

Input Parameters

string
The 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
boolean
By 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
string
required
The 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
boolean
Flag 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_PROFILES_EDITModify an AWS EC2 instance profile registered with Databricks, including its IAM role ARN and credential-passthrough meta-profile setting. Admin access is required, and the IAM role ARN is required for Databricks SQL Serverless when the role and instance profile names differ.

Input Parameters

string
The 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
string
required
The AWS ARN of the instance profile to edit. This identifies which instance profile to modify
boolean
Boolean 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_INSTANCE_PROFILES_REMOVETool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_POLICY_COMPL_FOR_CLUSTERS_ENFORCE_COMPLTool 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.

Input Parameters

string
required
The 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.
boolean
If 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_POLICY_COMPL_FOR_CLUSTERS_GET_COMPLTool 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.

Input Parameters

string
required
The unique identifier of the cluster for which to retrieve compliance status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_COMPUTE_POLICY_FAMILIES_GETTool 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.

Input Parameters

integer
The version number for the family to fetch. Defaults to the latest version if not specified
string
required
The unique identifier for the policy family to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CREATE_CLUSTERTool 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.

Input Parameters

object
Autoscaling configuration for cluster workers.
string
Cluster policy ID for validation and defaults
string
Source cluster ID to clone configuration and libraries from
object
Spark configuration key-value pairs
object
Additional tags for cluster resources. Maximum 45 tags
integer
Number of worker nodes. Mutually exclusive with autoscale. Use 0 for single-node clusters
string
Cluster name requested by the user. Does not need to be unique
object
Docker container configuration.
array
Initialization scripts executed sequentially during cluster startup
string
Instance type for worker nodes. Required unless using instance_pool_id
string
required
The Spark version of the cluster. Retrieve available versions via clusters/spark-versions API
object
Workload type restrictions for cluster usage.
object
AWS-specific cluster configuration.
string
Cluster creation source (UI, JOB, API)
object
GCP-specific cluster configuration.
string ("STANDARD" | "PHOTON")
Runtime engine type
object
Environment variables for Spark driver and worker processes
array
SSH public keys for ubuntu user access on port 2200. Maximum 10 keys
object
Azure-specific cluster configuration.
object
Cluster log delivery configuration.
string
Instance pool identifier for worker nodes. Alternative to node_type_id
string
Username when using SINGLE_USER security mode
string
Optional token for creation idempotency. Maximum 64 characters
string ("SINGLE_USER" | "USER_ISOLATION" | "LEGACY_TABLE_ACL" | "LEGACY_PASSTHROUGH" | "LEGACY_SINGLE_USER" | "NONE")
Data governance model for the cluster
string
The node type of the Spark driver. Defaults to node_type_id if unspecified
boolean
Autoscale EBS/disk volumes when low on space
integer
Automatically terminate the cluster after it is inactive for this time in minutes. Must be between 10-10000 minutes, or 0 to disable
string
Instance pool identifier for driver node
boolean
When true, fixed and default values from the policy will be used for omitted fields
boolean
Enable LUKS encryption on local disks for temporary cluster storage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_CREATE_JOBCreates a new Databricks job for a workflow or data pipeline, with one or more tasks and optional schedule and notifications. Tasks can have dependencies and use task-level or shared job clusters, while some task types use other compute; an unpaused schedule can trigger runs automatically.

Input Parameters

string
required
Name of the job. Must be unique within the workspace.
object
A map of tags associated with the job. Maximum of 25 tags can be added.
object
Queue settings for the job.
array
required
Array of task configurations for the job. Each task must have a unique task_key. At least one task is required.
string
Job format specification. Use ‘MULTI_TASK’ for jobs with multiple tasks.
object
Health monitoring configuration for the job.
object
Specifies the user or service principal that the job runs as.
object
Periodic schedule configuration using Cron expressions.
object
Git source configuration for notebooks and Python files.
array
Job-level parameters that can be referenced in tasks
integer
Maximum number of times to retry an unsuccessful run. Use -1 for infinite retries, 0 for never retry. Default is 0.
array
Shared cluster configurations that can be referenced by tasks using job_cluster_key. Useful for reusing cluster configs across tasks.
integer
Optional timeout applied to each run of this job in seconds. Set to 0 for no timeout.
boolean
Whether to retry when a run times out. Default is false.
object
Email notification settings for job lifecycle events.
integer
Maximum number of concurrent runs allowed for this job. Default is 1. Maximum is 1000.
object
Webhook notification settings for job lifecycle events.
integer
Minimum milliseconds between retry attempts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_CREATE_MESSAGETool 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.

Input Parameters

string
required
User message content - the question or message to send to Genie
string
required
The ID associated with the Genie space where the conversation exists
string
required
The ID associated with the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_CREATE_SPACETool 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. The space requires a SQL warehouse ID and a serialized configuration with at minimum a version field (1 or 2). Optionally specify data source tables to enable querying specific datasets.

Input Parameters

string
Optional description of the Genie space to provide context about its purpose and contents.
string
Parent folder path where the space will be registered in the workspace. If not specified, defaults to the user’s home directory.
string
Display name for the Genie space. If not provided, the API will generate a default name like ‘New Space’. This name is shown in the UI.
string
required
The ID of the SQL warehouse to associate with the new Genie space. This warehouse will be used to execute queries in the space. You must have at least CAN USE permission on the warehouse. Note: The warehouse_id is stored but not validated during space creation.
string
required
The contents of the Genie Space in serialized JSON string form. Must include a ‘version’ field (1 or 2). Optionally include ‘data_sources’ with a ‘tables’ array containing table identifiers in catalog.schema.table format. The API will normalize version 1 to version 2. Minimal valid example: ’{“version”:1}’. For production use, include data_sources to specify which tables the Genie space can query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_DELETE_CONVERSATIONTool 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.

Input Parameters

string
required
The unique identifier of the Genie space containing the conversation to delete
string
required
The unique identifier of the conversation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_DELETE_CONV_MESSAGETool 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.

Input Parameters

string
required
The ID associated with the Genie space where the message is located
string
required
The ID associated with the message to delete
string
required
The ID associated with the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_EXECUTE_MESSAGE_ATTACH_QUERYTool 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.

Input Parameters

string
required
Genie space ID - The unique identifier for the Genie space
string
required
Message ID - The unique identifier for the message within the conversation
string
required
Attachment ID - The unique identifier for the query attachment associated with the message
string
required
Conversation ID - The unique identifier for the conversation within the space

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_EXECUTE_MESSAGE_QUERYExecute the SQL query associated with a Genie message and retrieve result data. DEPRECATED: This endpoint is deprecated in favor of Execute Message Attachment Query (execute_message_attachment_query). The new method requires an attachment_id parameter in addition to space_id, conversation_id, and message_id. Use this action to run the query generated by Genie AI for a specific message. Returns query execution results including data rows, execution status, and schema information. This is useful for re-executing queries when needed.

Input Parameters

string
required
The ID associated with the Genie space where the conversation is located
string
required
The ID associated with the message containing the query to execute
string
required
The ID associated with the target conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGETool 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.

Input Parameters

string
required
The ID associated with the Genie space where the target conversation is located
string
required
The ID associated with the target message from the identified conversation
string
required
The ID associated with the target conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_ATTACH_QUERY_RESULTTool 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.

Input Parameters

string
required
The Genie space ID
string
required
The message ID
string
required
The query attachment ID from the message response
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_QUERY_RESULTTool 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.

Input Parameters

string
required
The ID associated with the Genie space where the conversation is located
string
required
The ID associated with the message that has a query attachment
string
required
The ID associated with the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_GET_MESSAGE_QUERY_RESULT_ATTACHTool 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.

Input Parameters

string
required
The Genie space ID
string
required
The message ID containing the query attachment
string
required
The attachment ID referencing the query results
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_GET_SPACETool 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.

Input Parameters

string
required
The unique identifier for the Genie space to retrieve
boolean
When 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_LIST_CONVERSATIONSTool 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.

Input Parameters

string
required
The unique identifier of the Genie space containing the conversations to retrieve
integer
Maximum number of conversations to return per page. Use for pagination to limit the number of results returned.
string
Token to get the next page of results. Use the next_page_token from a previous response to retrieve the next page.
boolean
Include 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_LIST_CONV_MESSAGESList messages from a specific conversation in a Genie space, including user queries and AI responses. Supports pagination to retrieve the conversation history across pages.

Input Parameters

string
required
The unique identifier of the Genie space where the conversation is located
integer
Maximum number of messages to return per page. Use for pagination to limit the number of results returned.
string
Token to get the next page of results. Use the next_page_token from a previous response to retrieve subsequent pages.
string
required
The unique identifier of the conversation thread to list messages from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_LIST_SPACESTool 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.

Input Parameters

integer
Maximum number of spaces to return per page. Used for pagination to control the number of results returned in a single request.
string
Pagination token for getting the next page of results. Use the next_page_token value from the previous response to retrieve the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_SEND_MESSAGE_FEEDBACKTool 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.

Input Parameters

string ("POSITIVE" | "NEGATIVE" | "NONE")
required
The feedback rating. POSITIVE indicates a positive feedback rating, NEGATIVE indicates a negative feedback rating, NONE indicates no feedback rating provided
string
required
The ID associated with the Genie space where the message is located
string
required
The ID associated with the message to provide feedback for
string
required
The ID associated with the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_START_CONVERSATIONTool 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.

Input Parameters

string
required
The text of the message that starts the conversation. This is the user’s initial question or prompt
string
required
The ID of the Genie space where you want to start a conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_TRASH_SPACETool 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.

Input Parameters

string
required
The unique identifier of the Genie space to move to trash. This ID uniquely identifies the Genie space within the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_GENIE_UPDATE_SPACETool 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.

Input Parameters

string
required
The unique identifier for the Genie space to update. This is the space_id from the list spaces API response.
string
Updated title/display name for the Genie Space. If provided, this will override the existing title.
string
Updated description of the Genie Space. Describes the space’s purpose, data sources, and intended use cases.
string
Updated SQL warehouse ID to associate with the Genie Space. If provided, this warehouse will be used for executing queries in this space.
string
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_CREATETool to create a new Lakeview dashboard in Databricks. Use when you need to create AI/BI dashboards for data visualization and analytics. Both display_name and serialized_dashboard are required. To create a blank dashboard, provide a minimal serialized_dashboard with an empty pages array like ’{“pages”:[{“name”:“page_001”,“displayName”:“Page 1”}]}’.

Input Parameters

string
The workspace path of the folder where the dashboard should be stored
string
required
The name to display for the dashboard
string
The UUID of the warehouse to use as the default warehouse for the dashboard. Can be omitted to use workspace defaults
string
required
JSON string containing the dashboard configuration and content. Must include at minimum a ‘pages’ array with at least one page object containing ‘name’ and ‘displayName’ fields. Use a minimal structure like ’{“pages”:[{“name”:“page_001”,“displayName”:“Page 1”}]}’ to create a blank dashboard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_DELETE_SCHEDULETool 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).

Input Parameters

string
The 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
string
required
UUID identifying the schedule to delete. This is a 32-digit alphanumeric value
string
required
UUID identifying the dashboard to which the schedule belongs. This is a 32-digit alphanumeric value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_EMBEDDED_GET_PUBLISHED_DASHRetrieves authorization information needed to generate a downscoped OAuth token for embedding a published Lakeview dashboard for external viewers. This endpoint returns the custom claims, scopes, and authorization details required to create a secure, limited-access OAuth token that allows external users to view a specific published dashboard. The returned information ensures the token has minimal necessary permissions and supports row-level security through custom claims. Use this when implementing embedded dashboard experiences for external users who should not have direct access to your Databricks workspace. The dashboard must first be published with embed_credentials enabled.

Input Parameters

string
required
The UUID identifier of the published Lakeview dashboard. The dashboard must be published with embed_credentials enabled to use this endpoint
string
required
A value that can be used for row-level data filtering in dashboard queries. This value will be embedded in the custom claim and can contain PII. Commonly used for email addresses or department identifiers
string
required
A unique, non-PII identifier for the external viewer. This is used to track the viewer and generate the custom claim. Should not contain personally identifiable information like email addresses or real names

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_GETTool 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.

Input Parameters

string
required
The UUID identifier for the dashboard. This is a 32-digit alphanumeric value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_GET_PUBLISHEDTool 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.

Input Parameters

string
required
The UUID identifier for the published dashboard. This is a 32-digit alphanumeric value that uniquely identifies the dashboard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_GET_SCHEDULERetrieve a specific schedule for a Databricks AI/BI Lakeview dashboard, including cron expressions, pause status, and warehouse configuration. Each dashboard can have up to 10 schedules, with each schedule supporting up to 100 subscriptions.

Input Parameters

string
required
UUID identifying the schedule to retrieve. This is a 32-digit alphanumeric value
string
required
UUID identifying the dashboard to which the schedule belongs. This is a 32-digit alphanumeric value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_PUBLISHTool 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.

Input Parameters

string
required
The UUID identifier of the dashboard to publish. This is a 32-digit alphanumeric value
string
The 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
boolean
Flag 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_TRASHTool 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.

Input Parameters

string
required
The UUID identifier for the dashboard to be trashed. This is a 32-digit alphanumeric value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_UNPUBLISHTool 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.

Input Parameters

string
required
The UUID identifier of the dashboard to unpublish. This is a 32-digit alphanumeric value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DASHBOARDS_LAKEVIEW_UPDATETool 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.

Input Parameters

string
The 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
string
The workspace path of the folder containing the dashboard (with leading slash). When provided, moves the dashboard to a new location
string
required
UUID identifying the dashboard to update. This is required to identify which dashboard to modify
string
The display name of the dashboard. When provided, updates the dashboard name
string
The warehouse ID used to run the dashboard. When provided, updates the default warehouse
string
Sets the default schema for all datasets in this dashboard. When provided, updates the default schema
string
Sets the default catalog for all datasets in this dashboard. When provided, updates the default catalog
string
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_CREATE_DATABASE_CATALOGTool to register a Lakebase Postgres database as a Unity Catalog catalog in Databricks. Use when you need to register a Lakebase database instance as a catalog in Unity Catalog for data governance and analytics. Requires CREATE CATALOG privilege on the metastore and access to the database instance.

Input Parameters

string
required
The name of the Unity Catalog catalog to create. Must be unique within the metastore
string
Optional description for the catalog
string
required
The name of the Postgres database within the instance to register (default is ‘databricks_postgres’)
string
required
The name of the Lakebase database instance to register
boolean
Whether to create the Postgres database if it doesn’t exist in the instance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_CREATE_DATABASE_INSTANCECreates a new Lakebase Provisioned database instance in Databricks. Lakebase is Databricks’ serverless PostgreSQL-compatible database service for OLTP workloads. Use this action to provision a new database instance with specified compute capacity and configuration. The creator automatically receives database owner privileges with the databricks_superuser role, granting full administrative capabilities on the instance including schema management, user provisioning, and data operations. The instance will initially be in STARTING state during provisioning, then transition to AVAILABLE when ready for connections. Use the returned read_write_dns endpoint to connect PostgreSQL clients and applications. Note: Requires available credits/billing setup in your Databricks workspace. Instance creation may take several minutes to complete.

Input Parameters

string
required
Unique database instance identifier. Must be 1-63 characters long, containing only lowercase letters (a-z) and hyphens (-). Cannot start or end with a hyphen
string ("CU_1" | "CU_2" | "CU_4" | "CU_8")
Compute capacity units (CUs) allocated to the instance. Each CU provides approximately 16GB RAM with associated CPU and local SSD resources. CU_1 for minimal/testing workloads, CU_2 for light production workloads, CU_4 for moderate workloads, CU_8 for intensive workloads
array
Optional list of custom key-value tag pairs to organize and categorize the instance for billing, access control, or organizational purposes
string
Optional usage policy identifier to govern and restrict instance usage patterns and access controls
boolean
Whether to enable native PostgreSQL password-based authentication. When enabled, allows direct PostgreSQL client connections using username/password credentials. Defaults to false (OAuth-based authentication only)
integer
Point-in-time recovery (PITR) window in days. Determines how far back in time you can restore the database. Valid range: 2-35 days. If not specified, defaults to 7 days

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_DELETE_DATABASE_INSTANCEDelete a Databricks Lakebase Postgres database instance. Permanently removes the database instance and all associated data. Prerequisites: The instance should be stopped before deletion, and you must have CAN_MANAGE permissions on the instance. Warning: This operation cannot be undone. All data will be permanently deleted. Consider deleting associated Unity Catalog catalogs and synced tables first to avoid orphaned references.

Input Parameters

string
required
The name of the database instance to delete. Must be 1-63 characters, containing only lowercase letters, numbers, and hyphens
boolean
When set to true, deletes child instances along with the parent instance. Use this to cascade deletion to descendant instances created via PITR (Point-in-Time Recovery). Default is false
boolean
required
Safety confirmation parameter that must be set to true to delete the database instance. This confirms intentional deletion and is required by the API

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_DELETE_SYNCED_DATABASE_TABLETool 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.

Input Parameters

string
required
Full 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_FIND_DATABASE_INSTANCE_BY_UIDTool 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.

Input Parameters

string
required
UID of the database instance to retrieve. An immutable UUID identifier for the instance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_GENERATE_DATABASE_CREDTool 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.

Input Parameters

string
Additional claims for the credential request. Added in SDK v0.58.0 for extending token capabilities
string
required
A unique request identifier, typically generated as a UUID. This identifier helps track the credential generation request
array
required
List 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATABASE_DATABASE_GET_DATABASE_INSTANCERetrieves detailed information about a Databricks Lakebase (managed PostgreSQL) database instance by name. Returns comprehensive instance details including: - Current state (AVAILABLE, STARTING, STOPPED, UPDATING, DELETING, FAILING_OVER) - Capacity/SKU configuration (CU_1, CU_2, CU_4, CU_8) - Connection endpoints (read-write DNS, read-only DNS) - PostgreSQL version and node configuration - Retention window and backup settings - High availability settings (readable secondaries) - Custom tags and usage policies - Parent/child instance relationships Use this when you need to check instance status, retrieve connection information, or verify configuration settings.

Input Parameters

string
required
The name of the database instance to retrieve. This is the unique identifier for the instance (1-63 characters, letters and hyphens only)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DATAQUALITY_DATA_QUALITY_CREATE_MONITORTool 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.

Input Parameters

object
Schedule configuration for auto-refresh.
object
Snapshot table monitoring configuration. Use empty object for snapshot monitoring.
string
required
Absolute path to directory for storing monitoring assets (e.g., /Workspace/Users/{user}/databricks_lakehouse_monitoring/{catalog}.{schema}.{table_name})
string
required
Fully qualified Unity Catalog table name in format {catalog}.{schema}.{table_name}. Must be a managed or external Delta table.
object
Time series monitoring configuration.
string
Warehouse ID for dashboard creation
object
Inference log monitoring configuration for ML models.
object
Notification settings for quality monitor.
array
Column expressions for data slicing
array
Custom metric definitions
string
required
Schema for output metric tables in format {catalog}.{schema}
string
Baseline table for drift metrics. Must match monitored table schema.
boolean
Skip default dashboard creation
object
Data classification configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DBFS_LISTTool 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.

Input Parameters

string
required
The absolute DBFS path of the file or directory to list. Must be an absolute path starting with ’/‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_DELETE_CLUSTERTool 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.

Input Parameters

string
required
The unique identifier of the cluster to terminate. This can be found in the Databricks workspace URL when viewing a cluster configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_EDIT_CLUSTERTool 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.

Input Parameters

object
Autoscaling configuration for cluster workers.
string
Cluster policy ID to validate configuration and preset defaults
string
required
Unique identifier of the cluster to edit. The cluster must be in RUNNING or TERMINATED state
object
Custom Spark configuration key-value pairs
object
User-defined resource tags (max 45 tags). Serverless clusters should have ResourceClass=Serverless tag
integer
Number of worker nodes. Total Spark nodes = num_workers + 1 (driver). Use 0 for single-node clusters. Required unless using autoscale
string
User-defined name for the cluster; does not need to be unique
object
Docker container configuration.
array
Initialization scripts executed sequentially at cluster startup
string
Node 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
string
required
Runtime version of the cluster (e.g., ‘11.3.x-scala2.12’, ‘12.2.x-scala2.12’, ‘13.x-scala2.12’)
object
Workload type restrictions for cluster usage.
object
AWS-specific cluster configuration.
object
GCP-specific cluster configuration.
boolean
When true, automatically configures single-node settings (sets num_workers to 0)
string ("STANDARD" | "PHOTON")
Runtime engine type. Defaults to STANDARD unless spark_version contains ‘-photon-’
object
Environment variables for Spark clusters
array
SSH public keys to add to each Spark node (max 10 keys). Login with username ‘ubuntu’ on port 2200
object
Azure-specific cluster configuration.
object
Cluster log delivery configuration.
string
Instance pool identifier for worker nodes (alternative to node_type_id)
string
Username to assign to an interactive cluster (required for SINGLE_USER mode)
string
Token to guarantee idempotency (max 64 characters)
string ("SINGLE_USER" | "USER_ISOLATION" | "LEGACY_TABLE_ACL" | "LEGACY_PASSTHROUGH" | "LEGACY_SINGLE_USER" | "NONE")
Security features of the cluster. Unity Catalog requires SINGLE_USER or USER_ISOLATION mode
array
Remote storage mount configurations
string
Node type for the Spark driver. Defaults to node_type_id if not specified
boolean
Enables autoscaling local storage instead of fixed EBS volumes
integer
Automatically terminate after inactivity. Valid range: 10-10000 minutes
string
Instance pool identifier for driver node
boolean
Whether to apply policy default values
boolean
Enables encryption for locally attached disk data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_FILES_DBFS_ADD_BLOCKTool 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.

Input Parameters

string
required
The 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
integer
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_FILES_DBFS_CREATETool 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.

Input Parameters

string
required
The 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
boolean
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_FILES_DBFS_DELETETool 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.

Input Parameters

string
required
The absolute DBFS path of the file or directory to delete
boolean
Whether 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_FILES_DBFS_GET_STATUSTool 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.

Input Parameters

string
required
The absolute DBFS path of the file or directory. The path should be the absolute DBFS path (e.g., ‘/FileStore/wheels/test_packages’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_FILES_DBFS_MOVETool 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.

Input Parameters

string
required
The 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
string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_FILES_DBFS_READRead file contents from DBFS, returning base64-encoded data and the number of bytes read. Each request accepts a read length of at most 1 MB.

Input Parameters

string
required
The 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
integer
The 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
integer
The offset to read from in bytes. Default is 0. Must be non-negative

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_GET_ALL_LIBRARY_STATUSESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_GET_CLUSTERTool 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.

Input Parameters

string
required
The unique identifier of the cluster to retrieve information about

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_GET_USER_BY_IDRetrieve a Databricks workspace user by ID through the SCIM 2.0 API. Returned details may include identity, contact information, group memberships, roles, and entitlements; attributes can be selected or excluded.

Input Parameters

string
required
The unique Databricks user identifier. This is the SCIM user ID that can be obtained from user listing or creation operations.
string
Comma-separated list of attribute names to return, overriding the default set of attributes returned.
string
Comma-separated list of attribute names to exclude from the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_ACCOUNT_ACCESS_CONTROL_UPDATE_RULE_SETTool 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.

Input Parameters

string
required
Unique 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’
object
required
Container 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_ACCOUNT_GROUPS_V2_GETTool 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.

Input Parameters

string
required
The unique identifier for the account-level group resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_CURRENT_USER_METool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_GROUPS_V2_CREATETool 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.

Input Parameters

array
Roles assigned to the group. Corresponds to AWS instance profile/ARN role.
array
Parent groups this group belongs to.
array
Array of member objects to add to the group. Each object contains a ‘value’ field with the user or group ID.
string
External identifier from an identity provider for SCIM synchronization.
string
required
Human-readable group name. Must be unique within the workspace.
array
Permissions/entitlements assigned to the group (e.g., workspace-access, allow-cluster-create, databricks-sql-access).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_GROUPS_V2_DELETETool 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.

Input Parameters

string
required
Unique identifier of the group to delete. This is the Databricks-generated group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_GROUPS_V2_GETTool 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.

Input Parameters

string
required
Unique identifier for the group in the Databricks workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_GROUPS_V2_PATCHPartially update a Databricks workspace group using SCIM 2.0 PATCH operations. Add, remove, or replace group attributes, such as the display name, members, entitlements, or roles.

Input Parameters

string
required
Unique ID of the group in the Databricks workspace to update
array
required
Array 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_GROUPS_V2_UPDATETool 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.

Input Parameters

string
required
Unique identifier of the group to update. This is the Databricks-generated group ID
array
Roles assigned to the group. Corresponds to AWS instance profile/ARN role. This replaces the entire role list.
array
Parent groups this group belongs to. This replaces the entire parent group list.
array
Array of member objects. This replaces the entire member list. Each object contains a ‘value’ field with the user or group ID.
string
External identifier from an identity provider for SCIM synchronization.
string
required
Human-readable group name for the group. Must be unique within the workspace.
array
Permissions/entitlements assigned to the group. This replaces the entire entitlement list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_PERMISSIONS_GETTool 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.

Input Parameters

string
required
The unique identifier for the specific resource instance. This is typically a 32-character string or a resource_id depending on the object type
string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_PERMISSIONS_GET_PERMISSION_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the workspace object. Format varies by object type (e.g., numeric for notebooks, UUID-like for warehouses and dashboards).
string ("alerts" | "authorization" | "clusters" | "cluster-policies" | "dashboards" | "dbsql-dashboards" | "directories" | "experiments" | "files" | "genie" | "instance-pools" | "jobs" | "notebooks" | "pipelines" | "queries" | "registered-models" | "repos" | "serving-endpoints" | "warehouses")
required
The type of the workspace object. Defines the category of the object for which permission levels are being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_PERMISSIONS_SETTool 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.

Input Parameters

string
required
The unique identifier for the specific resource instance
string
required
The 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
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_PERMISSIONS_UPDATETool 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.

Input Parameters

string
required
Unique 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
string
required
Type 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’
array
required
List 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_PERM_MIGRATION_MIGRATE_PERMSTool 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.

Input Parameters

integer
Maximum number of permissions to migrate. Allows for batch processing by limiting the number of permissions migrated in a single request.
string
required
Workspace ID where the permission migration occurs. The identifier of the Databricks workspace containing the permissions to migrate.
string
required
Name of the account group permissions migrate to. The target account-level group that will receive the migrated permissions.
string
required
Name of the workspace group permissions migrate from. The source workspace-level group whose permissions will be migrated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_CREATETool 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.

Input Parameters

array
Roles assigned to the service principal for role-based access control.
boolean
Activation status of the service principal. Defaults to true if not specified.
array
Group memberships for the service principal. Used for assigning the service principal to specific groups.
string
An identifier from an external system for correlation with identity providers.
string
User-friendly display name for the service principal. May be auto-generated if not provided in some configurations.
array
Workspace entitlements and permissions assigned to the service principal (e.g., allow-cluster-create, can-manage, workspace-access, databricks-sql-access).
string
required
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_DELETEDelete a service principal from a Databricks workspace using SCIM v2. A 404 response is treated as success, including when the principal was already deleted or never existed.

Input Parameters

string
required
Unique 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)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_GETTool 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.

Input Parameters

string
required
Unique identifier for the service principal in the Databricks workspace
string
Comma-separated list of attribute names to return in the response
string
Comma-separated list of attribute names to exclude from the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_PATCHTool 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.

Input Parameters

string
required
Unique identifier for the service principal in the Databricks workspace to update
array
required
Array 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_SERVICE_PRINCIPALS_V2_UPDATETool 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.

Input Parameters

string
required
The unique identifier of the service principal to update. This is the Databricks workspace-level ID, not the applicationId.
array
Roles assigned to the service principal for role-based access control. This replaces the entire role list.
boolean
Activation status of the service principal. Set to false to deactivate without deleting.
array
Group memberships for the service principal. This replaces the entire group membership list.
string
External identifier from an identity provider for SCIM synchronization.
string
User-friendly display name for the service principal. IMPORTANT: In identity-federated workspaces (Azure AD, AWS IAM, etc.), this field is read-only and managed by the identity provider. Changes to this field will be ignored by the API. For non-federated workspaces, you can update this field.
array
Workspace entitlements and permissions assigned to the service principal. This replaces the entire entitlement list.
string
required
The unique UUID identifier for the service principal (also known as Client ID). This field is immutable and cannot be changed after creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_USERS_V2_CREATETool 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.

Input Parameters

object
SCIM name object for user names.
array
Array of roles to assign to the user
boolean
Account activation status (default: true)
array
Array of email objects for the user
array
Array of group IDs to assign the user to
string
required
Unique identifier for the user account, typically the user’s email address
string
External system reference identifier (reserved for future use)
string
String representing concatenation of given and family names
array
Array of entitlements to assign to the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_USERS_V2_DELETETool 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.

Input Parameters

string
required
Unique identifier for the user in the Databricks workspace. This is the user’s Databricks ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_USERS_V2_PATCHTool 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.

Input Parameters

string
required
Unique identifier for the user in the Databricks workspace to update
array
required
Array 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAM_USERS_V2_UPDATETool to update a user in Databricks workspace using SCIM v2 protocol. This performs a complete replacement (PUT) of the user resource. Use when you need to update user properties including userName, displayName, active status, emails, entitlements, or roles. IMPORTANT LIMITATIONS: - Groups cannot be updated via workspace-level API. Groups for account-level users are managed at the account level only. - For partial updates (updating specific fields without replacing the entire resource), use the PATCH operation instead. - The ‘groups’ parameter is included for response compatibility but will be ignored in requests to avoid API errors.

Input Parameters

string
required
Databricks user ID to update
object
SCIM name object for user names.
array
Array of roles to assign to the user. This replaces the entire role list.
boolean
Account activation status (true = active, false = inactive)
array
Array of email objects for the user
array
DEPRECATED: Groups cannot be updated via workspace SCIM API. This parameter is kept for schema compatibility but will be ignored. Group memberships for account users must be managed at the account level.
string
required
Unique identifier for the user account, typically the user’s email address. This field is required for complete replacement updates.
string
External system reference identifier (reserved for future use)
string
String representing concatenation of given and family names
array
Array of entitlements to assign to the user. This replaces the entire entitlement list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_IAMV2_WORKSPACE_IAM_V2_GET_WORKSPACE_ACCESSRetrieves workspace access details for a specific principal (user, service principal, or group) in Databricks. Returns information about the principal’s workspace access including their principal ID, workspace ID, account ID, principal type (USER/SERVICE_PRINCIPAL/GROUP), access type (DIRECT/INHERITED), and access status (ACTIVE/INACTIVE). Use this to verify workspace access assignments and understand how identities are granted access to the workspace.

Input Parameters

string
required
The principal ID (user ID, service principal ID, or group ID) to retrieve workspace access details for. This is the unique numeric identifier of the identity whose workspace access you want to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOB_COMPLIANCE_LISTCOMPLIANCERetrieve a page of policy compliance status for jobs using a given cluster policy. Use it to identify jobs whose clusters no longer meet the requirements of a policy updated after the jobs were last edited; additional pages can be requested using the returned token.

Input Parameters

integer
Number of results to return per page. If not specified, the default page size is used.
string
required
The cluster policy identifier to check compliance against. This field is required.
string
Token for pagination to retrieve next page of results. Use the next_page_token from the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOB_RUN_BY_IDTool 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.

Input Parameters

integer
required
The canonical identifier of the run for which to retrieve the metadata. This field is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_JOBS_CANCEL_ALL_RUNSCancel all active runs of a Databricks job asynchronously. Requires either job_id or all_queued_runs=true. With job_id: cancels all active runs of the specified job. With all_queued_runs=true (no job_id): cancels all queued runs in the workspace. Cancellation is asynchronous and does not prevent new runs from starting. Use with caution when cancelling workspace-wide runs.

Input Parameters

integer
The canonical identifier of the job to cancel all runs of. If provided, cancels all active runs of this specific job. Either this field or all_queued_runs must be provided.
boolean
When true, cancels all queued runs in the entire workspace (if no job_id provided) or all queued runs of the specified job (if job_id provided). Either this field (set to true) or job_id must be provided. Setting to false has no effect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_JOBS_CANCEL_RUNTool 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.

Input Parameters

integer
required
The canonical identifier of the run to cancel. This field is required to specify which job run should be cancelled. The cancellation happens asynchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_JOBS_DELETE_RUNTool 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.

Input Parameters

integer
required
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_JOBS_GETTool 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.

Input Parameters

integer
required
The canonical identifier of the job to retrieve information about. This field is required.
string
Token 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_JOBS_GET_PERMISSION_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the job for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_JOBS_SET_PERMISSIONSTool 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 with the provided list. To remove all permissions except the owner, provide an empty array. The job must have exactly one owner (cannot be a group).

Input Parameters

string
required
The unique identifier of the job for which to set permissions
array
required
Array of access control entries. This replaces ALL existing permissions. To remove all permissions except the owner, provide an empty array. For each entry, only one of user_name, group_name, or service_principal_name should be specified. The job must have exactly one owner

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_JOBS_POLICY_COMPL_FOR_JOBS_GET_COMPLTool 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.

Input Parameters

integer
required
The ID of the job whose compliance status you are requesting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_CATALOGSList catalogs in the Unity Catalog metastore based on the caller’s permissions. Results may be paginated; use the returned next-page token to retrieve further pages.

Input Parameters

string
Opaque pagination token to retrieve the next page based on previous query. Obtained from the next_page_token field in the previous response.
integer
Maximum 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.
boolean
Whether to include catalogs in the response for which the principal can only access selective metadata through the BROWSE privilege. Default is false.
boolean
Whether 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_CLUSTERSTool 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.

Input Parameters

object
Sorting criteria for cluster listing.
object
Filter criteria for cluster listing.
integer
Maximum number of results per page for pagination
string
Token for navigating to next or previous pages in paginated results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_GROUPSList groups in the Databricks workspace using SCIM v2, with optional filtering and pagination. Results may contain only a page of matching groups.

Input Parameters

integer
Maximum number of results to return per page. Negative values treated as zero
string
Query 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’
string
Attribute name to sort results by. For multi-valued attributes, uses primary or first value. Complex attributes require sub-attribute notation
string ("ascending" | "descending")
Sort direction, either ‘ascending’ or ‘descending’. Defaults to ascending
string
Comma-separated list of attribute names to include in the response. Overrides default attribute set
integer
The 1-based index position of the first result to return. First item is number 1. Used for pagination
string
Comma-separated list of attribute names to exclude from the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_INSTANCE_POOLSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_JOBSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_MEMBERS_OF_A_SECURITY_GROUPTool 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.

Input Parameters

string
required
The name of the group whose members you want to list. Administrator privileges are required to invoke this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_MODEL_SERVING_ENDPOINTSLists all model serving endpoints in the Databricks workspace. This includes both foundation model endpoints (e.g., GPT, Claude, Llama) and custom model endpoints. Returns comprehensive information for each endpoint: - Endpoint name, ID, type, and task (chat, completions, embeddings) - Current state and readiness status - Served entities/models configuration with pricing details - Endpoint capabilities (function calling, image input, long context) - Traffic routing configuration - Permission level and metadata Use this to discover available AI models, check endpoint status, or gather configuration details for making API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_PIPELINESTool 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.

Input Parameters

string
Narrows results based on criteria using SQL-like syntax. Supports filtering by notebook path or name patterns with wildcards. Composite filters are unsupported.
array
Ordering specification for results. Supported fields are ‘id’ and ‘name’. Default ordering is ‘id asc’.
string
Opaque pagination token from a previous call to fetch the next page of results. Cannot be used together with filter parameter.
integer
Maximum number of pipelines to return per page. Default is 25; maximum allowed value is 100. An error occurs if exceeded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_REPOSTool 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.

Input Parameters

string
Filters 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.
string
Token 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_RUNSTool 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.

Input Parameters

integer
The 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.
integer
The job for which to list runs. If omitted, the Jobs service will list runs from all jobs.
integer
The offset of the first run to return, relative to the most recent run. Used for pagination.
string
The type of runs to return. Supported values: JOB_RUN, WORKFLOW_RUN, SUBMIT_RUN.
boolean
If 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.
boolean
Whether to include task and cluster details in the response. When true, provides comprehensive information about each run’s tasks and associated clusters.
integer
Show runs that started at or before this value (epoch milliseconds). Use with start_time_from to filter runs by time range.
boolean
If true, only completed runs are included in the results. Cannot be true when active_only is true.
integer
Show runs that started at or after this value (epoch milliseconds). Use with start_time_to to filter runs by time range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_SCHEMASList schemas in a specified Unity Catalog catalog based on the caller’s permissions. Results may be paginated; use the returned next page token to retrieve subsequent pages.

Input Parameters

string
Opaque pagination token to retrieve the next page based on previous query. Obtained from the next_page_token field in the previous response.
integer
Maximum 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.
string
required
Parent catalog for schemas of interest. The name of the catalog to list schemas from.
boolean
Whether 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_SECRETSTool 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.

Input Parameters

string
required
The name of the scope to list secrets within

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_SECRET_SCOPESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_SQL_WAREHOUSESLists SQL warehouses in the Databricks workspace, returning a page of available warehouse information, which may include configuration, state, and connection details. A next-page token can be used to retrieve further results.

Input Parameters

integer
The maximum number of warehouses to return per page
string
A 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
integer
Service Principal which will be used to fetch the list of endpoints. If not specified, SQL Gateway will use the user from the session header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_TABLESTool 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.

Input Parameters

string
Opaque pagination token to go to the next page based on previous query. Continue reading pages until next_page_token is absent in the response
integer
Maximum 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)
string
required
Parent schema of tables to list
string
required
Name of parent catalog for tables of interest
boolean
Whether to omit the columns of the table from the response
boolean
Whether to omit the username of the table (e.g. owner, updated_by, created_by)
boolean
Whether to include tables in the response for which the principal can only access selective metadata through the BROWSE privilege
boolean
Whether to omit the properties of the table from the response
boolean
Whether 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)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_TOKENSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_USERSTool 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.

Input Parameters

integer
Maximum number of user records to return per request. Databricks returns at most 100 users at a time.
string
SCIM-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”’
string
Attribute name to sort results by. Supports multi-part paths such as userName, name.givenName, and emails.
string ("ascending" | "descending")
Sort direction. Valid values: ‘ascending’ or ‘descending’.
string
Comma-separated list of specific attributes to include in response. Allows selective field retrieval.
integer
Starting position for paginated results using 1-based indexing. First item is number 1. Used with count parameter for pagination.
string
Comma-separated list of attributes to exclude from response. Inverse of attributes parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_LIST_VECTOR_SEARCH_ENDPOINTSTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MARKETPLACE_CONSUMER_LISTINGS_GETTool 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.

Input Parameters

string
required
Unique identifier of the marketplace listing to retrieve. This is a UUID-formatted string that identifies a specific published listing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MARKETPLACE_CONSUMER_PROVIDERS_GETTool 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.

Input Parameters

string
required
The provider identifier to retrieve. This is a unique identifier for the marketplace provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MARKETPLACE_PROVIDER_LISTINGS_CREATETool 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.

Input Parameters

object
required
Complete listing configuration including summary, optional share, and detailed metadata

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MARKETPLACE_PROVIDER_LISTINGS_GETTool 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.

Input Parameters

string
required
The unique identifier of the listing to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_CONSUMER_INSTALLATIONS_CREATETool 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.

Input Parameters

string
required
The listing ID to install from
string
The name of the share
object
Configuration for git repository installations.
string
The name of the catalog for installation
string ("DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS" | "DELTA_SHARING_RECIPIENT_TYPE_OPEN")
Type of Delta Sharing recipient
object
Consumer terms acceptance details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_CONSUMER_INSTALLATIONS_DELETETool 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.

Input Parameters

string
required
The marketplace listing identifier to uninstall from
string
required
The installation identifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_CONSUMER_INSTALLATIONS_UPDATETool 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.

Input Parameters

string
Unique installation identifier
string ("INSTALLED" | "FAILED")
Installation state
array
Collection of token records
string
Git repository name for repo-based installs
string
Repository file path reference
string
required
The listing ID associated with the installation
string
Delta Share name for data assets
string
Target catalog for installation
integer
Timestamp of installation in epoch milliseconds
string
Human-readable listing name
boolean
Flag 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.
object
Details about access tokens.
string
Error details if installation failed
string ("DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS" | "DELTA_SHARING_RECIPIENT_TYPE_OPEN")
Recipient classification (Databricks or Open)
string
required
The installation ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_CONSUMER_LISTINGS_BATCH_GETRetrieve multiple published marketplace listings by their IDs in a single API call. The response can include listing summaries and details; an HTTP 404 is returned as an empty listings array, so an empty result does not necessarily establish listing availability.

Input Parameters

array
List of UUID-formatted listing identifiers to retrieve. Maximum of 50 IDs per request. Returns only listings the caller has permission to access. Omit this parameter or pass empty list to return no results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_CONSUMER_PERSONALIZATION_REQUESTS_GETRetrieve personalization requests for a specific marketplace listing to check the status of customization or commercial transaction requests; each consumer can make at most one request per listing. An HTTP 404 is returned as an empty list, which does not distinguish a missing listing from no requests.

Input Parameters

string
required
The unique identifier of the marketplace listing for which to retrieve personalization requests

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_CONSUMER_PROVIDERS_BATCH_GETRetrieve multiple marketplace provider details in a single batch API call. Returns information about Databricks Marketplace providers that have at least one publicly visible listing. Use this tool when you need to get details for multiple providers efficiently (up to 50 providers per request). Provider information includes contact details, descriptions, branding assets, and policy links.

Input Parameters

array
A list of provider IDs (UUIDs) to retrieve. Maximum 50 IDs can be specified per request. If not provided, returns an empty list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_PROVIDER_ANALYTICS_DASHBOARDS_CREATETool 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.

Input Parameters

integer
The version of the dashboard template to use. Should equal the latest version if updating an existing dashboard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_PROVIDER_ANALYTICS_DASHBOARDS_GETTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_PROVIDER_ANALYTICS_DASH_GET_LATESTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_MKTPLACE_PROVIDER_EXCHANGES_DELETE_LISTINGTool 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.

Input Parameters

string
required
The identifier for the exchange-listing association to remove. This ID represents the specific association between an exchange and a listing that should be disassociated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_CREATE_EXPERIMENTTool 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.

Input Parameters

string
required
Experiment name. This field is required and must be unique within the workspace
array
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
string
Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_CREATE_LOGGED_MODELTool 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.

Input Parameters

string
Name of the model. If not specified, the backend will generate one automatically
array
LoggedModel tags as key-value pairs. Each tag consists of a key and a value
array
LoggedModel parameters as key-value pairs. Each parameter consists of a key and a value
string
The type of model, such as ‘Agent’, ‘Classifier’, ‘LLM’, or ‘sklearn’. Used to search and compare related models
string
required
ID of the associated experiment. This field is required
string
Run ID of the run that created this model

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_CREATE_RUNTool 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.

Input Parameters

array
Additional metadata for the run as key-value pairs. Tags can be used to categorize, filter, and organize runs.
string
ID of the user executing the run. This field is deprecated as of MLflow 1.0 and should not be used in new implementations.
string
Name assigned to the run. This is a human-readable identifier for the run.
integer
Unix timestamp in milliseconds of when the run started. If not provided, the current time will be used.
string
The associated experiment identifier. This is the ID of the experiment under which the run will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_DELETE_EXPERIMENTTool 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.

Input Parameters

string
required
ID of the associated experiment. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_DELETE_LOGGED_MODELTool 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.

Input Parameters

string
required
The 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()

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_DELETE_LOGGED_MODEL_TAGTool 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.

Input Parameters

string
required
The tag key to delete. Maximum size is 255 bytes. This operation is irreversible.
string
required
The 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()

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_DELETE_RUNTool 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.

Input Parameters

string
required
ID of the run to delete. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_DELETE_RUNSTool 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.

Input Parameters

integer
A 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
string
required
The ID of the experiment containing the runs to delete. This field is required
integer
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_DELETE_TAGTool 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.

Input Parameters

string
required
Name of the tag to delete. Maximum size is 255 bytes. This operation is irreversible.
string
required
ID of the run that the tag was logged under. This is the unique identifier for the MLflow experiment run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_FINALIZE_LOGGED_MODELTool 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+.

Input Parameters

string ("LOGGED_MODEL_READY" | "LOGGED_MODEL_UPLOAD_FAILED")
required
Final 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
string
required
The unique identifier of the logged model to finalize. This ID is assigned when the model is initially created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_GET_BY_NAMETool 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.

Input Parameters

string
required
Name of the associated experiment. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_GET_EXPERIMENTTool 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.

Input Parameters

string
required
ID of the associated experiment. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_GET_LOGGED_MODELTool 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.

Input Parameters

string
required
The unique identifier (model_id) of the logged model to retrieve. Must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_GET_PERMISSION_LEVELSTool 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 (CAN_READ, CAN_EDIT, CAN_MANAGE) with their descriptions.

Input Parameters

string
required
The numeric string identifier of the MLflow experiment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_GET_PERMISSIONSTool 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.

Input Parameters

string
required
The ID of the experiment for which to get permissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_GET_RUNTool 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.

Input Parameters

string
required
ID of the run to fetch. Must be provided. Unique identifier for the run.
string
Deprecated parameter; use run_id instead. Will be removed in future MLflow versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_BATCHTool 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.

Input Parameters

array
Tags to log. Each tag includes key and value. Items are processed sequentially in order. Maximum 100 tags
array
Parameters to log. Each param includes key and value. Items are processed sequentially in order. Maximum 100 parameters
string
required
ID of the run to log under. This identifies the specific MLflow run for which metrics, params, and tags will be logged
array
Metrics to log. Each metric includes key, value, timestamp, and optional step. Items are processed sequentially in order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_INPUTSTool 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.

Input Parameters

string
required
ID of the run to log under. This field is required. The unique identifier for the MLflow run where dataset inputs will be logged
array
Collection of dataset inputs being logged to the run. Each entry contains dataset metadata and optional tags

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_LOGGED_MODEL_PARAMSTool 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+.

Input Parameters

string
required
The unique identifier (model_id) of the logged model to log params for. Must be provided
array
required
Parameters to attach to the logged model. Each parameter is a key-value pair where both key and value are strings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_METRICTool 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.

Input Parameters

string
required
Name of the metric. May only contain alphanumerics, underscores (_), dashes (-), periods (.), spaces ( ), and slashes (/). Maximum length is 250 characters
integer
Integer training step (iteration) at which the metric was calculated
number
required
Double value of the metric being logged. Note that some special values such as +/- Infinity may be replaced by other values depending on the store
string
required
ID of the run under which to log the metric. Must be provided
integer
required
Unix timestamp in milliseconds at the time metric was logged. Defaults to current system time if not provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_MODELLog model metadata for an MLflow run using the experimental API. Supply a complete MLmodel specification as a JSON string, including metadata such as artifact path, flavors, and version information.

Input Parameters

string
required
ID of the run to log the model under. This field is required
string
required
MLmodel 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_OUTPUTSTool 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.

Input Parameters

string
required
ID of the run to log under. This field is required. The unique identifier for the MLflow run where dataset outputs will be logged
array
Collection of dataset outputs being logged to the run. Each entry contains dataset metadata and optional tags

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_LOG_PARAMTool 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.

Input Parameters

string
required
Name of the param. Maximum size is 255 bytes. This field is required
string
required
String value of the param being logged. Maximum size is 6000 bytes
string
required
ID of the run under which to log the param. Must be provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_RESTORE_EXPERIMENTTool 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.

Input Parameters

string
required
ID of the associated experiment. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_RESTORE_RUNTool 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.

Input Parameters

string
required
ID of the run to restore. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_RESTORE_RUNSTool 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.

Input Parameters

integer
An 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
string
required
The ID of the experiment containing the runs to restore. This field is required
integer
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_SEARCH_LOGGED_MODELSTool 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.

Input Parameters

string
A 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
array
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
array
The list of columns for ordering the results. Can order by metrics, params, or model attributes
string
The token indicating the page of logged models to fetch for pagination. Obtained from the next_page_token in a previous response
integer
The maximum number of logged models to return. The maximum limit is 50
array
The IDs of the experiments in which to search for logged models. Note: While optional in the schema, this parameter is effectively required by the Databricks API - requests without it will return a 400 error. Recommended to always provide at least one experiment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_SET_EXPERIMENT_TAGTool 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.

Input Parameters

string
required
Name of the tag. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 250 bytes in size.
string
required
String 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.
string
required
ID of the experiment under which to log the tag. Must be provided. This is the unique identifier for the MLflow experiment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_SET_LOGGED_MODEL_TAGSTool 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.

Input Parameters

array
required
Array 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
string
required
The 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()

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_SET_PERMISSIONSTool 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.

Input Parameters

string
required
The ID of the MLflow experiment
array
required
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_SET_TAGTool 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.

Input Parameters

string
required
Name of the tag. Maximum size is 250 bytes. All storage backends are guaranteed to support key values up to 250 bytes in size.
string
required
String 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.
string
required
ID of the run under which to log the tag. This is the unique identifier for the MLflow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_UPDATE_EXPERIMENTTool 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.

Input Parameters

string
required
The 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
string
required
ID of the associated experiment. This field is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_UPDATE_PERMISSIONSTool 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.

Input Parameters

string
required
The ID of the MLflow experiment
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_EXPERIMENTS_UPDATE_RUNTool 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.

Input Parameters

string
required
ID of the run to update. Must be provided. This is the unique identifier for the run you want to update.
string ("RUNNING" | "SCHEDULED" | "FINISHED" | "FAILED" | "KILLED")
Updated 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.
integer
Unix timestamp in milliseconds of when the run ended. Represents the end time in milliseconds since the UNIX epoch.
string
Updated name of the run. Used to rename the run for better identification.
string
Deprecated field; use run_id instead. Maintained for backwards compatibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_FEATURE_ENG_DELETE_KAFKA_CONFIGDelete a Kafka streaming source configuration from ML Feature Engineering by ID; deletion is permanent and cannot be undone. A 404 response is reported as success, so success does not confirm that a configuration was deleted.

Input Parameters

string
required
The unique identifier of the Kafka configuration to delete. This is the configuration ID that was assigned when the Kafka config was created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_FEATURE_STORE_CREATE_ONLINE_STORETool 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.

Input Parameters

string
required
Name of the online store to create. Must be unique and a valid identifier
string ("CU_1" | "CU_2" | "CU_4" | "CU_8")
required
Compute capacity units allocated to the online store. Each capacity unit allocates approximately 16GB of RAM with associated CPU and local SSD resources
integer
Number of read replicas for high availability. Default is 0, maximum is 2 (contact Databricks to increase limit). Scaling to zero is not supported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_FEATURE_STORE_DELETE_ONLINE_STORETool 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.

Input Parameters

string
required
The name of the online store to delete. This is the name that was assigned when the online store was created (e.g., ‘my_online_store’, ‘prod_store_001’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_FORECASTING_CREATE_EXPERIMENTTool 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.

Input Parameters

string
required
The name of the dataset table in the format catalog.schema.table or schema.table for use in forecasting
integer
required
The number of time steps into the future to forecast. Must be a positive integer
string
DBFS path where intermediate data will be stored during the AutoML run
string
required
The name of the column containing the time series timestamps
string
required
The frequency of the time series data. Common values: ‘D’ (daily), ‘W’ (weekly), ‘M’ (monthly), ‘H’ (hourly), ‘T’ or ‘min’ (minutely)
string
required
The name of the column containing the target values to forecast
array
List of column names that identify individual time series in the dataset. Use when the dataset contains multiple time series to forecast independently
string
The 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)
string
Name for the MLflow experiment that will be created to track this AutoML run
integer
Maximum time in minutes to run the AutoML forecasting experiment before timing out. If not specified, the experiment will run until completion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_MAT_FEATURES_DELETE_FEATURE_TAGDelete a metadata tag from a specific feature column in a Databricks ML Feature Store table without affecting feature data. The tool reports success on HTTP 404 as well as successful deletion, so a success response does not necessarily confirm the tag was removed.

Input Parameters

string
required
The name of the tag to delete. This operation is idempotent - deleting a non-existent tag will succeed without error
string
required
The name of the specific feature column within the feature table that has the tag to be deleted
string
required
The fully qualified name of the feature table in the format ‘catalog.schema.table_name’ (e.g., ‘samples.nyctaxi.trips’ or ‘main.feature_store.user_features’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_MAT_FEATURES_GET_FEATURE_TAGTool 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.

Input Parameters

string
required
The name of the tag to retrieve from the feature
string
required
The name of the feature within the feature table from which to retrieve the tag
string
required
The unique identifier of the feature table. This is typically the full name of the feature table (e.g., ‘samples.nyctaxi.trips’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_MAT_FEATURES_UPDATE_FEATURE_TAGTool 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.

Input Parameters

string
required
The new value to set for the tag
string
required
The name of the tag to update on the feature
string
required
The name of the feature within the feature table whose tag should be updated
string
required
The unique identifier of the feature table. This is typically the full name of the feature table (e.g., ‘samples.nyctaxi.trips’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_ML_MODEL_REGISTRY_GET_PERM_LEVELSRetrieves the list of available permission levels that can be assigned to users or groups for a Databricks ML registered model. This endpoint returns metadata about what permission levels are available (e.g., CAN_READ, CAN_EDIT, CAN_MANAGE, CAN_MANAGE_PRODUCTION_VERSIONS, CAN_MANAGE_STAGING_VERSIONS) with descriptions of what each level grants. Use this to understand permission options before setting or updating model permissions. The returned permission levels are standard across all registered models. Note: This returns the available permission level definitions, not the actual permissions currently assigned to the model. To view actual permissions, use the get permissions endpoint.

Input Parameters

string
required
The three-level (fully qualified) name of the registered model in Unity Catalog, formatted as catalog.schema.model_name. This identifier is used to reference the registered model across the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_DELETETool 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.

Input Parameters

string
required
The 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
string
required
The unique identifier of the service principal whose secret will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_OAUTH2_SERVICE_PRINCIPAL_SECRETS_PROXY_CREATETool 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.

Input Parameters

string
required
The service principal ID (SCIM ID, not application ID)
string
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_PIPELINES_PIPELINES_DELETEDelete a Databricks Delta Live Tables pipeline by ID and stop any active updates; Unity Catalog pipeline tables are retained by default. Pipeline deletion cannot be easily undone without Databricks support assistance.

Input Parameters

string
required
The unique identifier of the pipeline to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_PIPELINES_PIPELINES_GET_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier of the pipeline for which to retrieve permissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_PIPELINES_PIPELINES_GET_PERM_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the pipeline for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_PIPELINES_PIPELINES_LIST_UPDATESTool 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.

Input Parameters

string
Opaque pagination token returned by a previous call to fetch the next page of results.
integer
Maximum number of updates to return in a single page. Use for pagination control.
string
required
The unique identifier of the pipeline for which to retrieve updates
string
If present, returns updates until and including this update_id. Useful for getting updates up to a specific point.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_PIPELINES_PIPELINES_UPDATE_PERMISSIONSTool 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.

Input Parameters

string
required
Identifier for the pipeline requiring permission modifications
array
required
List 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_QUALITYMONITORV2_QUALITY_MONITOR_V2_CREATETool 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.

Input Parameters

object
Cron schedule configuration for automatic monitor refresh.
object
Snapshot table monitoring configuration.
string
required
Absolute workspace path for storing monitoring assets including dashboard and metric tables (e.g., /Workspace/Users/{email}/monitoring/)
string
required
Full name of Unity Catalog table to monitor in format catalog.schema.table_name (case insensitive, spaces disallowed)
object
Time series monitoring configuration.
string
Warehouse ID for dashboard query execution
object
Inference log monitoring configuration for ML models.
object
Notification settings for quality monitor alerts.
array
Column expressions for slicing data to enable targeted analysis on data segments
array
User-defined custom quality metrics for specialized monitoring needs
string
required
Schema where output metric tables are created in 2-level format {catalog}.{schema}
string
Baseline table name for computing drift metrics in format catalog.schema.table_name
boolean
If true, skips creation of default quality metrics dashboard
object
Data classification configuration for sensitive data detection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SEARCH_MLFLOW_EXPERIMENTSTool 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.

Input Parameters

string
SQL-like expression for filtering experiments using operators (=, !=, LIKE, ILIKE) against experiment attributes and tags. Example: “name LIKE ‘test-%’ AND tags.key = ‘value’”
array
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’]
string ("ACTIVE_ONLY" | "DELETED_ONLY" | "ALL")
Qualifier 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.
string
Token indicating the page of experiments to fetch. Use the next_page_token from a previous response to retrieve the next page of results.
integer
Maximum number of experiments desired. Servers may select a desired default max_results value. If not specified, the server will choose a default limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SEARCH_MLFLOW_RUNSTool 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.

Input Parameters

string
Filter 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).
array
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.
string
Pagination token for retrieving subsequent result pages. Use the next_page_token from a previous response to retrieve the next page of results.
integer
Maximum number of runs desired. If unspecified, defaults to 1000. All servers are guaranteed to support a max_results threshold of at least 50,000.
string ("ACTIVE_ONLY" | "DELETED_ONLY" | "ALL")
Whether 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.
array
required
List of experiment IDs to search over. At least one experiment ID must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_CREATE_PROV_THPUTCreate a provisioned throughput serving endpoint for AI models in Databricks, provisioning model units for production GenAI applications. The endpoint name must be unique across the workspace and can contain alphanumeric characters, dashes, and underscores; the response includes endpoint details and readiness state when available.

Input Parameters

string
required
The name of the serving endpoint. Must be unique across the Databricks workspace. Can consist of alphanumeric characters, dashes, and underscores
array
Tags to be attached to the serving endpoint and automatically propagated to billing logs
object
required
The core configuration of the PT serving endpoint
object
The AI Gateway configuration for the serving endpoint.
string
The budget policy associated with the endpoint
object
Email notification settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_DELETEDeletes a model serving endpoint by name, permanently disabling its usage. The tool also reports success when the API returns 404.

Input Parameters

string
required
The name of the serving endpoint to delete. This is the user-defined name assigned when the endpoint was created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_GETRetrieves comprehensive details about a specific Databricks serving endpoint by name. Use this action to: - Get endpoint status and readiness state (READY, NOT_READY, UPDATE_FAILED) - View served model/entity configurations including foundation model details - Check endpoint capabilities (function calling, image input, long context, reasoning) - Retrieve pricing information (input/output token costs in DBUs) - Inspect AI Gateway settings (usage tracking, safety/PII guardrails) - Review traffic routing and workload configurations - Verify permission levels and access controls Returns detailed information including endpoint type (FOUNDATION_MODEL_API or CUSTOM_MODEL_API), task type (llm/v1/chat, llm/v1/completions, llm/v1/embeddings), model documentation links, and configuration versions.

Input Parameters

string
required
The name of the serving endpoint to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_GET_OPEN_APITool 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.

Input Parameters

string
required
The name of the serving endpoint to retrieve the OpenAPI specification for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_GET_PERM_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the serving endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_PUTTool 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.

Input Parameters

string
required
The name of the serving endpoint whose rate limits are being updated
array
List of rate limit configurations for the endpoint. Each configuration specifies calls allowed per renewal period

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SERVING_SERVING_ENDPOINTS_PUT_AI_GATEWAYTool 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.

Input Parameters

string
required
The name of the serving endpoint whose AI Gateway is being updated
object
Configuration for AI Guardrails to prevent unwanted data in requests and responses.
array
Configuration for rate limits to control endpoint traffic and prevent overuse
object
Configuration for traffic fallback which auto fallbacks to other served entities.
object
Configuration to enable usage tracking using system tables.
object
Configuration for payload logging using inference tables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AIBI_DASH_EMBEDDING_ACCESS_POLICY_DELETEDelete the workspace-level access policy for embedding published AI/BI dashboards, restoring the default policy that conditionally permits embedding on approved domains. An optional etag identifies the policy version to delete. A success response does not necessarily confirm that the policy was deleted, including when it has changed concurrently.

Input Parameters

string
Used 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AIBI_DASH_EMBEDDING_ACCESS_POLICY_GETTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AIBI_DASH_EMBEDDING_ACCESS_POLICY_UPDATEUpdate the workspace-level AI/BI dashboard embedding access policy to allow all domains, allow approved domains, or deny all domains. An optional caller-supplied etag can be included for optimistic concurrency control.

Input Parameters

object
required
The configuration object containing the policy settings to apply. Must include access_policy_type and optionally etag for concurrency control.
string
required
Specifies 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’).
boolean
Should always be set to true for Settings API. Added for AIP (Google API Improvement Proposals) compliance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AIBI_DASH_EMBEDDING_APPROVED_DOMAINS_GETTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AIBI_DASH_EMBEDDING_DOMAINS_DELETETool 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.

Input Parameters

string
required
Version identifier for optimistic concurrency control. The etag prevents simultaneous writes from overwriting each other. Required: You must 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AIBI_DASH_EMBEDDING_DOMAINS_UPDATETool 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.

Input Parameters

object
required
The setting configuration object containing the values to update
string
required
Comma-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
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AUTOMATIC_CLUSTER_UPDATE_GETRetrieve the workspace automatic cluster update setting, including enablement status, maintenance window configuration, and restart behavior.

Input Parameters

string
Used 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. Must be a valid etag value returned from a previous API response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_AUTOMATIC_CLUSTER_UPDATE_UPDATETool 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 Enhanced Security Compliance SKU entitlement and admin access. If the setting is updated concurrently, the PATCH request fails with HTTP 409 requiring retry with fresh etag. Note: The enabled field can only be modified if the workspace has the necessary entitlement; other fields like maintenance_window and restart_even_if_no_updates_available can be configured regardless.

Input Parameters

object
required
The setting configuration object containing automatic cluster update values to update
string
required
Comma-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
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_COMPL_SECURITY_PROFILE_GETTool 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.

Input Parameters

string
Version identifier for optimistic concurrency control. Ensures responses are at least as fresh as the provided value, helping prevent simultaneous overwrites

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DASH_EMAIL_SUBS_DELETETool 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.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DASH_EMAIL_SUBS_GETTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DASH_EMAIL_SUBS_UPDATETool 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.

Input Parameters

object
required
The setting configuration object containing dashboard email subscriptions values to update
string
required
Comma-separated list of field names to update (no spaces). Use dot notation for nested fields. Example: ‘boolean_val.value’
boolean
Should always be set to true for Settings API. Allows the update to proceed even if the setting doesn’t exist yet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DEFAULT_NAMESPACE_DELETETool 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).

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DEFAULT_NAMESPACE_GETRetrieve the workspace default catalog namespace setting used for unqualified table references on Unity Catalog-enabled compute; a 404 returns an empty namespace and any available eTag. Changes to the setting require restarting clusters and SQL warehouses to take effect.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DEFAULT_NAMESPACE_UPDATETool 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.

Input Parameters

object
required
The setting configuration object containing default namespace values to update. Must include etag obtained from a GET request
string
required
Field 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
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_DELETETool 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).

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_GETTool 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.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DEFAULT_WAREHOUSE_ID_UPDATETool 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.

Input Parameters

object
required
The setting configuration object containing default warehouse ID values to update. Must include etag obtained from a GET request
string
required
Field 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
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_DELETETool 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.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_GETTool 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.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DISABLE_LEGACY_ACCESS_UPDATETool to enable the workspace disable legacy access setting with optional etag-based concurrency control. Use when you need to enable (not disable) restrictions on legacy features including direct Hive Metastore access, external location fallback mode, and Databricks Runtime versions prior to 13.3LTS. Note: This setting can only be set to true (enabled), not false. The etag parameter is optional but recommended for preventing concurrent modification conflicts.

Input Parameters

object
required
The setting configuration object containing disable legacy access values to update. The etag field is optional but recommended for concurrency control
string
required
Comma-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
boolean
Must 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_DELETETool 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).

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_GETTool 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.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_DISABLE_LEGACY_DBFS_UPDATETool 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.

Input Parameters

object
required
The setting configuration object containing disable legacy DBFS values to update. Include etag from GET request for concurrency control. The bool_val field contains the DisableLegacyDbfs configuration
string
required
Comma-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
boolean
Must 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENABLE_EXPORT_NOTEBOOK_GET_ENABLETool 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.

Input Parameters

string
Version identifier used for optimistic concurrency control. The response will be at least as fresh as the provided etag value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENABLE_EXPORT_NOTEBOOK_PATCH_ENABLETool 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.

Input Parameters

object
required
The setting configuration object containing enable export notebook values to update
string
required
Comma-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
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENABLE_NOTEBOOK_TABLE_CLIPBOARD_GETTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENABLE_NOTEBOOK_TABLE_CLIPBOARD_PATCHTool 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.

Input Parameters

object
required
The setting configuration object containing enable notebook table clipboard values to update
string
required
Comma-separated list of field names to update. Use dot notation for nested fields. Must be ‘boolean_val.value’ to update the setting value. Can use ’*’ for full replacement, but explicit field specification is recommended
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENABLE_RESULTS_DOWNLOADING_GET_ENABLETool 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.

Input Parameters

string
Version identifier used for optimistic concurrency control. The response will be at least as fresh as the provided etag value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENABLE_RESULTS_DOWNLOADING_PATCHTool to update workspace notebook results download setting. Use when you need to enable or disable users’ ability to download notebook results. Requires admin access.

Input Parameters

object
required
The setting configuration object containing enable results downloading values to update
string
required
Comma-separated list of field names to update. Use dot notation for nested fields. Use ‘boolean_val.value’ to update only the boolean value, or ‘boolean_val’ to update the entire boolean_val object. The ‘setting.’ prefix should NOT be included in the field mask
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENHANCED_SECURITY_MONITORING_GETTool 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.

Input Parameters

string
Used 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. Must be a valid base64-encoded etag string returned from a previous GET request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_ENHANCED_SECURITY_MONITORING_UPDATETool 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.

Input Parameters

object
required
The enhanced security monitoring setting configuration object.
string
required
Comma-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.
boolean
required
This should always be set to true for Settings API. Added for AIP compliance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_IP_ACCESS_LISTS_CREATETool 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.

Input Parameters

string
required
Label for the IP access list. This cannot be empty. A descriptive name for the IP access list (e.g., ‘office’, ‘vpn-users’)
boolean
Specifies whether this list is enabled. Pass true or false. Defaults to true if not specified
string ("ALLOW" | "BLOCK")
required
Type 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)
array
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_IP_ACCESS_LISTS_GETTool 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.

Input Parameters

string
required
The unique identifier (UUID) for the IP access list to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_GETTool 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.

Input Parameters

string
Version identifier for optimistic concurrency control to prevent simultaneous writes from overwriting each other. Should be retrieved from GET and passed with subsequent PATCH requests

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_WORKSPACE_DELETETool 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).

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_WORKSPACE_UPDATEUpdates workspace-level setting that controls whether AI features are powered by partner-hosted models. Use to enable/disable partner-powered AI features (Azure OpenAI or Anthropic on Databricks). When disabled, Databricks-hosted models are used instead. IMPORTANT: You must first call DATABRICKS_SETTINGS_LLM_PROXY_PARTNER_POWERED_WORKSPACE_GET to obtain the current etag before updating. If concurrent updates occur, request fails with 409 status - retry with the fresh etag from the 409 response.

Input Parameters

object
required
The setting configuration object containing LLM proxy partner powered values to update. Must include etag obtained from a GET request
string
required
Comma-separated list of fields to update (no spaces). Field paths are relative to the setting object using dot notation for sub-fields. Use ‘boolean_val.value’ to update just the boolean value (recommended), or ‘boolean_val’ to replace the entire object. A field mask of ’*’ indicates full replacement
boolean
Should always be set to true for Settings API. Added for AIP compliance. Allows the setting to be created if it doesn’t exist yet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_NOTIF_DESTS_CREATETool 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.

Input Parameters

object
required
The configuration for the notification destination. Must contain exactly one destination type (email, slack, microsoft_teams, pagerduty, or generic_webhook)
string
The display name for the notification destination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_NOTIF_DESTS_DELETETool 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.

Input Parameters

string
required
The UUID identifying the notification destination to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_NOTIF_DESTS_UPDATETool 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.

Input Parameters

string
required
UUID identifying the notification destination to update
object
Configuration for notification destination update. Must contain exactly one destination type.
string
The display name for the notification destination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_NOTIFICATION_DESTINATIONS_GETTool 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.

Input Parameters

string
required
The UUID identifying the notification destination to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_DELETETool 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).

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_GETTool 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.

Input Parameters

string
Used 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_RESTRICT_WORKSPACE_ADMINS_UPDATETool 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.

Input Parameters

object
required
The setting configuration object containing restrict workspace admins values to update
string
required
Comma-separated list of field names to update. Use dot notation for nested fields. No spaces between fields
boolean
Should always be set to true for Settings API. Added for AIP compliance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_DELETETool 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).

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_GETTool 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.

Input Parameters

string
Version 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_SQL_RESULTS_DOWNLOAD_UPDATEUpdate the workspace SQL results download setting controlling whether users can download results from SQL Editor and AI/BI Dashboards. Requires workspace admin access and accepts an etag for optimistic concurrency control.

Input Parameters

object
required
The setting configuration object containing SQL results download values to update
string
required
Comma-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
boolean
Should 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_DELETETool 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.

Input Parameters

string
required
The ID of the token to delete/revoke. Admins can delete tokens for any user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKEN_MANAGEMENT_GETTool 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.

Input Parameters

string
required
The ID of the token to retrieve. This is the unique identifier for the token in the token management system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKEN_MGMT_GET_PERM_LEVELSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKEN_MGMT_GET_PERMSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKEN_MGMT_SET_PERMSTool 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.

Input Parameters

array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKEN_MGMT_UPDATE_PERMSTool 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.

Input Parameters

array
required
List 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_TOKENS_CREATETool 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.

Input Parameters

string
A comment or description to attach to the token for identification purposes. This will appear on the user’s settings page
integer
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGSV2_WORKSPACE_SETTINGS_V2_GET_PUBLICRetrieves the current configuration of a workspace-level setting, such as admin restrictions, automatic cluster updates, default SQL namespaces, security profiles, or monitoring configurations. The response may include an etag for version control and concurrent updates.

Input Parameters

string
required
The setting identifier path in the format ‘types/{setting_type}/names/{setting_name}’. Common setting types: ‘restrict_workspace_admins’ (admin restrictions), ‘automatic_cluster_update’ (cluster auto-updates), ‘default_namespace’ (SQL default catalog/schema), ‘compliance_security_profile’ (security settings), ‘enhanced_security_monitoring’ (monitoring settings). The setting name is typically ‘default’
string
Optional version identifier for cache freshness. When provided, guarantees the response is at least as fresh as this etag. Use this to ensure you’re not reading stale data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SETTINGS_WORKSPACE_CONF_SET_STATUSSet workspace-level configuration settings for a Databricks workspace. Commonly used to configure the maximum token lifetime for personal access tokens (maxTokenLifetimeDays). Updates are applied immediately and affect workspace behavior. Requires workspace admin permissions. Invalid or unsupported configuration keys will return a 400 Bad Request error.

Input Parameters

object
required
Dictionary of workspace configuration key-value pairs to set. All values must be strings. The most commonly used key is ‘maxTokenLifetimeDays’ (e.g., ‘90’, ‘120’, ‘60’) which sets the maximum lifetime in days for new personal access tokens. Other workspace configuration keys depend on the workspace tier and features enabled. Invalid keys will result in a 400 Bad Request error. Note: This action updates workspace-level settings and requires admin permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_PROVIDERS_CREATETool 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.

Input Parameters

string
required
The name of the provider. Must be unique within the metastore
string
Description about the provider for documentation purposes
string ("TOKEN" | "DATABRICKS" | "OAUTH_CLIENT_CREDENTIALS" | "OIDC_FEDERATION")
required
Authentication 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
string
JSON 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>

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_PROVIDERS_GETTool 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.

Input Parameters

string
required
The name of the provider to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_PROVIDERS_UPDATETool 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.

Input Parameters

string
required
The current name of the provider to update. This is used in the path parameter to identify the provider
string
Username of the new provider owner. Must be the current provider owner to change this
string
Description or comment about the provider
string
New name for the provider if renaming. Requires both metastore admin and owner privileges
string
JSON 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>“}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_RECIPIENTS_CREATETool 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.

Input Parameters

string
required
Name of the recipient. Must be unique within the metastore
string
Username/groupname/service principal application_id of the recipient owner
string
Description about the recipient
string
The one-time sharing code provided by the data recipient. Used with DATABRICKS authentication
object
IP access list configuration for recipient.
integer
Expiration timestamp of the token in epoch milliseconds. Used with TOKEN authentication
object
Recipient properties object.
string ("DATABRICKS" | "OAUTH_CLIENT_CREDENTIALS" | "OIDC_FEDERATION" | "TOKEN")
required
The delta sharing authentication type
string
Required when authentication_type is DATABRICKS. The global Unity Catalog metastore id provided by the data recipient

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_RECIPIENTS_DELETETool 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.

Input Parameters

string
required
The name of the recipient to delete. The caller must be the owner of the recipient

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_RECIPIENTS_GETTool 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.

Input Parameters

string
required
Name of the recipient to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_SHARES_CREATETool 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.

Input Parameters

string
required
Name of the share. Must be unique within the metastore
string
User-provided free-form text description of the share
string
Storage root URL for the share (e.g., s3://bucket/path, abfss://container@storage.dfs.core.windows.net/path)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_SHARES_DELETETool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_SHARES_GETTool 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.

Input Parameters

string
required
The name of the share to retrieve. Must be unique within the metastore
boolean
Query for data to include in the share. When set to true, returns the list of shared data objects within the share

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_SHARES_SHARE_PERMISSIONSTool 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.

Input Parameters

string
required
The name of the share. This is the unique identifier for the Delta Sharing share in the Unity Catalog metastore
string
Opaque pagination token to retrieve the next page of results based on a previous query
integer
Maximum 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SHARING_SHARES_UPDATEUpdate an existing Unity Catalog share’s metadata or add, remove, or update shared data objects such as tables, views, and volumes. The caller must be a metastore admin or share owner; transferring ownership requires a metastore admin, and table additions require the share owner to have SELECT privilege on the table.

Input Parameters

string
required
The name of the share to update. This is used in the path parameter to identify the share
string
Username of current owner of share. Only metastore admins can update this field alone
string
User-provided free-form text description of the share
array
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
string
New name for the share (for renaming). Requires CREATE_SHARE privilege
string
Storage root URL for the share. Cannot be updated if there are notebook files in the share

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_CREATECreates a legacy Databricks SQL alert for an existing query, with a condition to monitor its results and trigger notifications when evaluated.

Input Parameters

object
required
The alert configuration object containing all alert settings
boolean
If true, automatically resolve alert display name conflicts. Otherwise, fail the request if display name conflicts with existing alert

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_DELETETool 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. Trashed alerts are automatically cleaned up after 30 days. Note: Deleting an already-deleted alert will return an error (not idempotent).

Input Parameters

string
required
The unique identifier (UUID) of the SQL alert to delete. The alert will be moved to trash (soft delete) and can be restored through the UI. Trashed alerts are automatically cleaned up after 30 days

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_GETTool 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.

Input Parameters

string
required
The UUID identifying the alert to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_LEGACY_CREATETool 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.

Input Parameters

string
required
Name of the alert
integer
Number of seconds after being triggered before the alert rearms itself and can be triggered again. If not defined, alert will never be triggered again
string
The identifier of the workspace folder containing the alert. Default is the user’s home folder. Format: folders/<folder_id>
object
required
Alert configuration options including column, operator, and comparison value
string
required
ID of the query evaluated by the alert

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_LEGACY_DELETETool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_LEGACY_GETTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL alert to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_LEGACY_LISTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_LEGACY_UPDATEUpdate a legacy SQL alert’s name, query reference, trigger conditions, and notification settings using the deprecated legacy endpoint. Every update requires the query reference and trigger conditions.

Input Parameters

string
required
The unique identifier of the alert to update
string
Name of the alert
integer
Number of seconds after being triggered before the alert rearms itself and can be triggered again. If not defined, alert will never be triggered again
string
The identifier of the workspace folder containing the alert. Format: folders/<folder_id>
object
required
Alert configuration options including column, operator, and comparison value (required for update)
string
required
ID of the query evaluated by the alert (required for update)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_ALERTS_UPDATEUpdate an existing legacy Databricks SQL alert using a field mask. Alert properties include display name, query reference, trigger conditions, notification settings, and ownership.

Input Parameters

string
required
UUID identifying the alert to update
object
Alert object containing fields to update.
string
required
Comma-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
boolean
When true, automatically resolves display name conflicts; when false, fails if conflict exists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_DASHBOARDS_DELETEDelete a legacy Databricks SQL dashboard by moving it to trash, where it can be restored through the UI and does not appear in searches or allow sharing. A 404 response is reported as success, so success does not confirm that a dashboard was moved.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_DASHBOARDS_GETRetrieve a legacy SQL dashboard by ID, including available metadata, widgets, and visualization details. The legacy dashboards API is deprecated as of January 12, 2026; Databricks recommends AI/BI dashboards (Lakeview API) for new implementations.

Input Parameters

string
required
The unique identifier (UUID) of the legacy SQL dashboard to retrieve. This ID identifies the dashboard across Databricks REST API services

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_DASHBOARDS_UPDATETool 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.

Input Parameters

string
required
The unique identifier (UUID) of the legacy SQL dashboard to update. This operation updates dashboard attributes only and does not modify widgets
string
The title of the dashboard that appears in list views and at the top of the dashboard page
array
Tag labels to associate with the dashboard for organization and filtering
string
Sets 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_DBSQL_PERMISSIONS_GETRetrieve the access control list for legacy DBSQL objects, including alerts, dashboards, and queries, to check principals and their permission levels. The legacy SQL Permissions API is deprecated.

Input Parameters

string
required
The UUID identifying the specific object
string
required
The type of legacy DBSQL object for which to retrieve permissions. Valid values: alerts, dashboards, queries (for legacy Redash-based DBSQL objects only)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_DBSQL_PERMISSIONS_SETTool to set access control list for legacy SQL objects (alerts, dashboards, queries, or data_sources). Use when you need to configure permissions for legacy SQL objects created via the /preview/sql endpoints. IMPORTANT: - This operation REPLACES ALL existing permissions. To retain existing permissions, include them in the access_control_list. - This is a DEPRECATED API; Databricks recommends using the Workspace API (/api/2.0/permissions) instead. - Only works with LEGACY SQL objects: Legacy SQL queries (/preview/sql/queries), legacy Redash-based SQL dashboards (NOT Lakeview dashboards), legacy SQL alerts, and SQL warehouses (data_sources). - Does NOT work with modern Lakeview dashboards (/lakeview/dashboards) or modern SQL queries (/sql/queries).

Input Parameters

string
required
Unique identifier of the SQL object for which to set permissions
string ("alerts" | "dashboards" | "queries" | "data_sources")
required
Type of legacy SQL object. Valid values: alerts (legacy SQL alerts), dashboards (legacy Redash-based SQL dashboards, NOT Lakeview dashboards), queries (legacy SQL queries), data_sources (SQL warehouses). Note: This API only works with objects created via the legacy /preview/sql endpoints
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_CREATETool 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.

Input Parameters

object
Query configuration object.
boolean
If 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_DELETETool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_GETTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL query to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_LEGACY_CREATETool 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.

Input Parameters

string
required
The title/display name of the query that appears in list views, widget headings, and on the query page. This is a required field and cannot be empty
string
required
The text of the SQL query to be executed
object
Query configuration options for legacy SQL queries.
boolean
Whether this query is a draft. Queries are created as drafts by default (true)
string
Execution schedule interval in seconds, if the query should run on a schedule
string
General description that conveys additional information about this query such as usage notes
boolean
Whether this query is archived/hidden from indexes and search results
string
required
The ID of the data source (SQL warehouse) used by the query. Must be a valid UUID format (36 characters). You can obtain this from the LIST_SQL_WAREHOUSES action or the legacy Data Sources API endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_LEGACY_DELETETool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL query to delete. The query will be moved to trash (soft delete) and permanently deleted after 30 days

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_LEGACY_GETTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL query to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_LEGACY_RESTORETool 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.

Input Parameters

string
required
The unique identifier of the SQL query to restore from trash. The query must be in trash state and not permanently deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_LEGACY_UPDATETool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL query to update
string
The title/display name of the query that appears in list views, widget headings, and on the query page
array
Tags for the query
string
The text of the SQL query to be executed
string
The identifier of the workspace folder containing the object
object
Query configuration options for legacy SQL queries.
string
General description that conveys additional information about this query such as usage notes
string
Sets the Run as role for the object. Must be set to one of ‘viewer’ (run as viewer) or ‘owner’ (run as owner)
string
Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERIES_UPDATETool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL query to update
object
Query configuration object for update operation.
string
required
Comma-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
boolean
If true, automatically resolve query display name conflicts. If false or not specified, the request fails on naming conflicts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERY_HISTORY_LISTTool 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.

Input Parameters

object
Filter object to limit query history results.
string
Token to get the next page of results. Obtained from previous response for pagination
integer
Limit the number of results returned in one page. Must be less than 1000. Defaults to 100
boolean
Whether to include query metrics with each query. Recommended for small result sets only due to response size. Defaults to false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERY_VISUALIZATIONS_CREATETool 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.

Input Parameters

object
required
The visualization configuration object containing all visualization settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_CREATETool 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.

Input Parameters

string
The name of the visualization that appears on dashboards and the query screen
string
required
The type/category of visualization (e.g., CHART, TABLE, PIVOT, COUNTER, etc.)
object
required
Visualization-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
string
required
The identifier of the query to which the visualization will be added. This identifier is obtained from the queries/create endpoint
string
A short description of the visualization. This is not displayed in the UI

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_DELETETool 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.

Input Parameters

string
required
The unique identifier (UUID) of the visualization to permanently delete. This is the widget/visualization ID returned by the queryvisualizations/create endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERY_VISUALIZATIONS_LEGACY_UPDATETool 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.

Input Parameters

string
required
The UUID identifier of the visualization to update
string
The name of the visualization that appears on dashboards and the query screen
string
The type of visualization: chart, table, pivot table, and so on
object
The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying this
string
A short description of this visualization. This is not displayed in the UI

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_QUERY_VISUALIZATIONS_UPDATETool to update an existing Databricks SQL query visualization using partial update with field mask. Use when you need to modify visualization properties. Only two fields are updatable: display_name (the name shown in UI) and type (TABLE, CHART, COUNTER, FUNNEL, or PIVOT). The visualization type can be changed to reorganize how query results are displayed.

Input Parameters

string
required
UUID identifying the visualization to update
string
required
Comma-separated field names to update (no spaces). Field names must match resource field names exactly. Only these fields are updatable: display_name, type. Do not use wildcards (*)
object
Visualization object containing fields to update. Only display_name and type are updatable via this API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_REDASH_CONFIG_GET_CONFIGTool to retrieve workspace configuration for Redash V2 in Databricks SQL. Use when you need to get Redash configuration settings for the current workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_STATEMENT_EXEC_CANCEL_EXECTool 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).

Input Parameters

string
required
The statement ID returned upon successfully submitting a SQL statement. Required reference for canceling the execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_STATEMENT_EXEC_EXECUTE_STATEMENTExecute a SQL statement on a Databricks SQL warehouse. The response includes execution status and may include results or a statement_id for polling; for large result sets, use disposition=EXTERNAL_LINKS and fetch chunks separately.

Input Parameters

string
The output format for result data. JSON_ARRAY (default), ARROW_STREAM, or CSV.
string
Sets the default schema for the statement execution.
string
Sets the default catalog for the statement execution.
integer
Maximum number of rows to return. Alternative to adding a LIMIT clause to your SQL.
string
required
The SQL statement to execute. Maximum size is 16 MiB. Can include named parameters referenced as :param_name.
integer
Byte limit applied to the result size. Based on internal data representations and may not match the final format size.
array
A list of named parameters for parameterized SQL. Reference them in the SQL as :name. Positional parameters (?) are not supported.
array
An array of query tags to annotate the SQL statement. Maximum 20 tags. Each tag has a key and an optional value.
string
How result data is fetched. INLINE (default, <=25 MiB in response) or EXTERNAL_LINKS (URLs to fetch chunks, <=100 GiB).
string
Timeout for waiting on execution results. ‘0s’ returns immediately (async). ‘5s’ to ’50s’ for sync wait. Default is ’10s’.
string
required
The ID of the SQL warehouse to execute the statement on. Found in the HTTP path field of your warehouse as the string after /sql/1.0/warehouses/.
string
Action when wait_timeout is reached. CONTINUE (default, keeps running in background) or CANCEL (terminates the statement).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_STATEMENT_EXEC_GET_RESULT_CHUNKGet a specific chunk of results from a SQL statement execution. Use this to paginate through large result sets. The chunk_index is zero-based. Use the manifest from the execute_statement or get_statement response to determine the total number of chunks available.

Input Parameters

integer
required
The zero-based index of the chunk to retrieve. Use the manifest from the execute or get_statement response to determine available chunks.
string
required
The statement ID returned from executing a SQL statement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_STATEMENT_EXEC_GET_STATEMENTGet the status, manifest, and first chunk of results for a SQL statement execution. Use this to poll for completion after executing a statement asynchronously. The statement result is available for one hour after completion. Returns HTTP 404 if the statement has been in a terminal state for more than 12 hours.

Input Parameters

string
required
The statement ID returned from executing a SQL statement. Used to poll for status and retrieve results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_DELETEDeletes a SQL warehouse from the Databricks workspace. Use this tool to permanently remove a SQL warehouse (compute resource) that is no longer needed. The warehouse must exist and you must have appropriate permissions to delete it. Important notes: - Deleted warehouses may be restored within 14 days by contacting Databricks support - The operation is idempotent - deleting an already deleted warehouse will succeed - This is a destructive operation and cannot be undone through the API

Input Parameters

string
required
Required. The unique identifier (endpoint ID) of the SQL warehouse to delete. Must be a valid warehouse ID obtained from listing warehouses or warehouse creation. The ID is typically a hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_EDITTool 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.

Input Parameters

string
required
Required. The warehouse ID to edit/configure
string
Logical name for the warehouse. Must be unique within the workspace and less than 100 characters
object
Tags for the warehouse.
object
Channel information for the warehouse.
string
Size of the clusters allocated for this warehouse. Available sizes: 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large
boolean
Configures whether the warehouse should use Photon optimized clusters. Defaults to false
integer
The 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
string ("PRO" | "CLASSIC" | "TYPE_UNSPECIFIED")
SQL warehouse type designation. PRO is required for serverless compute
integer
Maximum number of clusters that the autoscaler will create to handle concurrent queries. Must be <= 40 and must exceed min_num_clusters
integer
Minimum number of available clusters that will be maintained for this SQL warehouse. Must be > 0 and <= min(max_num_clusters, 30). Defaults to 1
string
(Deprecated) AWS only - The instance profile used to pass an IAM role to the SQL warehouse
string ("COST_OPTIMIZED" | "RELIABILITY_OPTIMIZED" | "POLICY_UNSPECIFIED")
Configurations for spot instance usage. COST_OPTIMIZED uses spot instances when possible, RELIABILITY_OPTIMIZED uses on-demand instances
boolean
Configures whether the warehouse should use serverless compute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_GETTool 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.

Input Parameters

string
required
The unique identifier of the SQL warehouse to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_GET_PERMISSION_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the SQL warehouse for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_GET_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL warehouse for which to retrieve permissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_GET_WORKSPACE_WAREHOUSE_CONFIGTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_SET_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the SQL warehouse for which to set permissions
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_SET_WORKSPACE_WAREHOUSE_CONFIGTool 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.

Input Parameters

object
Channel information for SQL warehouses.
string ("DATA_ACCESS_CONTROL" | "NONE" | "PASSTHROUGH")
Security 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
array
Spark confs for external hive metastore configuration. JSON serialized size must be less than or equal to 512K
string
AWS Only - The instance profile used to pass an IAM role to the SQL warehouses
string
GCP only - Google Service Account used to pass to cluster to access Google Cloud Storage
array
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
boolean
Enable Serverless compute for SQL warehouses
object
SQL configuration parameters for warehouses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_STARTTool 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.

Input Parameters

string
required
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SQL_WAREHOUSES_UPDATE_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier of the SQL warehouse for which to update permissions. This is typically an alphanumeric string (e.g., ‘4fc35c5d38e6ef6c’) that can be obtained from the List SQL Warehouses endpoint
array
required
Array 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_SUBMIT_RUNTool 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.

Input Parameters

array
required
List of tasks to execute in the run. At least one task is required
string
Name for the run (default: ‘Untitled’)
array
Libraries to install on cluster (default: empty list)
object
Cluster specification to create for each run.
array
List of environment configurations for the run
integer
Timeout per run (default: no timeout)
string
Token (max 64 characters) to guarantee idempotency
string
ID of an existing cluster to use for all tasks
object
Email and webhook notification preferences.
object
System destinations for run state changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_TAGS_TAG_POLICIES_CREATE_TAG_POLICYCreate a Databricks tag policy (governed tag) with an optional description and allowed values. Requires appropriate account-level permissions; an account can have up to 1,000 governed tags, each with up to 50 allowed values.

Input Parameters

array
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
string
required
The tag key name (case sensitive). This is the governed tag identifier. No special characters are allowed. Tag keys must be unique within the account
string
A description or explanation for the governed tag policy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_TAGS_TAG_POLICIES_DELETE_TAG_POLICYTool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_TAGS_TAG_POLICIES_GET_TAG_POLICYTool 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.

Input Parameters

string
required
The unique key identifier of the governed tag whose policy you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_TAGS_TAG_POLICIES_UPDATE_TAG_POLICYUpdate an existing tag policy (governed tag), identified by its tag key, with a specified description or allowed values. Users must have MANAGE permission on the governed tag to edit it.

Input Parameters

array
A collection of allowed values for the tag. Each governed tag can have a maximum of 50 allowed values
string
required
The 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
string
A text field describing the policy
string
required
A 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_UPDATE_JOB_BY_IDTool 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.

Input Parameters

integer
required
The canonical identifier of the job to reset. This field is required.
object
required
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_ENDPOINTS_CREATETool 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.

Input Parameters

string
required
Name of the vector search endpoint. Must be unique within the workspace
string ("STANDARD" | "STORAGE_OPTIMIZED")
Type of endpoint. STANDARD: Up to 320M vectors, lower latency. STORAGE_OPTIMIZED: Over 1B vectors, 10-20x faster indexing, slightly higher latency (~250ms), up to 7x cheaper per vector. Choose STORAGE_OPTIMIZED for 10M+ vectors when cost efficiency is important
string
The id of the usage policy to assign to the endpoint
string
The id of the budget policy to assign to the endpoint. Deprecated, use usage_policy_id instead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_DELETE_INDEXDelete a vector search index from a Databricks workspace; deletion is irreversible and automatically removes associated writeback tables. A 404 response is reported as success, so success does not necessarily mean an index was deleted by this request.

Input Parameters

string
required
The 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_QUERY_INDEXTool 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.

Input Parameters

array
required
List of column names to include in the response. These columns will be returned along with the similarity scores for matched documents
string
Filter 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’”)
object
Reranking configuration object.
string
required
Name of the vector index to query. Use the full three-level name format (catalog.schema.index_name)
string
Token for pagination. Pass the next_page_token from a previous response to retrieve the next page of results. Maximum total retrievable results is 10,000 across all pages
string
Text query to search with. Required for Delta Sync Index using model endpoint. Automatically converted to embeddings. Must provide either query_vector or query_text
string ("ANN" | "HYBRID" | "FULL_TEXT")
Type of search to perform. ANN (default): Approximate nearest neighbor search. HYBRID: Combines keyword and similarity search. FULL_TEXT: Full-text search mode
integer
Set to ≥1 to get latency information in response. Required for reranker timing information
integer
required
Maximum number of results to return. Maximum is 200 for hybrid search, 10,000 total retrievable with pagination
string
JSON string representing query filters (alternative format)
array
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
number
Minimum similarity score threshold for results. Defaults to 0.0. Only results with similarity scores above this threshold will be returned
array
Column names to retrieve data for sending to the reranker. This is used when reranking is desired but not using the reranker object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_VECTORSEARCH_VECTOR_SEARCH_INDEXES_UPSERT_DATATool 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.

Input Parameters

array
required
Array 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
string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_GIT_CREDENTIALS_CREATETool 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. Multiple credentials can be created, typically one per Git provider. Use the is_default_for_provider flag to set a credential as the default for its provider.

Input Parameters

string
Identifier used for looking up the git credential. Useful for organizing multiple credentials
string
The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and sets the author & committer identity for commits. Either git_username or git_email must be provided for GitHub Enterprise. Recommended for all providers
string ("gitHub" | "bitbucketCloud" | "gitLab" | "azureDevOpsServices" | "gitHubEnterprise" | "bitbucketServer" | "gitLabEnterpriseEdition" | "awsCodeCommit")
required
The Git provider name. Case-insensitive. Valid values include gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise, bitbucketServer, gitLabEnterpriseEdition, and awsCodeCommit
string
The username provided with your Git provider account. Used to set the Git committer & author names for commits. Required for Bitbucket Cloud and AWS CodeCommit. Either git_username or git_email must be provided for GitHub Enterprise
string
The personal access token used to authenticate to the corresponding Git provider. This is required for authenticating with the Git provider
boolean
If true, this credential serves as the default for the given provider. Only one credential can be default per provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_GIT_CREDENTIALS_DELETEDelete a Git credential entry from a Databricks workspace by credential ID. Use for managing credentials used to authenticate to remote repositories.

Input Parameters

integer
required
The ID for the corresponding credential to delete. This is the unique identifier of the Git credential object in the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_GIT_CREDENTIALS_GETTool 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.

Input Parameters

integer
required
The ID for the corresponding credential to access. This is the unique identifier of the credential object in the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_GIT_CREDENTIALS_UPDATETool 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.

Input Parameters

string
The name of the git credential, used for identification and ease of lookup
string
The 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
string ("gitHub" | "bitbucketCloud" | "gitLab" | "azureDevOpsServices" | "gitHubEnterprise" | "bitbucketServer" | "gitLabEnterpriseEdition" | "awsCodeCommit" | "azureDevOpsServicesAad")
required
The 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
string
The 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
integer
required
The ID for the corresponding credential to access. This is the unique identifier of the credential object in the workspace
string
The 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
boolean
Flag indicating if the credential is the default for the given provider. Only one credential can be default per provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_LISTTool 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.

Input Parameters

string
required
The absolute path of the notebook or directory to list. Must be an absolute path starting with ’/’
boolean
Whether to recursively traverse subdirectories. Defaults to false
integer
UTC timestamp in milliseconds to filter notebooks modified after this time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_REPOS_CREATETool 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.

Input Parameters

string
Name of existing Git tag to checkout after creation
string
required
HTTPS URL of a Git repository to be linked
string
Desired 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
string
Name of existing Git branch to checkout after creation
string ("gitHub" | "gitHubEnterprise" | "bitbucketCloud" | "bitbucketServer" | "azureDevOpsServices" | "gitLab" | "gitLabEnterpriseEdition" | "awsCodeCommit")
Git provider name. Case-insensitive. Must be provided if cannot be guessed from URL. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit
object
Configuration for sparse checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_REPOS_DELETETool 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.

Input Parameters

string
required
The unique numeric identifier of the repository to delete. This ID can be obtained by listing repos or getting repo details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_REPOS_GET_PERMISSION_LEVELSTool 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.

Input Parameters

string
required
The unique identifier of the repository for which to retrieve available permission levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_REPOS_SET_PERMISSIONSTool 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.

Input Parameters

string
required
The identifier of the repository for which to set permissions
array
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_REPOS_UPDATETool 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.

Input Parameters

integer
required
The unique identifier of the Git folder (repo) object in the workspace
string
Tag 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
string
Branch 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
object
Configuration for sparse checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_REPOS_UPDATE_PERMISSIONSTool 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.

Input Parameters

string
required
The unique identifier of the repository to update permissions for
array
required
List 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_CREATE_SCOPETool 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.

Input Parameters

string
required
The 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
string ("DATABRICKS" | "AZURE_KEYVAULT")
The 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
object
Azure Key Vault backend configuration for secret scope.
string
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_DELETE_ACLTool 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.

Input Parameters

string
required
The name of the secret scope from which to revoke access. This is the scope that contains the ACL to be removed
string
required
The 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)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_DELETE_SCOPETool 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.

Input Parameters

string
required
Name 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_DELETE_SECRETTool 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.

Input Parameters

string
required
Name of the secret to delete. This is the unique identifier for the secret within the specified scope
string
required
The name of the scope that contains the secret to delete. This identifies the secret scope where the secret is stored

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_GET_ACLTool 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.

Input Parameters

string
required
The name of the secret scope to fetch ACL information from
string
required
The 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)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_GET_SECRETRequest a secret value by scope and key through the Databricks workspace Secrets API. Requires READ permission on the scope.

Input Parameters

string
required
Name of the secret to fetch value information. The key to fetch the secret for within the specified scope
string
required
The name of the scope that contains the secret. This is the name of the secret scope to fetch secret information from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_PUT_ACLTool 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.

Input Parameters

string
required
The name of the secret scope to apply permissions to. Must reference an existing secret scope
string
required
The 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
string ("MANAGE" | "WRITE" | "READ")
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_SECRETS_PUT_SECRETTool 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.

Input Parameters

string
required
A unique name to identify the secret. Must consist of alphanumeric characters, dashes, underscores, and periods, and cannot exceed 128 characters
string
required
The 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
string
If specified, value will be stored as bytes. Maximum size 128 KB. Exactly one of string_value or bytes_value must be specified
string
If 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_WORKSPACE_DELETETool 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.

Input Parameters

string
required
The absolute path of the notebook or directory to delete. Must be an absolute path starting with ’/’ (e.g., ‘/Users/user@example.com/project’)
boolean
Whether 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_WORKSPACE_EXPORTExport a Databricks workspace object, such as a notebook, dashboard, or file, for backup, migration, or analysis. Specify its path and optionally an export format; the response can contain base64-encoded content and file type information.

Input Parameters

string
required
The absolute path of the workspace object to export. Must be a valid workspace path
string ("SOURCE" | "HTML" | "JUPYTER" | "DBC" | "R_MARKDOWN" | "AUTO")
Specifies 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
boolean
When true, response is the exported file content directly. When false (default), content is returned as base64-encoded string with file_type field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_WORKSPACE_GET_STATUSRetrieve status and metadata for a workspace object by path, including notebooks, directories, dashboards, and files; the response includes its type, path, identifier, and available metadata. A 404 response raises a workspace path not found error.

Input Parameters

string
required
The 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’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_WORKSPACE_IMPORTImport a notebook or file into the Databricks workspace from base64-encoded content. Supports multiple formats: SOURCE (requires language parameter), JUPYTER, R_MARKDOWN, HTML, DBC, or AUTO for automatic detection. For SOURCE format with single files, you must specify the language (PYTHON, R, SCALA, or SQL). Maximum content size: 10 MB. Use overwrite=true to replace existing objects at the same path.

Input Parameters

string
required
The absolute path of the object or directory where content will be imported in the workspace. Must be an absolute path prefixed with ’/’
string ("SOURCE" | "HTML" | "JUPYTER" | "DBC" | "R_MARKDOWN" | "AUTO")
Specifies 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
string
Base64-encoded content to be imported. Maximum size: 10 MB. Required for most import operations. If this limit is exceeded, the API throws MAX_NOTEBOOK_SIZE_EXCEEDED exception. For notebooks, the content should be base64-encoded source code
string ("PYTHON" | "SQL" | "SCALA" | "R")
The 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
boolean
Flag 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DATABRICKS_WORKSPACE_WORKSPACE_MKDIRSTool 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.

Input Parameters

string
required
The 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not