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.
- catalog.CatalogsAPI: A catalog is the first layer of Unity Catalog’s three-level namespace.
- compute.ClusterPoliciesAPI: Cluster policy limits the 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.
- provisioning.CredentialsAPI: These APIs manage credential configurations for this workspace.
- 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.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.
- provisioning.EncryptionKeysAPI: These APIs manage encryption key configurations for this workspace (optional).
- 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.
- 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.
- 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.
- provisioning.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.
- iam.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.
- compute.PolicyFamiliesAPI: View available policy families.
- provisioning.PrivateAccessAPI: These APIs manage private access settings for this account.
- sharing.ProvidersAPI: Databricks 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.
- sharing.RecipientActivationAPI: Databricks Recipient Activation REST API.
- sharing.RecipientsAPI: Databricks Recipients REST API.
- workspace.ReposAPI: The Repos API allows users to manage their git repos.
- 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.
- 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.
- sharing.SharesAPI: Databricks Shares REST API.
- sql.StatementExecutionAPI: The SQL Statement Execution API manages the execution of arbitrary SQL statements and the fetching of result data.
- 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.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.
- 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.
- 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, Catalogs, External Locations, Functions, Grants, Metastores, Schemas, Storage Credentials, Table Constraints, Tables, Volumes, etc.
|
These APIs allow you to manage Account Metastore Assignments, Account Metastores, Account Storage Credentials, Catalogs, External Locations, Functions, Grants, Metastores, Schemas, Storage Credentials, Table Constraints, Tables, Volumes, 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. |
|
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 Account Groups, Account Service Principals, Account Users, Current User, Groups, Permissions, Service Principals, Users, Workspace Assignment, etc.
|
These APIs allow you to manage Account Groups, Account Service Principals, Account Users, Current User, Groups, 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 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 Enrollment, Published App Integration, etc.
|
These APIs allow you to manage Custom App Integration, O Auth Enrollment, Published App Integration, 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. |
|
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. |
|
These APIs allow you to manage Account Ip Access Lists, Ip Access Lists, Token Management, Tokens, Workspace Conf, etc.
|
These APIs allow you to manage Account Ip Access Lists, Ip Access Lists, Token Management, Tokens, Workspace Conf, etc. |
|
These APIs allow you to manage Providers, Recipient Activation, Recipients, Shares, etc.
|
These APIs allow you to manage Providers, Recipient Activation, Recipients, Shares, etc. |
|
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. |
|
These APIs allow you to manage Git Credentials, Repos, Secrets, Workspace, etc.
|
These APIs allow you to manage Git Credentials, Repos, Secrets, Workspace, etc. |