Documentation
¶
Overview ¶
Databricks SDK for Go APIs
- iam.AccountAccessControlAPI: These APIs manage access rules on resources in an account.
- iam.AccountAccessControlProxyAPI: These APIs manage access rules on resources in an account.
- sql.AlertsAPI: The alerts API can be used to perform CRUD operations on alerts.
- serving.AppsAPI: Apps run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on.
- catalog.ArtifactAllowlistsAPI: In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist` in UC so that users can leverage these artifacts on compute configured with shared access mode.
- settings.AutomaticClusterUpdateAPI: Controls whether automatic cluster update is enabled for the current workspace.
- billing.BillableUsageAPI: This API allows you to download billable usage logs for the specified account and date range.
- billing.BudgetsAPI: These APIs manage budget configuration including notifications for exceeding a budget for a period.
- catalog.CatalogsAPI: A catalog is the first layer of Unity Catalog’s three-level namespace.
- sharing.CleanRoomsAPI: A clean room is a secure, privacy-protecting environment where two or more parties can share sensitive enterprise data, including customer data, for measurements, insights, activation and other use cases.
- compute.ClusterPoliciesAPI: You can use cluster policies to control users' ability to configure clusters based on a set of rules.
- compute.ClustersAPI: The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
- compute.CommandExecutionAPI: This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
- settings.ComplianceSecurityProfileAPI: Controls whether to enable the compliance security profile for the current workspace.
- catalog.ConnectionsAPI: Connections allow for creating a connection to an external data source.
- marketplace.ConsumerFulfillmentsAPI: Fulfillments are entities that allow consumers to preview installations.
- marketplace.ConsumerInstallationsAPI: Installations are entities that allow consumers to interact with Databricks Marketplace listings.
- marketplace.ConsumerListingsAPI: Listings are the core entities in the Marketplace.
- marketplace.ConsumerPersonalizationRequestsAPI: Personalization Requests allow customers to interact with the individualized Marketplace listing flow.
- marketplace.ConsumerProvidersAPI: Providers are the entities that publish listings to the Marketplace.
- provisioning.CredentialsAPI: These APIs manage credential configurations for this workspace.
- settings.CredentialsManagerAPI: Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens.
- settings.CspEnablementAccountAPI: The compliance security profile settings at the account level control whether to enable it for new workspaces.
- iam.CurrentUserAPI: This API allows retrieving information about currently authenticated user or service principal.
- oauth2.CustomAppIntegrationAPI: These APIs enable administrators to manage custom oauth app integrations, which is required for adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.
- sql.DashboardWidgetsAPI: This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace.
- sql.DashboardsAPI: In general, there is little need to modify dashboards using the API.
- sql.DataSourcesAPI: This API is provided to assist you in making new query objects.
- files.DbfsAPI: DBFS API makes it simple to interact with various data sources without having to include a users credentials every time to read a file.
- sql.DbsqlPermissionsAPI: The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
- settings.DefaultNamespaceAPI: The default namespace setting API allows users to configure the default namespace for a Databricks workspace.
- provisioning.EncryptionKeysAPI: These APIs manage encryption key configurations for this workspace (optional).
- settings.EnhancedSecurityMonitoringAPI: Controls whether enhanced security monitoring is enabled for the current workspace.
- settings.EsmEnablementAccountAPI: The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces.
- ml.ExperimentsAPI: Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an experiment.
- catalog.ExternalLocationsAPI: An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path.
- files.FilesAPI: The Files API is a standard HTTP API that allows you to read, write, list, and delete files and directories by referring to their URI.
- catalog.FunctionsAPI: Functions implement User-Defined Functions (UDFs) in Unity Catalog.
- workspace.GitCredentialsAPI: Registers personal access token for Databricks to do operations on behalf of the user.
- compute.GlobalInitScriptsAPI: The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace.
- catalog.GrantsAPI: In Unity Catalog, data is secure by default.
- iam.GroupsAPI: Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects.
- iam.AccountGroupsAPI: Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects.
- compute.InstancePoolsAPI: Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use cloud instances which reduces a cluster start and auto-scaling times.
- compute.InstanceProfilesAPI: The Instance Profiles API allows admins to add, list, and remove instance profiles that users can launch clusters with.
- settings.IpAccessListsAPI: IP Access List enables admins to configure IP access lists.
- settings.AccountIpAccessListsAPI: The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.
- jobs.JobsAPI: The Jobs API allows you to create, edit, and delete jobs.
- catalog.LakehouseMonitorsAPI: A monitor computes and monitors data or model quality metrics for a table over time.
- dashboards.LakeviewAPI: These APIs provide specific management operations for Lakeview dashboards.
- compute.LibrariesAPI: The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster.
- billing.LogDeliveryAPI: These APIs manage log delivery configurations for this account.
- catalog.AccountMetastoreAssignmentsAPI: These APIs manage metastore assignments to a workspace.
- catalog.MetastoresAPI: A metastore is the top-level container of objects in Unity Catalog.
- catalog.AccountMetastoresAPI: These APIs manage Unity Catalog metastores for an account.
- ml.ModelRegistryAPI: Note: This API reference documents APIs for the Workspace Model Registry.
- catalog.ModelVersionsAPI: Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
- settings.NetworkConnectivityAPI: These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources.
- provisioning.NetworksAPI: These APIs manage network configurations for customer-managed VPCs (optional).
- oauth2.OAuthPublishedAppsAPI: These APIs enable administrators to view all the available published OAuth applications in Databricks.
- catalog.OnlineTablesAPI: Online tables provide lower latency and higher QPS access to data from Delta tables.
- iam.PermissionMigrationAPI: This spec contains undocumented permission migration APIs used in https://github.com/databrickslabs/ucx.
- iam.PermissionsAPI: Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints.
- settings.PersonalComputeAPI: The Personal Compute enablement setting lets you control which users can use the Personal Compute default policy to create compute resources.
- pipelines.PipelinesAPI: The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines.
- compute.PolicyFamiliesAPI: View available policy families.
- provisioning.PrivateAccessAPI: These APIs manage private access settings for this account.
- marketplace.ProviderExchangeFiltersAPI: Marketplace exchanges filters curate which groups can access an exchange.
- marketplace.ProviderExchangesAPI: Marketplace exchanges allow providers to share their listings with a curated set of customers.
- marketplace.ProviderFilesAPI: Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider icons.
- marketplace.ProviderListingsAPI: Listings are the core entities in the Marketplace.
- marketplace.ProviderPersonalizationRequestsAPI: Personalization requests are an alternate to instantly available listings.
- marketplace.ProviderProviderAnalyticsDashboardsAPI: Manage templated analytics solution for providers.
- marketplace.ProviderProvidersAPI: Providers are entities that manage assets in Marketplace.
- sharing.ProvidersAPI: A data provider is an object representing the organization in the real world who shares the data.
- oauth2.PublishedAppIntegrationAPI: These APIs enable administrators to manage published oauth app integrations, which is required for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS cloud.
- sql.QueriesAPI: These endpoints are used for CRUD operations on query definitions.
- sql.QueryHistoryAPI: Access the history of queries through SQL warehouses.
- sql.QueryVisualizationsAPI: This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace.
- sharing.RecipientActivationAPI: The Recipient Activation API is only applicable in the open sharing model where the recipient object has the authentication type of `TOKEN`.
- sharing.RecipientsAPI: A recipient is an object you create using :method:recipients/create to represent an organization which you want to allow access shares.
- catalog.RegisteredModelsAPI: Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
- workspace.ReposAPI: The Repos API allows users to manage their git repos.
- settings.RestrictWorkspaceAdminsAPI: The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
- catalog.SchemasAPI: A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
- workspace.SecretsAPI: The Secrets API allows you to manage secrets, secret scopes, and access permissions.
- oauth2.ServicePrincipalSecretsAPI: These APIs enable administrators to manage service principal secrets.
- iam.ServicePrincipalsAPI: Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms.
- iam.AccountServicePrincipalsAPI: Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms.
- serving.ServingEndpointsAPI: The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
- settings.SettingsAPI: Workspace Settings API allows users to manage settings at the workspace level.
- settings.AccountSettingsAPI: Accounts Settings API allows users to manage settings at the account level.
- sharing.SharesAPI: A share is a container instantiated with :method:shares/create.
- sql.StatementExecutionAPI: The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.
- provisioning.StorageAPI: These APIs manage storage configurations for this workspace.
- catalog.StorageCredentialsAPI: A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant.
- catalog.AccountStorageCredentialsAPI: These APIs manage storage credentials for a particular metastore.
- catalog.SystemSchemasAPI: A system schema is a schema that lives within the system catalog.
- catalog.TableConstraintsAPI: Primary key and foreign key constraints encode relationships between fields in tables.
- catalog.TablesAPI: A table resides in the third layer of Unity Catalog’s three-level namespace.
- settings.TokenManagementAPI: Enables administrators to get all tokens and delete tokens for other users.
- settings.TokensAPI: The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.
- iam.UsersAPI: User identities recognized by Databricks and represented by email addresses.
- iam.AccountUsersAPI: User identities recognized by Databricks and represented by email addresses.
- vectorsearch.VectorSearchEndpointsAPI: **Endpoint**: Represents the compute resources to host vector search indexes.
- vectorsearch.VectorSearchIndexesAPI: **Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries.
- catalog.VolumesAPI: Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files.
- provisioning.VpcEndpointsAPI: These APIs manage VPC endpoint configurations for this account.
- sql.WarehousesAPI: A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL.
- workspace.WorkspaceAPI: The Workspace API allows you to list, import, export, and delete notebooks and folders.
- iam.WorkspaceAssignmentAPI: The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account.
- catalog.WorkspaceBindingsAPI: A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.
- settings.WorkspaceConfAPI: This API allows updating known workspace settings for advanced users.
- provisioning.WorkspacesAPI: These APIs manage workspaces for this account.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
These APIs allow you to manage Billable Usage, Budgets, Log Delivery, etc.
|
These APIs allow you to manage Billable Usage, Budgets, Log Delivery, etc. |
|
These APIs allow you to manage Account Metastore Assignments, Account Metastores, Account Storage Credentials, Artifact Allowlists, Catalogs, Connections, External Locations, Functions, Grants, Lakehouse Monitors, Metastores, Model Versions, Online Tables, Registered Models, Schemas, Storage Credentials, System Schemas, Table Constraints, Tables, Volumes, Workspace Bindings, etc.
|
These APIs allow you to manage Account Metastore Assignments, Account Metastores, Account Storage Credentials, Artifact Allowlists, Catalogs, Connections, External Locations, Functions, Grants, Lakehouse Monitors, Metastores, Model Versions, Online Tables, Registered Models, Schemas, Storage Credentials, System Schemas, Table Constraints, Tables, Volumes, Workspace Bindings, etc. |
|
These APIs allow you to manage Cluster Policies, Clusters, Command Execution, Global Init Scripts, Instance Pools, Instance Profiles, Libraries, Policy Families, etc.
|
These APIs allow you to manage Cluster Policies, Clusters, Command Execution, Global Init Scripts, Instance Pools, Instance Profiles, Libraries, Policy Families, etc. |
|
These APIs provide specific management operations for Lakeview dashboards.
|
These APIs provide specific management operations for Lakeview dashboards. |
|
These APIs allow you to manage Dbfs, Files, etc.
|
These APIs allow you to manage Dbfs, Files, etc. |
|
These APIs allow you to manage Account Access Control, Account Access Control Proxy, Account Groups, Account Service Principals, Account Users, Current User, Groups, Permission Migration, Permissions, Service Principals, Users, Workspace Assignment, etc.
|
These APIs allow you to manage Account Access Control, Account Access Control Proxy, Account Groups, Account Service Principals, Account Users, Current User, Groups, Permission Migration, Permissions, Service Principals, Users, Workspace Assignment, etc. |
|
The Jobs API allows you to create, edit, and delete jobs.
|
The Jobs API allows you to create, edit, and delete jobs. |
|
These APIs allow you to manage Consumer Fulfillments, Consumer Installations, Consumer Listings, Consumer Personalization Requests, Consumer Providers, Provider Exchange Filters, Provider Exchanges, Provider Files, Provider Listings, Provider Personalization Requests, Provider Provider Analytics Dashboards, Provider Providers, etc.
|
These APIs allow you to manage Consumer Fulfillments, Consumer Installations, Consumer Listings, Consumer Personalization Requests, Consumer Providers, Provider Exchange Filters, Provider Exchanges, Provider Files, Provider Listings, Provider Personalization Requests, Provider Provider Analytics Dashboards, Provider Providers, etc. |
|
These APIs allow you to manage Experiments, Model Registry, etc.
|
These APIs allow you to manage Experiments, Model Registry, etc. |
|
These APIs allow you to manage Custom App Integration, O Auth Published Apps, Published App Integration, Service Principal Secrets, etc.
|
These APIs allow you to manage Custom App Integration, O Auth Published Apps, Published App Integration, Service Principal Secrets, etc. |
|
The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines.
|
The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines. |
|
These APIs allow you to manage Credentials, Encryption Keys, Networks, Private Access, Storage, Vpc Endpoints, Workspaces, etc.
|
These APIs allow you to manage Credentials, Encryption Keys, Networks, Private Access, Storage, Vpc Endpoints, Workspaces, etc. |
|
These APIs allow you to manage Apps, Serving Endpoints, etc.
|
These APIs allow you to manage Apps, Serving Endpoints, etc. |
|
These APIs allow you to manage Account Ip Access Lists, Account Settings, Automatic Cluster Update, Compliance Security Profile, Credentials Manager, Csp Enablement Account, Default Namespace, Enhanced Security Monitoring, Esm Enablement Account, Ip Access Lists, Network Connectivity, Personal Compute, Restrict Workspace Admins, Settings, Token Management, Tokens, Workspace Conf, etc.
|
These APIs allow you to manage Account Ip Access Lists, Account Settings, Automatic Cluster Update, Compliance Security Profile, Credentials Manager, Csp Enablement Account, Default Namespace, Enhanced Security Monitoring, Esm Enablement Account, Ip Access Lists, Network Connectivity, Personal Compute, Restrict Workspace Admins, Settings, Token Management, Tokens, Workspace Conf, etc. |
|
These APIs allow you to manage Clean Rooms, Providers, Recipient Activation, Recipients, Shares, etc.
|
These APIs allow you to manage Clean Rooms, Providers, Recipient Activation, Recipients, Shares, etc. |
|
These APIs allow you to manage Alerts, Dashboard Widgets, Dashboards, Data Sources, Dbsql Permissions, Queries, Query History, Query Visualizations, Statement Execution, Warehouses, etc.
|
These APIs allow you to manage Alerts, Dashboard Widgets, Dashboards, Data Sources, Dbsql Permissions, Queries, Query History, Query Visualizations, Statement Execution, Warehouses, etc. |
|
These APIs allow you to manage Vector Search Endpoints, Vector Search Indexes, etc.
|
These APIs allow you to manage Vector Search Endpoints, Vector Search Indexes, etc. |
|
These APIs allow you to manage Git Credentials, Repos, Secrets, Workspace, etc.
|
These APIs allow you to manage Git Credentials, Repos, Secrets, Workspace, etc. |