Skip to main content

Databricks Account

Connect to your Databricks Account to manage workspaces, users, and account-level settings.

Databricks Account Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 144 actions:

ActionPurposeParameters
get_api_2_0_accounts_by_account_id_credentialsGets all Databricks credential configurations associated with an account specified by ID.account_id (string)
post_api_2_0_accounts_by_account_id_credentialsCreates a Databricks credential configuration that represents cloud cross-account credentials for a specified account. Databricks uses this to set up network infrastructure properly to host Databricks clusters. For your AWS IAM role, you need to trust the External ID the Databricks Account API account ID in the returned credential object, and configure the required access policy. Save the response's credentials_id field, which is the ID for your new credential configuration object. For informaccount_id (string)
data: {
. aws_credentials
. credentials_name (string)
} (object) required
get_api_2_0_accounts_by_account_id_credentials_by_credentials_idGets a Databricks credential configuration object for an account, both specified by ID.account_id (string)
credentials_id (string)
delete_api_2_0_accounts_by_account_id_credentials_by_credentials_idDeletes a Databricks credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace.account_id (string)
credentials_id (string)
get_api_2_0_accounts_by_account_id_customer_managed_keysGets all customer-managed key configuration objects for an account. If the key is specified as a workspace's managed services customer-managed key, Databricks uses the key to encrypt the workspace's notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history. If the key is specified as a workspace's storage customer-managed key, the key is used to encrypt the workspace's root S3 bucket and optionally can encrypt cluster EBS volumes data in the data plane.account_id (string)
post_api_2_0_accounts_by_account_id_customer_managed_keysCreates a customer-managed key configuration object for an account, specified by ID. This operation uploads a reference to a customer-managed key to Databricks. If the key is assigned as a workspace's customer-managed key for managed services, Databricks uses the key to encrypt the workspaces notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history. If it is specified as a workspace's customer-managed key for workspace storage, the key encrypts the workaccount_id (string)
data: {
. aws_key_info
. use_cases (array)
} (object) required
get_api_2_0_accounts_by_account_id_customer_managed_keys_by_customer_managed_key_idGets a customer-managed key configuration object for an account, specified by ID. This operation uploads a reference to a customer-managed key to Databricks. If assigned as a workspace's customer-managed key for managed services, Databricks uses the key to encrypt the workspaces notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history. If it is specified as a workspace's customer-managed key for storage, the key encrypts the workspace's root S3 bucket waccount_id (string)
customer_managed_key_id (string)
delete_api_2_0_accounts_by_account_id_customer_managed_keys_by_customer_managed_key_idDeletes a customer-managed key configuration object for an account. You cannot delete a configuration that is associated with a running workspace.account_id (string)
customer_managed_key_id (string)
get_api_2_0_accounts_by_account_id_dashboardGet a usage dashboard specified by workspaceId, accountId, and dashboard type.account_id (string)
workspace_id (integer)
dashboard_type (string)
post_api_2_0_accounts_by_account_id_dashboardCreate a usage dashboard specified by workspaceId, accountId, and dashboard type.account_id (string)
data: {
. dashboard_type
. workspace_id (integer)
} (object) required
get_api_2_0_accounts_by_account_id_federation_policiesList account federation policies.account_id (string)
page_size (integer)
page_token (string)
post_api_2_0_accounts_by_account_id_federation_policiesCreate account federation policy.account_id (string)
policy_id (string)
data: {
. create_time (string)
. description (string)
. name (string)
. oidc_policy
. policy_id (string)
. service_principal_id (integer)
. uid (string)
. update_time (string)
} (object) required
get_api_2_0_accounts_by_account_id_federation_policies_by_policy_idGet account federation policy.account_id (string)
policy_id (string)
patch_api_2_0_accounts_by_account_id_federation_policies_by_policy_idUpdate account federation policy.account_id (string)
policy_id (string)
update_mask (string)
data: {
. create_time (string)
. description (string)
. name (string)
. oidc_policy
. policy_id (string)
. service_principal_id (integer)
. uid (string)
. update_time (string)
} (object) required
delete_api_2_0_accounts_by_account_id_federation_policies_by_policy_idDelete account federation policy.account_id (string)
policy_id (string)
get_api_2_0_accounts_by_account_id_ip_access_listsGets all IP access lists for the specified account.account_id (string)
post_api_2_0_accounts_by_account_id_ip_access_listsCreates an IP access list for the account. A list can be an allow list or a block list. See the top of this file for a description of how the server treats allow lists and block lists at runtime. When creating or updating an IP access list: For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. If the new list would block thaccount_id (string)
data: {
. ip_addresses (array)
. label (string)
. list_type
} (object) required
get_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_idGets an IP access list, specified by its list ID.account_id (string)
ip_access_list_id (string)
put_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_idReplaces an IP access list, specified by its ID. A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When replacing an IP access list: For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. If the resulting list would blockaccount_id (string)
ip_access_list_id (string)
data: {
. enabled (boolean)
. ip_addresses (array)
. label (string)
. list_type
} (object) required
patch_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_idUpdates an existing IP access list, specified by its ID. A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When updating an IP access list: For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. If the updated list woulaccount_id (string)
ip_access_list_id (string)
data: {
. enabled (boolean)
. ip_addresses (array)
. label (string)
. list_type
} (object) required
delete_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_idDeletes an IP access list, specified by its list ID.account_id (string)
ip_access_list_id (string)
get_api_2_0_accounts_by_account_id_log_deliveryGets all Databricks log delivery configurations associated with an account specified by ID.account_id (string)
credentials_id (string)
storage_configuration_id (string)
status (string)
page_token (string)
post_api_2_0_accounts_by_account_id_log_deliveryCreates a new Databricks log delivery configuration to enable delivery of the specified type of logs to your storage location. This requires that you already created a credential object:method:Credentials/Create which encapsulates a cross-account service IAM role and a storage configuration object:method:Storage/Create which encapsulates an S3 bucket. For full details, including the required IAM role policies and bucket policies, see Deliver and access billable usage logshttps://docs.databricksaccount_id (string)
data: {
. log_delivery_configuration
} (object) required
get_api_2_0_accounts_by_account_id_log_delivery_by_log_delivery_configuration_idGets a Databricks log delivery configuration object for an account, both specified by ID.account_id (string)
log_delivery_configuration_id (string)
patch_api_2_0_accounts_by_account_id_log_delivery_by_log_delivery_configuration_idEnables or disables a log delivery configuration. Deletion of delivery configurations is not supported, so disable log delivery configurations that are no longer needed. Note that you can't re-enable a delivery configuration if this would violate the delivery configuration limits described under Create log delivery:method:LogDelivery/Create.account_id (string)
log_delivery_configuration_id (string)
data: {
. status
} (object) required
get_api_2_0_accounts_by_account_id_metastoresGets all Unity Catalog metastores associated with an account specified by ID.account_id (string)
post_api_2_0_accounts_by_account_id_metastoresCreates a Unity Catalog metastore.account_id (string)
data: {
. metastore_info
} (object) required
get_api_2_0_accounts_by_account_id_metastores_by_metastore_idGets a Unity Catalog metastore from an account, both specified by ID.account_id (string)
metastore_id (string)
put_api_2_0_accounts_by_account_id_metastores_by_metastore_idUpdates an existing Unity Catalog metastore.account_id (string)
metastore_id (string)
data: {
. metastore_info
} (object) required
delete_api_2_0_accounts_by_account_id_metastores_by_metastore_idDeletes a Unity Catalog metastore for an account, both specified by ID.account_id (string)
metastore_id (string)
force (boolean)
get_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentialsGets a list of all storage credentials that have been assigned to given metastore.account_id (string)
metastore_id (string)
post_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentialsCreates a new storage credential. The request object is specific to the cloud: AwsIamRole for AWS credentials AzureServicePrincipal for Azure credentials GcpServiceAcountKey for GCP credentials. The caller must be a metastore admin and have the CREATE_STORAGE_CREDENTIAL privilege on the metastore.account_id (string)
metastore_id (string)
data: {
. credential_info
} (object) required
get_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_nameGets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have a level of privilege on the storage credential.account_id (string)
metastore_id (string)
storage_credential_name (string)
put_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_nameUpdates a storage credential on the metastore. The caller must be the owner of the storage credential. If the caller is a metastore admin, only the owner credential can be changed.account_id (string)
metastore_id (string)
storage_credential_name (string)
data: {
. credential_info
} (object) required
delete_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_nameDeletes a storage credential from the metastore. The caller must be an owner of the storage credential.account_id (string)
metastore_id (string)
storage_credential_name (string)
force (boolean)
get_api_2_0_accounts_by_account_id_metastores_by_metastore_id_workspacesGets a list of all Databricks workspace IDs that have been assigned to given metastore.account_id (string)
metastore_id (string)
get_api_2_0_accounts_by_account_id_network_connectivity_configsGets an array of network connectivity configurations.account_id (string)
page_token (string)
post_api_2_0_accounts_by_account_id_network_connectivity_configsCreates a network connectivity configuration NCC, which provides stable IP CIDR blocks that are associated with your workspace. You can assign an NCC to one or more workspaces in the same region. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks to access your resources.account_id (string)
data: {
. name (string)
. region (string)
} (object) required
get_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_idGets a network connectivity configuration.account_id (string)
network_connectivity_config_id (string)
delete_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_idDeletes a network connectivity configuration.account_id (string)
network_connectivity_config_id (string)
get_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rulesGets an array of private endpoint rules.account_id (string)
network_connectivity_config_id (string)
page_token (string)
post_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rulesCreate a private endpoint rule for the specified network connectivity config object. Once the object is created, Databricks asynchronously provisions a new AWS private endpoint to your specified AWS resource. IMPORTANT: For private connection towards a VPC endpoint service behind a customer-managed VPC endpoint service, you must use AWS console or other AWS tools to approve the private endpoint to complete the connection. To get the information of the private endpoint created, make a GET requesaccount_id (string)
network_connectivity_config_id (string)
data: {
. domain_names (array)
. endpoint_service (string)
. resource_names (array)
} (object) required
get_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules_by_private_endpoint_rule_idGets the private endpoint rule.account_id (string)
network_connectivity_config_id (string)
private_endpoint_rule_id (string)
patch_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules_by_private_endpoint_rule_idUpdates a private endpoint rule.account_id (string)
network_connectivity_config_id (string)
private_endpoint_rule_id (string)
update_mask (string) required
data: {
. domain_names (array)
. enabled (boolean)
. resource_names (array)
} (object) required
delete_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules_by_private_endpoint_rule_idInitiates deleting a private endpoint rule. The private endpoint is deactivated and will be deleted after seven days of deactivation. When a private endpoint is deactivated, the deactivated field is set to true and the private endpoint will not be applied to your serverless compute resources.account_id (string)
network_connectivity_config_id (string)
private_endpoint_rule_id (string)
get_api_2_0_accounts_by_account_id_network_policiesGets an array of network policies.account_id (string)
page_token (string)
post_api_2_0_accounts_by_account_id_network_policiesCreates a new network policy to manage which network destinations can be accessed from the Databricks environment.account_id (string)
data: {
. account_id (string)
. egress
. network_policy_id (string)
} (object) required
get_api_2_0_accounts_by_account_id_network_policies_by_network_policy_idGets a network policy.account_id (string)
network_policy_id (string)
put_api_2_0_accounts_by_account_id_network_policies_by_network_policy_idUpdates a network policy. This allows you to modify the configuration of a network policy.account_id (string)
network_policy_id (string)
data: {
. account_id (string)
. egress
. network_policy_id (string)
} (object) required
delete_api_2_0_accounts_by_account_id_network_policies_by_network_policy_idDeletes a network policy. Cannot be called on 'default-policy'.account_id (string)
network_policy_id (string)
get_api_2_0_accounts_by_account_id_networksGets a list of all Databricks network configurations for an account, specified by ID. This operation is available only if your account is on the E2 version of the platform.account_id (string)
post_api_2_0_accounts_by_account_id_networksCreates a Databricks network configuration that represents an AWS VPC and its resources. The VPC will be used for new Databricks clusters. This requires a pre-existing VPC and subnets. For VPC requirements, see Customer-managed VPChttp://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html. Important: You can share one customer-managed VPC with multiple workspaces in a single account. Therefore, you can share one VPC across multiple Account API network conaccount_id (string)
data: {
. network_name (string)
. security_group_ids (array)
. subnet_ids (array)
. vpc_endpoints
. vpc_id (string)
} (object) required
get_api_2_0_accounts_by_account_id_networks_by_network_idGets a Databricks network configuration, which represents an AWS VPC and its resources. This requires a pre-existing VPC and subnets. For VPC requirements, see Customer-managed VPChttp://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html. This operation is available only if your account is on the E2 version of the platform.account_id (string)
network_id (string)
delete_api_2_0_accounts_by_account_id_networks_by_network_idDeletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace. This operation is available only if your account is on the E2 version of the platform.account_id (string)
network_id (string)
get_api_2_0_accounts_by_account_id_oauth2_custom_app_integrationsGet the list of custom OAuth app integrations for the specified Databricks accountaccount_id (string)
page_token (string)
page_size (integer)
include_creator_username (boolean)
post_api_2_0_accounts_by_account_id_oauth2_custom_app_integrationsCreate Custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.account_id (string)
data: {
. confidential (boolean)
. name (string)
. redirect_urls (array)
. scopes (array)
. token_access_policy
. user_authorized_scopes (array)
} (object) required
get_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations_by_integration_idGets the Custom OAuth App Integration for the given integration id.account_id (string)
integration_id (string)
patch_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations_by_integration_idUpdates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.account_id (string)
integration_id (string)
data: {
. redirect_urls (array)
. scopes (array)
. token_access_policy
. user_authorized_scopes (array)
} (object) required
delete_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations_by_integration_idDelete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.account_id (string)
integration_id (string)
get_api_2_0_accounts_by_account_id_oauth2_published_app_integrationsGet the list of published OAuth app integrations for the specified Databricks accountaccount_id (string)
page_token (string)
page_size (integer)
post_api_2_0_accounts_by_account_id_oauth2_published_app_integrationsCreate Published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.account_id (string)
data: {
. app_id (string)
. token_access_policy
} (object) required
get_api_2_0_accounts_by_account_id_oauth2_published_app_integrations_by_integration_idGets the Published OAuth App Integration for the given integration id.account_id (string)
integration_id (string)
patch_api_2_0_accounts_by_account_id_oauth2_published_app_integrations_by_integration_idUpdates an existing published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.account_id (string)
integration_id (string)
data: {
. token_access_policy
} (object) required
delete_api_2_0_accounts_by_account_id_oauth2_published_app_integrations_by_integration_idDelete an existing Published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.account_id (string)
integration_id (string)
get_api_2_0_accounts_by_account_id_oauth2_published_appsGet all the available published OAuth apps in Databricks.account_id (string)
page_token (string)
page_size (integer)
get_api_2_0_accounts_by_account_id_private_access_settingsGets a list of all private access settings objects for an account, specified by ID.account_id (string)
post_api_2_0_accounts_by_account_id_private_access_settingsCreates a private access settings object, which specifies how your workspace is accessed over AWS PrivateLinkhttps://aws.amazon.com/privatelink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's private_access_settings_id property. You can share one private access settings with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use aaccount_id (string)
data: {
. allowed_vpc_endpoint_ids (array)
. private_access_level
. private_access_settings_name (string)
. public_access_enabled (boolean)
. region (string)
} (object) required
get_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_idGets a private access settings object, which specifies how your workspace is accessed over AWS PrivateLinkhttps://aws.amazon.com/privatelink. Before configuring PrivateLink, read the Databricks article about PrivateLinkhttps://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html.',account_id (string)
private_access_settings_id (string)
put_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_idUpdates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLinkhttps://aws.amazon.com/privatelink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's private_access_settings_id property. This operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any changeaccount_id (string)
private_access_settings_id (string)
data: {
. allowed_vpc_endpoint_ids (array)
. private_access_level
. private_access_settings_name (string)
. public_access_enabled (boolean)
. region (string)
} (object) required
delete_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_idDeletes a private access settings object, which determines how your workspace is accessed over AWS PrivateLinkhttps://aws.amazon.com/privatelink. Before configuring PrivateLink, read the Databricks article about PrivateLinkhttps://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html.',account_id (string)
private_access_settings_id (string)
get_api_2_0_accounts_by_account_id_scim_v2_groupsGets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint will not return members. Instead, members should be retrieved by iterating through Get group details.account_id (string)
filter (string)
attributes (string)
excludedAttributes (string)
startIndex (integer)
count (integer)
sortBy (string)
sortOrder (string)
post_api_2_0_accounts_by_account_id_scim_v2_groupsCreates a group in the Databricks account with a unique name, using the supplied group details.account_id (string)
data: {
. displayName (string)
. externalId (string)
. id (string)
. members (array)
. roles (array)
} (object) required
get_api_2_0_accounts_by_account_id_scim_v2_groups_by_idGets the information for a specific group in the Databricks account.account_id (string)
id (string)
put_api_2_0_accounts_by_account_id_scim_v2_groups_by_idUpdates the details of a group by replacing the entire group entity.account_id (string)
id (string)
data: {
. displayName (string)
. externalId (string)
. id (string)
. members (array)
. roles (array)
} (object) required
patch_api_2_0_accounts_by_account_id_scim_v2_groups_by_idPartially updates the details of a group.account_id (string)
id (string)
data: {
. Operations (array)
. schemas (array)
} (object) required
delete_api_2_0_accounts_by_account_id_scim_v2_groups_by_idDeletes a group from the Databricks account.account_id (string)
id (string)
get_api_2_0_accounts_by_account_id_scim_v2_service_principalsGets the set of service principals associated with a Databricks account.account_id (string)
attributes (string)
count (integer)
excludedAttributes (string)
filter (string)
sortBy (string)
sortOrder (string)
startIndex (integer)
post_api_2_0_accounts_by_account_id_scim_v2_service_principalsCreates a new service principal in the Databricks account.account_id (string)
data: {
. active (boolean)
. applicationId (string)
. displayName (string)
. externalId (string)
. id (string)
. roles (array)
} (object) required
get_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_idGets the details for a single service principal define in the Databricks account.account_id (string)
id (string)
put_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_idUpdates the details of a single service principal. This action replaces the existing service principal with the same name.account_id (string)
id (string)
data: {
. active (boolean)
. applicationId (string)
. displayName (string)
. externalId (string)
. id (string)
. roles (array)
} (object) required
patch_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_idPartially updates the details of a single service principal in the Databricks account.account_id (string)
id (string)
data: {
. Operations (array)
. schemas (array)
} (object) required
delete_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_idDelete a single service principal in the Databricks account.account_id (string)
id (string)
get_api_2_0_accounts_by_account_id_scim_v2_usersGets details for all the users associated with a Databricks account.account_id (string)
attributes (string)
count (integer)
excludedAttributes (string)
filter (string)
sortBy (string)
sortOrder (string)
startIndex (integer)
post_api_2_0_accounts_by_account_id_scim_v2_usersCreates a new user in the Databricks account. This new user will also be added to the Databricks account.account_id (string)
data: {
. active (boolean)
. displayName (string)
. emails (array)
. externalId (string)
. id (string)
. name
. roles (array)
. userName (string)
} (object) required
get_api_2_0_accounts_by_account_id_scim_v2_users_by_idGets information for a specific user in Databricks account.account_id (string)
id (string)
attributes (string)
count (integer)
excludedAttributes (string)
filter (string)
sortBy (string)
sortOrder (string)
startIndex (integer)
put_api_2_0_accounts_by_account_id_scim_v2_users_by_idReplaces a user's information with the data supplied in request.account_id (string)
id (string)
data: {
. active (boolean)
. displayName (string)
. emails (array)
. externalId (string)
. id (string)
. name
. roles (array)
. userName (string)
} (object) required
patch_api_2_0_accounts_by_account_id_scim_v2_users_by_idPartially updates a user resource by applying the supplied operations on specific user attributes.account_id (string)
id (string)
data: {
. Operations (array)
. schemas (array)
} (object) required
delete_api_2_0_accounts_by_account_id_scim_v2_users_by_idDeletes a user. Deleting a user from a Databricks account also removes objects associated with the user.account_id (string)
id (string)
get_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_credentials_secretsList all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values.account_id (string)
service_principal_id (string)
page_token (string)
page_size (integer)
post_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_credentials_secretsCreate a secret for the given service principal.account_id (string)
service_principal_id (string)
data: {
. lifetime (string)
} (object) required
delete_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_credentials_secrets_by_secret_idDelete a secret from the given service principal.account_id (string)
service_principal_id (string)
secret_id (string)
get_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policiesList account federation policies.account_id (string)
service_principal_id (integer)
page_size (integer)
page_token (string)
post_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policiesCreate account federation policy.account_id (string)
service_principal_id (integer)
policy_id (string)
data: {
. create_time (string)
. description (string)
. name (string)
. oidc_policy
. policy_id (string)
. service_principal_id (integer)
. uid (string)
. update_time (string)
} (object) required
get_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies_by_policy_idGet account federation policy.account_id (string)
service_principal_id (integer)
policy_id (string)
patch_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies_by_policy_idUpdate account federation policy.account_id (string)
service_principal_id (integer)
policy_id (string)
update_mask (string)
data: {
. create_time (string)
. description (string)
. name (string)
. oidc_policy
. policy_id (string)
. service_principal_id (integer)
. uid (string)
. update_time (string)
} (object) required
delete_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies_by_policy_idDelete account federation policy.account_id (string)
service_principal_id (integer)
policy_id (string)
get_api_2_0_accounts_by_account_id_settings_types_disable_legacy_features_names_defaultGets the value of the disable legacy features setting.account_id (string)
etag (string)
patch_api_2_0_accounts_by_account_id_settings_types_disable_legacy_features_names_defaultUpdates the value of the disable legacy features setting.account_id (string)
data: {
. allow_missing (boolean)
. field_mask (string)
. setting
} (object) required
delete_api_2_0_accounts_by_account_id_settings_types_disable_legacy_features_names_defaultDeletes the disable legacy features setting.account_id (string)
etag (string)
get_api_2_0_accounts_by_account_id_settings_types_shield_csp_enablement_ac_names_defaultGets the compliance security profile setting for new workspaces.account_id (string)
etag (string)
patch_api_2_0_accounts_by_account_id_settings_types_shield_csp_enablement_ac_names_defaultUpdates the value of the compliance security profile setting for new workspaces.account_id (string)
data: {
. allow_missing (boolean)
. field_mask (string)
. setting
} (object) required
get_api_2_0_accounts_by_account_id_settings_types_shield_esm_enablement_ac_names_defaultGets the enhanced security monitoring setting for new workspaces.account_id (string)
etag (string)
patch_api_2_0_accounts_by_account_id_settings_types_shield_esm_enablement_ac_names_defaultUpdates the value of the enhanced security monitoring setting for new workspaces.account_id (string)
data: {
. allow_missing (boolean)
. field_mask (string)
. setting
} (object) required
get_api_2_0_accounts_by_account_id_storage_configurationsGets a list of all Databricks storage configurations for your account, specified by ID.account_id (string)
post_api_2_0_accounts_by_account_id_storage_configurationsCreates new storage configuration for an account, specified by ID. Uploads a storage configuration object that represents the root AWS S3 bucket in your account. Databricks stores related workspace assets including DBFS, cluster logs, and job results. For the AWS S3 bucket, you need to configure the required bucket policy. For information about how to create a new workspace with this API, see Create a new workspace using the Account APIhttp://docs.databricks.com/administration-guide/account-apiaccount_id (string)
data: {
. root_bucket_info
. storage_configuration_name (string)
} (object) required
get_api_2_0_accounts_by_account_id_storage_configurations_by_storage_configuration_idGets a Databricks storage configuration for an account, both specified by ID.account_id (string)
storage_configuration_id (string)
delete_api_2_0_accounts_by_account_id_storage_configurations_by_storage_configuration_idDeletes a Databricks storage configuration. You cannot delete a storage configuration that is associated with any workspace.account_id (string)
storage_configuration_id (string)
get_api_2_0_accounts_by_account_id_usage_downloadReturns billable usage logs in CSV format for the specified account and date range. For the data schema, see: - AWS: CSV file schemahttps://docs.databricks.com/administration-guide/account-settings/usage-analysis.html schema. - GCP: CSV file schemahttps://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html csv-file-schema. Note that this method might take multiple minutes to complete. Warning: Depending on the queried date range, the number of workspaces in the aaccount_id (string)
start_month (string) required
end_month (string) required
personal_data (boolean)
get_api_2_0_accounts_by_account_id_vpc_endpointsGets a list of all VPC endpoints for an account, specified by ID. Before configuring PrivateLink, read the Databricks article about PrivateLinkhttps://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html.account_id (string)
post_api_2_0_accounts_by_account_id_vpc_endpointsCreates a VPC endpoint configuration, which represents a VPC endpointhttps://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html object in AWS used to communicate privately with Databricks over AWS PrivateLinkhttps://aws.amazon.com/privatelink. After you create the VPC endpoint configuration, the Databricks endpoint servicehttps://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html automatically accepts the VPC endpoint. Before configuring PrivateLink, reaaccount_id (string)
data: {
. aws_vpc_endpoint_id (string)
. region (string)
. vpc_endpoint_name (string)
} (object) required
get_api_2_0_accounts_by_account_id_vpc_endpoints_by_vpc_endpoint_idGets a VPC endpoint configuration, which represents a VPC endpointhttps://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html object in AWS used to communicate privately with Databricks over AWS PrivateLinkhttps://aws.amazon.com/privatelink.account_id (string)
vpc_endpoint_id (string)
delete_api_2_0_accounts_by_account_id_vpc_endpoints_by_vpc_endpoint_idDeletes a VPC endpoint configuration, which represents an AWS VPC endpointhttps://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html that can communicate privately with Databricks over AWS PrivateLinkhttps://aws.amazon.com/privatelink. Before configuring PrivateLink, read the Databricks article about PrivateLinkhttps://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html.account_id (string)
vpc_endpoint_id (string)
get_api_2_0_accounts_by_account_id_workspacesGets a list of all workspaces associated with an account, specified by ID. This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.account_id (string)
post_api_2_0_accounts_by_account_id_workspacesCreates a new workspace using a credential configuration and a storage configuration, an optional network configuration if using a customer-managed VPC, an optional managed services key configuration if using customer-managed keys for managed services, and an optional storage key configuration if using customer-managed keys for storage. The key configurations used for managed services and storage encryption can be the same or different. Important: This operation is asynchronous. A response withaccount_id (string)
data: {
. aws_region (string)
. credentials_id (string)
. custom_tags (object)
. deployment_name (string)
. managed_services_customer_managed_key_id (string)
. network_id (string)
. pricing_tier
. private_access_settings_id (string)
. storage_configuration_id (string)
. storage_customer_managed_key_id (string)
. workspace_name (string)
} (object) required
get_api_2_0_accounts_by_account_id_workspaces_by_workspace_idGets information including status for a Databricks workspace, specified by ID. In the response, the workspace_status field indicates the current status. After initial workspace creation which is asynchronous, make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING. For information about how to create a new workspace with this API including error handling, see Create a new workspace using the Account APIhttp://docsaccount_id (string)
workspace_id (string)
patch_api_2_0_accounts_by_account_id_workspaces_by_workspace_idUpdates a workspace configuration for either a running workspace or a failed workspace. The elements that can be updated varies between these two use cases. Update a failed workspace You can update a Databricks workspace configuration for failed workspace deployment for some fields, but not all fields. For a failed workspace, this request supports updates to the following fields only: - Credential configuration ID - Storage configuration ID - Network configuration ID. Used only to add or chaccount_id (string)
workspace_id (string)
data: {
. aws_region (string)
. credentials_id (string)
. custom_tags (object)
. managed_services_customer_managed_key_id (string)
. network_connectivity_config_id (string)
. network_id (string)
. private_access_settings_id (string)
. storage_configuration_id (string)
. storage_customer_managed_key_id (string)
} (object) required
delete_api_2_0_accounts_by_account_id_workspaces_by_workspace_idTerminates and deletes a Databricks workspace. From an API perspective, deletion is immediate. However, it might take a few minutes for all workspaces resources to be deleted, depending on the size and number of workspace resources. This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.account_id (string)
workspace_id (string)
get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastoreGets the metastore assignment, if any, for the workspace specified by ID. If the workspace is assigned a metastore, the mappig will be returned. If no metastore is assigned to the workspace, the assignment will not be found and a 404 returned.account_id (string)
workspace_id (string)
post_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_idCreates an assignment to a metastore for a workspaceaccount_id (string)
workspace_id (string)
metastore_id (string)
data: {
. metastore_assignment
} (object) required
put_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_idUpdates an assignment to a metastore for a workspace. Currently, only the default catalog may be updated.account_id (string)
workspace_id (string)
metastore_id (string)
data: {
. metastore_assignment
} (object) required
delete_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_idDeletes a metastore assignment to a workspace, leaving the workspace with no metastore.account_id (string)
workspace_id (string)
metastore_id (string)
get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_networkGets the network option for a workspace. Every workspace has exactly one network policy binding, with 'default-policy' used if no explicit assignment exists.account_id (string)
workspace_id (integer)
put_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_networkUpdates the network option for a workspace. This operation associates the workspace with the specified network policy. To revert to the default policy, specify 'default-policy' as the network_policy_id.account_id (string)
workspace_id (integer)
data: {
. network_policy_id (string)
. workspace_id (integer)
} (object) required
get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignmentsGet the permission assignments for the specified Databricks account and Databricks workspace.account_id (string)
workspace_id (integer)
get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments_permissionsGet an array of workspace permissions for the specified account and workspace.account_id (string)
workspace_id (integer)
put_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments_principals_by_principal_idCreates or updates the workspace permissions assignment in a given account and workspace for the specified principal.account_id (string)
workspace_id (integer)
principal_id (integer)
data: {
. permissions (array)
} (object) required
delete_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments_principals_by_principal_idDeletes the workspace permissions assignment in a given account and workspace for the specified principal.account_id (string)
workspace_id (integer)
principal_id (integer)
post_api_2_0_identity_accounts_by_account_id_groups_resolve_by_external_idResolves a group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management AIM, this will return an error.account_id (string)
data: {
. external_id (string)
} (object) required
post_api_2_0_identity_accounts_by_account_id_service_principals_resolve_by_external_idResolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management AIM, this will return an error.account_id (string)
data: {
. external_id (string)
} (object) required
post_api_2_0_identity_accounts_by_account_id_users_resolve_by_external_idResolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management AIM, this will return an error.account_id (string)
data: {
. external_id (string)
} (object) required
get_api_2_0_identity_accounts_by_account_id_workspaces_by_workspace_id_workspace_access_details_by_principal_idReturns the access details for a principal in a workspace. Allows for checking access details for any provisioned principal user, service principal, or group in a workspace. Provisioned principal here refers to one that has been synced into Databricks from the customer's IdP or added explicitly to Databricks via SCIM/UI. Allows for passing in a 'view' parameter to control what fields are returned BASIC by default or FULL.account_id (string)
workspace_id (integer)
principal_id (integer)
view (string)
get_api_2_0_preview_accounts_by_account_id_access_control_assignable_rolesGets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the resource can contain an access rule of the role.account_id (string)
resource (string) required
get_api_2_0_preview_accounts_by_account_id_access_control_rule_setsGet a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported.account_id (string)
name (string) required
etag (string) required
put_api_2_0_preview_accounts_by_account_id_access_control_rule_setsReplace the rules of a rule set. First, use get to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates.account_id (string)
data: {
. name (string)
. rule_set
} (object) required
get_api_2_1_accounts_by_account_id_budget_policiesLists all policies. Policies are returned in the alphabetically ascending order of their names.account_id (string)
page_size (integer)
page_token (string)
filter_by: {
. creator_user_id (integer)
. creator_user_name (string)
. policy_name (string)
} (object)
sort_spec: {
. descending (boolean)
. field
} (object)
post_api_2_1_accounts_by_account_id_budget_policiesCreates a new policy.account_id (string)
data: {
. policy
. request_id (string)
} (object) required
get_api_2_1_accounts_by_account_id_budget_policies_by_policy_idRetrieves a policy by it's ID.account_id (string)
policy_id (string)
patch_api_2_1_accounts_by_account_id_budget_policies_by_policy_idUpdates a policyaccount_id (string)
policy_id (string)
limit_config (object)
data: {
. binding_workspace_ids (array)
. custom_tags (array)
. policy_id (string)
. policy_name (string)
} (object) required
delete_api_2_1_accounts_by_account_id_budget_policies_by_policy_idDeletes a policyaccount_id (string)
policy_id (string)
get_api_2_1_accounts_by_account_id_budgetsGets all budgets associated with this account.account_id (string)
page_token (string)
post_api_2_1_accounts_by_account_id_budgetsCreate a new budget configuration for an account. For full details, see https://docs.databricks.com/en/admin/account-settings/budgets.html.account_id (string)
data: {
. budget
} (object) required
get_api_2_1_accounts_by_account_id_budgets_by_budget_idGets a budget configuration for an account. Both account and budget configuration are specified by ID.account_id (string)
budget_id (string)
put_api_2_1_accounts_by_account_id_budgets_by_budget_idUpdates a budget configuration for an account. Both account and budget configuration are specified by ID.account_id (string)
budget_id (string)
data: {
. budget
} (object) required
delete_api_2_1_accounts_by_account_id_budgets_by_budget_idDeletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone.account_id (string)
budget_id (string)