Documentation
¶
Overview ¶
Databricks SDK for Go APIs
- sql.AlertsAPI: The alerts API can be used to perform CRUD operations on alerts.
- 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.
- unitycatalog.CatalogsAPI: A catalog is the first layer of Unity Catalog’s three-level namespace.
- clusterpolicies.ClusterPoliciesAPI: Cluster policy limits the ability to configure clusters based on a set of rules.
- clusters.ClustersAPI: The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
- commands.CommandExecutionAPI: This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
- deployment.CredentialsAPI: These APIs manage credential configurations for this workspace.
- scim.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.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.
- dbfs.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.
- deployment.EncryptionKeysAPI: These APIs manage encryption key configurations for this workspace (optional).
- unitycatalog.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.
- unitycatalog.FunctionsAPI: Functions implement User-Defined Functions (UDFs) in Unity Catalog.
- gitcredentials.GitCredentialsAPI: Registers personal access token for Databricks to do operations on behalf of the user.
- globalinitscripts.GlobalInitScriptsAPI: The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace.
- unitycatalog.GrantsAPI: In Unity Catalog, data is secure by default.
- scim.GroupsAPI: Groups simplify identity management, making it easier to assign access to Databricks Workspace, data, and other securable objects.
- scim.AccountGroupsAPI: Groups simplify identity management, making it easier to assign access to Databricks Account, data, and other securable objects.
- instancepools.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.
- clusters.InstanceProfilesAPI: The Instance Profiles API allows admins to add, list, and remove instance profiles that users can launch clusters with.
- ipaccesslists.IpAccessListsAPI: IP Access List enables admins to configure IP access lists.
- jobs.JobsAPI: The Jobs API allows you to create, edit, and delete jobs.
- libraries.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.
- mlflow.MLflowDatabricksAPI: These endpoints are modified versions of the MLflow API that accept additional input parameters or return additional information.
- unitycatalog.AccountMetastoreAssignmentsAPI: These APIs manage metastore assignments to a workspace.
- unitycatalog.MetastoresAPI: A metastore is the top-level container of objects in Unity Catalog.
- unitycatalog.AccountMetastoresAPI: These APIs manage Unity Catalog metastores for an account.
- deployment.NetworksAPI: These APIs manage network configurations for customer-managed VPCs (optional).
- oauth2.OAuthEnrollmentAPI: These APIs enable administrators to enroll OAuth for their accounts, which is required for adding/using any OAuth published/custom application integration.
- permissions.PermissionsAPI: Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints.
- pipelines.PipelinesAPI: The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines.
- clusterpolicies.PolicyFamiliesAPI: View available policy families.
- deployment.PrivateAccessAPI: These APIs manage private access settings for this account.
- unitycatalog.ProvidersAPI: Databricks Delta Sharing: Providers REST API.
- oauth2.PublishedAppIntegrationAPI: These APIs enable administrators to manage published oauth app integrations, which is required for adding/using Published OAuth App Integration like Tableau Cloud 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.
- unitycatalog.RecipientActivationAPI: Databricks Delta Sharing: Recipient Activation REST API.
- unitycatalog.RecipientsAPI: Databricks Delta Sharing: Recipients REST API.
- repos.ReposAPI: The Repos API allows users to manage their git repos.
- unitycatalog.SchemasAPI: A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
- secrets.SecretsAPI: The Secrets API allows you to manage secrets, secret scopes, and access permissions.
- scim.ServicePrincipalsAPI: Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms.
- scim.AccountServicePrincipalsAPI: Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms.
- endpoints.ServingEndpointsAPI: The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
- unitycatalog.SharesAPI: Databricks Delta Sharing: Shares REST API.
- sql.StatementExecutionAPI: The SQL Statement Execution API manages the execution of arbitrary SQL statements and the fetching of result data.
- deployment.StorageAPI: These APIs manage storage configurations for this workspace.
- unitycatalog.StorageCredentialsAPI: A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant.
- unitycatalog.AccountStorageCredentialsAPI: These APIs manage storage credentials for a particular metastore.
- unitycatalog.TableConstraintsAPI: Primary key and foreign key constraints encode relationships between fields in tables.
- unitycatalog.TablesAPI: A table resides in the third layer of Unity Catalog’s three-level namespace.
- tokenmanagement.TokenManagementAPI: Enables administrators to get all tokens and delete tokens for other users.
- tokens.TokensAPI: The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.
- scim.UsersAPI: User identities recognized by Databricks and represented by email addresses.
- scim.AccountUsersAPI: User identities recognized by Databricks and represented by email addresses.
- deployment.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.
- permissions.WorkspaceAssignmentAPI: Databricks Workspace Assignment REST API.
- workspaceconf.WorkspaceConfAPI: This API allows updating known workspace settings for advanced users.
- deployment.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 Cluster Policies, Policy Families, etc.
|
These APIs allow you to manage Cluster Policies, Policy Families, etc. |
|
These APIs allow you to manage Clusters, Instance Profiles, etc.
|
These APIs allow you to manage Clusters, Instance Profiles, etc. |
|
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters. |
|
DBFS API makes it simple to interact with various data sources without having to include a users credentials every time to read a file.
|
DBFS API makes it simple to interact with various data sources without having to include a users credentials every time to read a file. |
|
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. |
|
The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
|
The Serving Endpoints API allows you to create, update, and delete model serving endpoints. |
|
Registers personal access token for Databricks to do operations on behalf of the user.
|
Registers personal access token for Databricks to do operations on behalf of the user. |
|
The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace.
|
The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace. |
|
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.
|
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. |
|
IP Access List enables admins to configure IP access lists.
|
IP Access List enables admins to configure IP access lists. |
|
The Jobs API allows you to create, edit, and delete jobs.
|
The Jobs API allows you to create, edit, and delete jobs. |
|
The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster.
|
The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster. |
|
These APIs allow you to manage Experiments, M Lflow Artifacts, M Lflow Databricks, M Lflow Metrics, M Lflow Runs, Model Version Comments, Model Versions, Registered Models, Registry Webhooks, Transition Requests, etc.
|
These APIs allow you to manage Experiments, M Lflow Artifacts, M Lflow Databricks, M Lflow Metrics, M Lflow Runs, Model Version Comments, Model Versions, Registered Models, Registry Webhooks, Transition Requests, etc. |
|
These APIs allow you to manage Custom App Integration, O Auth Enrollment, Published App Integration, etc.
|
These APIs allow you to manage Custom App Integration, O Auth Enrollment, Published App Integration, etc. |
|
These APIs allow you to manage Permissions, Workspace Assignment, etc.
|
These APIs allow you to manage Permissions, Workspace Assignment, 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. |
|
The Repos API allows users to manage their git repos.
|
The Repos API allows users to manage their git repos. |
|
These APIs allow you to manage Account Groups, Account Service Principals, Account Users, Current User, Groups, Service Principals, Users, etc.
|
These APIs allow you to manage Account Groups, Account Service Principals, Account Users, Current User, Groups, Service Principals, Users, etc. |
|
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
The Secrets API allows you to manage secrets, secret scopes, and access permissions. |
|
These APIs allow you to manage Alerts, Dashboards, Data Sources, Dbsql Permissions, Queries, Query History, Statement Execution, Warehouses, etc.
|
These APIs allow you to manage Alerts, Dashboards, Data Sources, Dbsql Permissions, Queries, Query History, Statement Execution, Warehouses, etc. |
|
Enables administrators to get all tokens and delete tokens for other users.
|
Enables administrators to get all tokens and delete tokens for other users. |
|
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.
|
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs. |
|
These APIs allow you to manage Account Metastore Assignments, Account Metastores, Account Storage Credentials, Catalogs, External Locations, Functions, Grants, Metastores, Providers, Recipient Activation, Recipients, Schemas, Shares, Storage Credentials, Table Constraints, Tables, etc.
|
These APIs allow you to manage Account Metastore Assignments, Account Metastores, Account Storage Credentials, Catalogs, External Locations, Functions, Grants, Metastores, Providers, Recipient Activation, Recipients, Schemas, Shares, Storage Credentials, Table Constraints, Tables, etc. |
|
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
The Workspace API allows you to list, import, export, and delete notebooks and folders. |
|
This API allows updating known workspace settings for advanced users.
|
This API allows updating known workspace settings for advanced users. |