Overview
Configuration is provided for establishing connections with the Databricks service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to read data from Snowflake.
Insert data
Use REST Destination component to insert/update/delete rows in a Snowflake table.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Configuration
Base URL address: https://{DATABRICKS_HOST}
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- Type: Required. Configure type of access token.
- account_id: Required. Specify account identifier.
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
- Scope: Required. Databricks scope.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.databricks.com/en/dev-tools/auth/oauth-u2m.html.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/git-credentials
.
The result is extracted from:{{=response.credentials}}
.Documentation: https://docs.databricks.com/api/workspace/gitcredentials/list.
- [Read single] action
-
Endpoint URL address:
/git-credentials/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/gitcredentials/get.
- [Create] action
-
Endpoint URL address:
/git-credentials
.Documentation: https://docs.databricks.com/api/workspace/gitcredentials/create.
- [Update] action
-
Endpoint URL address:
/git-credentials/{{=item.id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/gitcredentials/update.
- [Delete] action
-
Endpoint URL address:
/git-credentials/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/gitcredentials/delete.
The resource includes the fields from the T_git_credentials template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/repos/{{=parameters.repo_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- repo_id: Required. The repo for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/repos/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/repos/{{=parameters.repo_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- repo_id: Required. The repo for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/repos/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/repos/{{=parameters.repo_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- repo_id: Required. The repo for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/repos/setpermissions.
- [Update] action
-
Endpoint URL address:
/git-credentials/{{=item.credential_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- repo_id: Required. The repo for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/repos/updatepermissions.
Based on resource template WorkspacePagination.
- [Read List] action
-
Endpoint URL address:
/repos
.
The result is extracted from:{{=response.repos}}
.The action has the following user-defined parameters:
- path_prefix: Optional. Filters repos that have paths starting with the given path prefix. If not provided repos from /Repos will be served.
Documentation: https://docs.databricks.com/api/workspace/repos/list.
- [Read single] action
-
Endpoint URL address:
/repos/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/repos/get.
- [Create] action
-
Endpoint URL address:
/repos
.Documentation: https://docs.databricks.com/api/workspace/repos/create.
- [Update] action
-
Endpoint URL address:
/repos/{{=item.id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/repos/update.
- [Delete] action
-
Endpoint URL address:
/repos/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/repos/delete.
The resource includes the fields from the T_repo template.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/secrets/acls/list
.
The result is extracted from:{{=response.acls}}
.The action has the following user-defined parameters:
- scope: Required. The name of the scope to fetch ACL information from.
Documentation: https://docs.databricks.com/api/workspace/secrets/listacls.
- [Read single] action
-
Endpoint URL address:
/secrets/acls/get
.The action has the following user-defined parameters:
- scope: Required. The name of the scope to fetch ACL information from.
The following request parameters will be automatically processed:
-
principal:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/secrets/getacl.
- [Upsert] action
-
Endpoint URL address:
/secrets/acls/put
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/secrets/putacl.
- [Delete] action
-
Endpoint URL address:
/secrets/acls/delete
.Documentation: https://docs.databricks.com/api/workspace/secrets/deleteacl.
The resource includes the fields from the T_ACL template.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/secrets/list
.
The result is extracted from:{{=response.secrets}}
.The action has the following user-defined parameters:
- scope: Required. The name of the scope to list secrets within.
Documentation: https://docs.databricks.com/api/workspace/secrets/listsecrets.
- [Read single] action
-
Endpoint URL address:
/secrets/get
.The action has the following user-defined parameters:
- scope: Required. The name of the scope to fetch secret information from.
The following request parameters will be automatically processed:
-
key:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/secrets/getsecret.
- [Create] action
-
Endpoint URL address:
/secrets/put
.Documentation: https://docs.databricks.com/api/workspace/secrets/putsecret.
- [Delete] action
-
Endpoint URL address:
/secrets/delete
.Documentation: https://docs.databricks.com/api/workspace/secrets/deletesecret.
The resource includes the fields from the T_secret template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/secrets/scopes/list
.
The result is extracted from:{{=response.scopes}}
.Documentation: https://docs.databricks.com/api/workspace/secrets/listscopes.
- [Create] action
-
Endpoint URL address:
/secrets/scopes/put
.Documentation: https://docs.databricks.com/api/workspace/secrets/createscope.
- [Delete] action
-
Endpoint URL address:
/secrets/scopes/delete
.Documentation: https://docs.databricks.com/api/workspace/secrets/deletescope.
The resource includes the fields from the T_secret_scope template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/{{=parameters.workspace_object_type}}/{{=parameters.workspace_object_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- workspace_object_type: Required. The workspace object type for which to get or manage permissions.
- workspace_object_id: Required. The workspace object for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/workspace/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/{{=parameters.workspace_object_type}}/{{=parameters.workspace_object_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- workspace_object_type: Required. The workspace object type for which to get or manage permissions.
- workspace_object_id: Required. The workspace object for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/workspace/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/{{=parameters.workspace_object_type}}/{{=parameters.workspace_object_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- workspace_object_type: Required. The workspace object type for which to get or manage permissions.
- workspace_object_id: Required. The workspace object for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/repos/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/{{=parameters.workspace_object_type}}/{{=parameters.workspace_object_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- workspace_object_type: Required. The workspace object type for which to get or manage permissions.
- workspace_object_id: Required. The workspace object for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/workspace/updatepermissions.
Based on resource template Workspace.
- [Read List contents] action
-
Endpoint URL address:
/workspace/list
.
The result is extracted from:{{=response.objects}}
.The action has the following user-defined parameters:
- path: Required. The absolute path of the notebook or directory.
- notebooks_modified_after: Optional. UTC timestamp in milliseconds.
Documentation: https://docs.databricks.com/api/workspace/workspace/list.
- [Read Export] action
-
Endpoint URL address:
/workspace/export
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- path: Required. The absolute path of the notebook or directory.
- format: Optional. This specifies the format of the exported file. By default, this is SOURCE.
Documentation: https://docs.databricks.com/api/workspace/workspace/export.
- [Read Status] action
-
Endpoint URL address:
/workspace/get-status
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- path: Required. The absolute path of the notebook or directory.
Documentation: https://docs.databricks.com/api/workspace/workspace/getstatus.
- [Create] action
-
Endpoint URL address:
/workspace/import
.Documentation: https://docs.databricks.com/api/workspace/workspace/import.
- [Delete] action
-
Endpoint URL address:
/workspace/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/workspace/delete.
The resource includes the fields from the T_workspace_object template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: createDirectory.
-
Uses template:
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/cluster-policies/{{=parameters.cluster_policy_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- cluster_policy_id: Required. The cluster policy for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/cluster-policies/{{=parameters.cluster_policy_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- cluster_policy_id: Required. The cluster policy for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/cluster-policies/{{=parameters.cluster_policy_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- cluster_policy_id: Required. The cluster policy for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/cluster-policies/{{=parameters.cluster_policy_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- cluster_policy_id: Required. The cluster policy for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/updatepermissions.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/policies/clusters/list
.
The result is extracted from:{{=response.policies}}
.The action has the following user-defined parameters:
- sort_order: Optional. The order in which the policies get listed.
- sort_column: Optional. The cluster policy attribute to sort by.
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/list.
- [Read single] action
-
Endpoint URL address:
/policies/clusters/get
.The following request parameters will be automatically processed:
-
policy_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/get.
-
policy_id:
- [Create] action
-
Endpoint URL address:
/policies/clusters/create
.Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/create.
- [Update] action
-
Endpoint URL address:
/policies/clusters/edit
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/edit.
- [Delete] action
-
Endpoint URL address:
/policies/clusters/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/delete.
The resource includes the fields from the T_cluster_policy template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/clusters/{{=parameters.cluster_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- cluster_id: Required. The cluster for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusters/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/clusters/{{=parameters.cluster_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- cluster_id: Required. The cluster for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusters/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/clusters/{{=parameters.cluster_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- cluster_id: Required. The cluster for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusters/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/clusters/{{=parameters.cluster_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- cluster_id: Required. The cluster for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/clusters/updatepermissions.
Based on resource template Workspace21SizePagination.
- [Read List] action
-
Endpoint URL address:
/clusters/list
.
The result is extracted from:{{=response.clusters}}
.Documentation: https://docs.databricks.com/api/workspace/clusters/list.
- [Read single] action
-
Endpoint URL address:
/clusters/get
.The following request parameters will be automatically processed:
-
cluster_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/clusters/get.
-
cluster_id:
- [Create] action
-
Endpoint URL address:
/clusters/create
.Documentation: https://docs.databricks.com/api/workspace/clusters/create.
- [Update] action
-
Endpoint URL address:
/clusters/edit
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/clusters/edit.
- [Delete] action
-
Endpoint URL address:
/clusters/permanent-delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/clusters/permanentdelete.
The resource includes the fields from the T_cluster template.
Based on resource template Workspace21.
- [Read Activity events] action
-
Endpoint URL address:
/clusters/events
.
The result is extracted from:{{=response.events}}
.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- cluster_id: Required. The cluster for which to get or manage permissions.
- start_time: Optional. The start time in epoch milliseconds. If empty, returns events starting from the beginning of time.
- end_time: Optional. The end time in epoch milliseconds. If empty, returns events up to the current time.
- order: Optional. The order to list events in; either "ASC" or "DESC". Defaults to "DESC".
- event_types: Optional. An optional set of event types to filter on. If empty, all event types are returned.
The following request parameters will be automatically processed:
-
application/json:
{{={ offset: parameters.iterator, limit: parameters.batchSize } }}
Documentation: https://docs.databricks.com/api/workspace/clusters/events.
- [Read Node types] action
-
Endpoint URL address:
/clusters/list-node-types
.
The result is extracted from:{{=response.node_types}}
.Documentation: https://docs.databricks.com/api/workspace/clusters/listnodetypes.
- [Create] action
-
Endpoint URL address:
/
.Documentation: https://docs.databricks.com/api/workspace/clusters.
The resource includes the fields from the T_cluster_additional template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: restart, pin, unpin, terminate, start_terminated_cluster, resize, change_owner.
-
Uses template:
Based on resource template Workspace12.
- [Read] action
-
Endpoint URL address:
/commands/status
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- clusterId: Required. Databricks cluster id.
- contextId: Required. Databricks context id.
- commandId: Required. Databricks command id.
Documentation: https://docs.databricks.com/api/workspace/commandexecution/commandstatus.
- [Read Status] action
-
Endpoint URL address:
/contexts/status
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- clusterId: Required. Databricks cluster id.
- contextId: Required. Databricks context id.
Documentation: https://docs.databricks.com/api/workspace/commandexecution/contextstatus.
- [Create] action
-
Endpoint URL address:
/contexts/create
.Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/create.
- [Delete] action
-
Endpoint URL address:
/contexts/destroy
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/commandexecution/destroy.
The resource includes the fields from the T_command_execution template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: run, cancel.
-
Uses template:
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/global-init-scripts
.
The result is extracted from:{{=response.scripts}}
.Documentation: https://docs.databricks.com/api/workspace/globalinitscripts/list.
- [Read single] action
-
Endpoint URL address:
/global-init-scripts/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/globalinitscripts/get.
- [Create] action
-
Endpoint URL address:
/global-init-scripts
.Documentation: https://docs.databricks.com/api/workspace/globalinitscripts/create.
- [Update] action
-
Endpoint URL address:
/global-init-scripts/{{=item.script_id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/globalinitscripts/update.
- [Delete] action
-
Endpoint URL address:
/global-init-scripts/{{=item.script_id}}
.Documentation: https://docs.databricks.com/api/workspace/globalinitscripts/delete.
The resource includes the fields from the T_global_init_script_resource template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/instance-pools/{{=parameters.instance_pool_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- instance_pool_id: Required. The instance pool for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/instancepools/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/instance-pools/{{=parameters.instance_pool_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- instance_pool_id: Required. The instance pool for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/instancepools/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/instance-pools/{{=parameters.instance_pool_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- instance_pool_id: Required. The instance pool for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/instancepools/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/instance-pools/{{=parameters.instance_pool_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- instance_pool_id: Required. The instance pool for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/instancepools/updatepermissions.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/instance-pools/list
.
The result is extracted from:{{=response.instance_pools}}
.Documentation: https://docs.databricks.com/api/workspace/instancepools/list.
- [Read single] action
-
Endpoint URL address:
/instance-pools/get
.The following request parameters will be automatically processed:
-
instance_pool_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/instancepools/get.
-
instance_pool_id:
- [Create] action
-
Endpoint URL address:
/instance-pools/create
.Documentation: https://docs.databricks.com/api/workspace/instancepools/create.
- [Update] action
-
Endpoint URL address:
/instance-pools/edit
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/instancepools/edit.
- [Delete] action
-
Endpoint URL address:
/instance-pools/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/instancepools/delete.
The resource includes the fields from the T_instance_pool template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/instance-profiles/list
.
The result is extracted from:{{=response.instance_profiles}}
.Documentation: https://docs.databricks.com/api/workspace/instanceprofiles/list.
- [Create] action
-
Endpoint URL address:
/instance-profiles/add
.Documentation: https://docs.databricks.com/api/workspace/instanceprofiles/add.
- [Update] action
-
Endpoint URL address:
/instance-profiles/edit
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/instanceprofiles/edit.
- [Delete] action
-
Endpoint URL address:
/instance-profiles/remove
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/instanceprofiles/remove.
The resource includes the fields from the T_instance_profile template.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/libraries/all-cluster-statuses
.
The result is extracted from:{{=response.statuses}}
.Documentation: https://docs.databricks.com/api/workspace/libraries/allclusterlibrarystatuses.
- [Read single] action
-
Endpoint URL address:
/libraries/cluster-status
.The following request parameters will be automatically processed:
-
cluster_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/libraries/clusterstatus.
-
cluster_id:
- [Create] action
-
Endpoint URL address:
/libraries/install
.The action has the following user-defined parameters:
- cluster_id: Required. Unique identifier for the cluster on which to install these libraries.
The following request parameters will be automatically processed:
-
application/json:
{{={ libraries: Databricks.cleanNullValues(batch), cluster_id: parameters.cluster_id } }}
Documentation: https://docs.databricks.com/api/workspace/libraries/install.
- [Delete] action
-
Endpoint URL address:
/libraries/uninstall
.
The action uses POST method.The action has the following user-defined parameters:
- cluster_id: Required. Unique identifier for the cluster on which to uninstall these libraries.
The following request parameters will be automatically processed:
-
application/json:
{{={ libraries: Databricks.cleanNullValues(batch), cluster_id: parameters.cluster_id } }}
Documentation: https://docs.databricks.com/api/workspace/libraries/uninstall.
The resource includes the fields from the T_managed_library template.
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/policies/clusters/list-compliance
.
The result is extracted from:{{=response.clusters}}
.Documentation: https://docs.databricks.com/api/workspace/policycomplianceforclusters/listcompliance.
- [Read single] action
-
Endpoint URL address:
/policies/clusters/get-compliance
.The following request parameters will be automatically processed:
-
cluster_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/policycomplianceforclusters/getcompliance.
-
cluster_id:
- [Create] action
-
Endpoint URL address:
/policies/clusters/enforce-compliance
.Documentation: https://docs.databricks.com/api/workspace/policycomplianceforclusters/enforcecompliance.
The resource includes the fields from the T_policy_compliance_for_cluster template.
Based on resource template WorkspacePagination.
- [Read List] action
-
Endpoint URL address:
/policy-families
.
The result is extracted from:{{=response.policy_families}}
.Documentation: https://docs.databricks.com/api/workspace/policyfamilies/list.
- [Read single] action
-
Endpoint URL address:
/policy-families/{{=patameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/policyfamilies/get.
The resource includes the fields from the T_policy_famliy template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/instance-pools/{{=parameters.job_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- job_id: Required. The instance pool for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/jobs/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/jobs/{{=parameters.job_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- job_id: Required. The job for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/jobs/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/jobs/{{=parameters.job_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- job_id: Required. The job for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/jobs/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/jobs/{{=parameters.job_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- job_id: Required. The job for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/jobs/updatepermissions.
Based on resource template Workspace21LimitPagination.
- [Read List] action
-
Endpoint URL address:
/jobs/list
.
The result is extracted from:{{=Databricks.getJobs(response)}}
.The action has the following user-defined parameters:
- expand_tasks: Optional. Whether to include task and cluster details in the response.
- name: Optional. A filter on the list based on the exact (case insensitive) job name.
Documentation: https://docs.databricks.com/api/workspace/jobs/list.
- [Read single] action
-
Endpoint URL address:
/jobs/get
.
The result is extracted from:{{=Databricks.getJobs(response)}}
.The following request parameters will be automatically processed:
-
job_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/jobs/get.
-
job_id:
- [Create] action
-
Endpoint URL address:
/jobs/create
.Documentation: https://docs.databricks.com/api/workspace/jobs/create.
- [Update] action
-
Endpoint URL address:
/jobs/update
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/jobs/update.
- [Delete] action
-
Endpoint URL address:
/jobs/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/jobs/delete.
The resource includes the fields from the T_Job template.
- action
Field components:
-
Uses template:
T_oneTimeJob
. - Contains the following components: OneTimeRun.
-
Uses template:
Based on resource template Workspace21LimitPagination.
- [Read List] action
-
Endpoint URL address:
/jobs/runs/list
.
The result is extracted from:{{=response.runs}}
.Documentation: https://docs.databricks.com/api/workspace/jobs/listruns.
- [Read single] action
-
Endpoint URL address:
/jobs/runs/get
.The action has the following user-defined parameters:
- include_history: Optional. Whether to include the repair history in the response.
- include_resolved_values: Optional. Whether to include resolved parameter values in the response.
The following request parameters will be automatically processed:
-
job_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/jobs/getrun.
The resource includes the fields from the T_job_run template.
Based on resource template Workspace21.
- [Read Output] action
-
Endpoint URL address:
/jobs/runs/get-output
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- job_id: Required. The canonical identifier of the run for which to retrieve the metadata. This field is required.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/getrunoutput.
- [Read Export] action
-
Endpoint URL address:
/jobs/runs/export
.
The result is extracted from:{{=response.views}}
.The action has the following user-defined parameters:
- run_id: Required. The canonical identifier for the run.
- views_to_export: Optional. Which views to export (CODE, DASHBOARDS, or ALL). Defaults to CODE.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/exportrun.
- [Create] action
-
Endpoint URL address:
/jobs/run-now
.Documentation: https://docs.databricks.com/api/workspace/jobs/runnow.
- [Update] action
-
Endpoint URL address:
/jobs/runs/repair
.
The action uses POST method.Documentation: https://docs.databricks.com/api/azure/workspace/jobs/repairrun.
- [Delete] action
-
Endpoint URL address:
/jobs/runs/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/azure/workspace/jobs/deleterun.
The resource includes the fields from the T_jobrun_output_and_operations template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: Cancel, CancelAll.
-
Uses template:
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/policies/jobs/list-compliance
.
The result is extracted from:{{=response.jobs}}
.The action has the following user-defined parameters:
- policy_id: Required. Canonical unique identifier for the cluster policy.
Documentation: https://docs.databricks.com/api/workspace/policycomplianceforjobs/listcompliance.
- [Read single] action
-
Endpoint URL address:
/policies/jobs/get-compliance
.The following request parameters will be automatically processed:
-
job_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/policycomplianceforjobs/getcompliance.
-
job_id:
- [Create] action
-
Endpoint URL address:
/policies/jobs/enforce-compliance
.Documentation: https://docs.databricks.com/api/workspace/policycomplianceforjobs/enforcecompliance.
The resource includes the fields from the T_job_policy_compliance template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/pipelines/{{=parameters.pipeline_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- pipeline_id: Required. The pipeline for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/pipelines/{{=parameters.pipeline_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- pipeline_id: Required. The job for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/pipelines/{{=parameters.pipeline_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- pipeline_id: Required. The pipeline for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/pipelines/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/pipelines/{{=parameters.pipeline_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- pipeline_id: Required. The pipeline for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/pipelines/updatepermissions.
Based on resource template WorkspacePagination.
- [Read List] action
-
Endpoint URL address:
/pipelines
.
The result is extracted from:{{=response.statuses}}
.The action has the following user-defined parameters:
- order_by: Optional. A list of strings specifying the order of results. Supported order_by fields are id and name. The default is id asc. This field is optional.
- filter: Optional. Select a subset of results based on the specified criteria.
Documentation: https://docs.databricks.com/api/workspace/pipelines/listpipelines.
- [Read single] action
-
Endpoint URL address:
/pipelines/{{=parameters.id}}
.
The result is extracted from:{{=[_.extend(response, response.spec)]}}
.Documentation: https://docs.databricks.com/api/workspace/pipelines/get.
- [Create] action
-
Endpoint URL address:
/pipelines
.Documentation: https://docs.databricks.com/api/workspace/pipelines/create.
- [Update] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/pipelines/updatepermissions.
- [Delete] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/pipelines/delete.
The resource includes the fields from the T_pipeline template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: start, stop.
-
Uses template:
Based on resource template WorkspaceMaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipeline_id}}/updates
.
The result is extracted from:{{=response.updates }}
.The action has the following user-defined parameters:
- pipeline_id: Required. A list of strings specifying the order of results. Supported order_by fields are id and name. The default is id asc.
- until_update_id: Optional. If present, returns updates until and including this update_id.
Documentation: https://docs.databricks.com/api/workspace/pipelines/listupdates.
- [Read single] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipeline_id}}/updates/{{=parameters.id}}
.
The result is extracted from:{{=[_.extend(response.update, response.update.config)]}}
.The action has the following user-defined parameters:
- pipeline_id: Required. A list of strings specifying the order of results. Supported order_by fields are id and name. The default is id asc.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getupdate.
The resource includes the fields from the T_pipeline_update template.
Based on resource template WorkspaceMaxResultsPagination.
- [Read] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipeline_id}}/events
.
The result is extracted from:{{=response.events}}
.The action has the following user-defined parameters:
- order_by: Optional. A string indicating a sort order by timestamp for the results, for example, ["timestamp asc"].
- filter: Optional. Criteria to select a subset of results, expressed using a SQL-like syntax.
- pipeline_id: Required. A list of strings specifying the order of results. Supported order_by fields are id and name. The default is id asc.
Documentation: https://docs.databricks.com/api/workspace/pipelines/listpipelineevents.
The resource includes the fields from the T_pipeline_event template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/experiments/{{=parameters.experiment_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- experiment_id: Required. Gets the permissions of an experiment. Experiments can inherit permissions from their root object.
Documentation: https://docs.databricks.com/api/workspace/experiments/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/experiments/{{=parameters.experiment_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- experiment_id: Required. The experiment for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/experiments/{{=parameters.experiment_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- experiment_id: Required. Gets the permissions of an experiment. Experiments can inherit permissions from their root object.
Documentation: https://docs.databricks.com/api/workspace/experiments/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/experiments/{{=parameters.experiment_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- experiment_id: Required. Gets the permissions of an experiment. Experiments can inherit permissions from their root object.
Documentation: https://docs.databricks.com/api/workspace/experiments/updatepermissions.
Based on resource template WorkspaceMaxResultsPaginationWithSearchAndList.
- [Read List] action
-
Endpoint URL address:
/mlflow/experiments/list
.
The result is extracted from:{{=response.experiments}}
.The action has the following user-defined parameters:
- view_type: Optional. Qualifier for type of experiments to be returned. If unspecified, return only active experiments.
Documentation: https://docs.databricks.com/api/workspace/experiments/listexperiments.
- [Read single] action
-
Endpoint URL address:
/mlflow/experiments/get
.
The result is extracted from:{{=[response.experiment]}}
.The following request parameters will be automatically processed:
-
experiment_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/experiments/getexperiment.
-
experiment_id:
- [Read By name] action
-
Endpoint URL address:
/mlflow/experiments/get-by-name
.
The result is extracted from:{{=[response.experiment]}}
.The action has the following user-defined parameters:
- experiment_name: Required. Name of the associated experiment.
Documentation: https://docs.databricks.com/api/workspace/experiments/getbyname.
- [Read Search] action
-
Endpoint URL address:
/mlflow/experiments/search
.
The result is extracted from:{{=response.experiments}}
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/experiments/getbyname.
- [Create] action
-
Endpoint URL address:
/mlflow/experiments/create
.Documentation: https://docs.databricks.com/api/workspace/experiments/createexperiment.
- [Update] action
-
Endpoint URL address:
/mlflow/experiments/update
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/experiments/updateexperiment.
- [Delete] action
-
Endpoint URL address:
/mlflow/experiments/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/experiments/deleteexperiment.
The resource includes the fields from the T_experiment template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: SetTag.
-
Uses template:
Based on resource template WorkspaceMaxResultsPagination.
- [Read List] action
-
The result is extracted from:{{=_.map(response.runs, function(item) { return _.extend({}, item.info, item.data, item.inputs)}) }}
.
The action uses POST method.The action has the following user-defined parameters:
- experiment_ids: Optional. List of experiment IDs to search over.
- filter: Optional. A filter expression over params, metrics, and tags, that allows returning a subset of runs.
- run_view_type: Optional. Whether to display only active, only deleted, or all runs.
- order_by: Optional. List of columns to be ordered by, including attributes, params, metrics, and tags.
Documentation: https://docs.databricks.com/api/workspace/experiments/searchruns.
- [Read single] action
-
Endpoint URL address:
/mlflow/runs/get
.
The result is extracted from:{{=[_.extend({}, response.run.info, response.run.data, response.run.inputs)]}}
.The following request parameters will be automatically processed:
-
run_id:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/experiments/getrun.
-
run_id:
- [Create] action
-
Endpoint URL address:
/mlflow/runs/create
.Documentation: https://docs.databricks.com/api/workspace/experiments/createrun.
- [Update] action
-
Endpoint URL address:
/mlflow/runs/update
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/experiments/updaterun.
- [Delete] action
-
Endpoint URL address:
/mlflow/runs/delete
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/experiments/deleterun.
The resource includes the fields from the T_experiment_run template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: SetTag, Restore, RestoreByDeletionTime.
-
Uses template:
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/registered-models/{{=parameters.registered_model_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- registered_model_id: Required. The registered model for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/registered-models/{{=parameters.registered_model_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- registered_model_id: Required. The registered model for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/registered-models/{{=parameters.registered_model_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- registered_model_id: Required. The registered model for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/registered-models/{{=parameters.registered_model_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- registered_model_id: Required. The registered model for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/updatepermissions.
Based on resource template WorkspaceMaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/mlflow/model-versions/search
.
The result is extracted from:{{=response.model_versions}}
.The action has the following user-defined parameters:
- filter: Optional. String filter condition, like "name='my-model-name'".
- order_by: Optional. List of columns to be ordered by including model name, version, stage with an optional "DESC" or "ASC" annotation.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/searchmodelversions.
- [Read single] action
-
Endpoint URL address:
/mlflow/model-versions/get
.
The result is extracted from:{{=[response.model_version]}}
.The action has the following user-defined parameters:
- name: Required. Name of the registered model.
The following request parameters will be automatically processed:
-
version:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getmodelversion.
- [Read URI] action
-
Endpoint URL address:
/mlflow/model-versions/get-download-uri
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- name: Required. Name of the registered model.
- version: Required. Model version number.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getmodelversiondownloaduri.
- [Read Latest] action
-
Endpoint URL address:
/mlflow/registered-models/get-latest-versions
.
The result is extracted from:{{=response.model_versions}}
.
The action uses POST method.The action has the following user-defined parameters:
- name: Optional. Name of the registered model.
- stages: Optional. List of stages.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getlatestversions.
- [Create] action
-
Endpoint URL address:
/mlflow/model-versions/create
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/modelregistry/createmodelversion.
- [Update] action
-
Endpoint URL address:
/mlflow/model-versions/update
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/modelregistry/updatemodelversion.
- [Delete] action
-
Endpoint URL address:
/mlflow/model-versions/delete
.The following request parameters will be automatically processed:
-
name:
{{=item.name}}
-
version:
{{=item.version}}
Documentation: https://docs.databricks.com/api/workspace/modelregistry/deletemodelversion.
-
name:
The resource includes the fields from the T_model_version template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: SetTag, DeleteTag, PostComment, UpdateComment, DeleteComment.
-
Uses template:
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/mlflow/transition-requests/list
.
The result is extracted from:{{=response.requests}}
.The action has the following user-defined parameters:
- name: Required. Name of the model.
- version: Required. Version of the model.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/listtransitionrequests.
- [Create] action
-
Endpoint URL address:
/mlflow/transition-requests/create
.Documentation: https://docs.databricks.com/api/workspace/modelregistry/createtransitionrequest.
- [Delete] action
-
Endpoint URL address:
/mlflow/transition-requests/delete
.The following request parameters will be automatically processed:
-
name:
{{=item.name}}
-
version:
{{=item.version}}
-
stage:
{{=item.stage}}
-
creator:
{{=item.creator}}
-
comment:
{{=item.comment}}
Documentation: https://docs.databricks.com/api/workspace/modelregistry/deletetransitionrequest.
-
name:
The resource includes the fields from the T_model_version_transition template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: TransitionStage, ApproveTransitionRequest, RejectTransitionRequest.
-
Uses template:
Based on resource template WorkspaceMaxResultsPaginationWithSearchAndList.
- [Read List] action
-
Endpoint URL address:
/mlflow/databricks/registered-models/list
.
The result is extracted from:{{=response.registered_models}}
.Documentation: https://docs.databricks.com/api/workspace/modelregistry/listmodels.
- [Read single] action
-
Endpoint URL address:
/mlflow/databricks/registered-models/get
.
The result is extracted from:{{=[response.registered_model_databricks]}}
.The following request parameters will be automatically processed:
-
name:
{{=parameters.id}}
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getmodel.
-
name:
- [Read Search] action
-
Endpoint URL address:
/mlflow/databricks/registered-models/search
.
The result is extracted from:{{=response.registered_models}}
.The action has the following user-defined parameters:
- filter: Optional. String filter condition, like "name LIKE 'my-model-name'".
- order_by: Optional. List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/searchmodels.
- [Create] action
-
Endpoint URL address:
/mlflow/registered-models/create
.Documentation: https://docs.databricks.com/api/workspace/modelregistry/createmodel.
- [Update] action
-
Endpoint URL address:
/mlflow/registered-models/update
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/modelregistry/updatemodel.
- [Delete] action
-
Endpoint URL address:
/mlflow/registered-models/delete
.The following request parameters will be automatically processed:
-
name:
{{=item.name}}
Documentation: https://docs.databricks.com/api/workspace/modelregistry/deletemodel.
-
name:
The resource includes the fields from the T_model template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/mlflow/registry-webhooks/list
.
The result is extracted from:{{=response.webhooks}}
.The action has the following user-defined parameters:
- model_name: Optional. If not specified, all webhooks associated with the specified events are listed.
- events: Required. If events is specified, any webhook with one or more of the specified trigger events is included in the output.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/listwebhooks.
- [Create] action
-
Endpoint URL address:
/mlflow/registry-webhooks/create
.Documentation: https://docs.databricks.com/api/workspace/modelregistry/createwebhook.
- [Update] action
-
Endpoint URL address:
/mlflow/registry-webhooks/update
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/modelregistry/updatewebhook.
- [Delete] action
-
Endpoint URL address:
/mlflow/registry-webhooks/delete
.The following request parameters will be automatically processed:
-
id:
{{=item.id}}
Documentation: https://docs.databricks.com/api/workspace/modelregistry/deletewebhook.
-
id:
The resource includes the fields from the T_model_webhook template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: TestWebhook.
-
Uses template:
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/serving-endpoints/{{=parameters.serving_endpoint_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- serving_endpoint_id: Required. The serving endpoint for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/serving-endpoints/{{=parameters.serving_endpoint_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- serving_endpoint_id: Required. The serving endpoint for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/serving-endpoints/{{=parameters.serving_endpoint_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- serving_endpoint_id: Required. The serving endpoint for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/serving-endpoints/{{=parameters.serving_endpoint_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- serving_endpoint_id: Required. The serving endpoint for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/updatepermissions.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/serving-endpoints
.
The result is extracted from:{{=response.endpoints}}
.Documentation: https://docs.databricks.com/api/workspace/servingendpoints/list.
- [Read single] action
-
Endpoint URL address:
/serving-endpoints/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/servingendpoints/get.
- [Read Served model latest logs] action
-
Endpoint URL address:
/serving-endpoints/{{=parameters.name}}/served-models/{{=parameters.served_model_name}}/logs
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- name: Required. The name of the serving endpoint that the served model belongs to.
- served_model_name: Required. The name of the served model that logs will be retrieved for.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/logs.
- [Read Served model build logs] action
-
Endpoint URL address:
/serving-endpoints/{{=parameters.name}}/served-models/{{=parameters.served_model_name}}/build-logs
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- name: Required. The name of the serving endpoint that the served model belongs to.
- served_model_name: Required. The name of the served model that logs will be retrieved for.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/buildlogs.
- [Create] action
-
Endpoint URL address:
/serving-endpoints
.Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create.
- [Update] action
-
Endpoint URL address:
/serving-endpoints/{{=item.name}}/config
.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item.config}}
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/updateconfig.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/serving-endpoints/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/servingendpoints/delete.
The resource includes the fields from the T_serving_endpoint template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: UpdateTags, UpdateRateLimits.
-
Uses template:
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/apps/{{=parameters.app_name}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- app_name: Required. The app for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/apps/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/apps/{{=parameters.app_name}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- app_name: Required. The app for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/apps/{{=parameters.app_name}}
.
The action uses PUT method.The action has the following user-defined parameters:
- app_name: Required. The app for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/apps/{{=parameters.app_name}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- app_name: Required. The app for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/updatepermissions.
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/apps
.
The result is extracted from:{{=response.apps}}
.Documentation: https://docs.databricks.com/api/workspace/apps/list.
- [Read single] action
-
Endpoint URL address:
/apps/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/apps/get.
- [Create] action
-
Endpoint URL address:
/apps
.Documentation: https://docs.databricks.com/api/workspace/apps/create.
- [Update] action
-
Endpoint URL address:
/apps/{{=item.name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/apps/update.
- [Delete] action
-
Endpoint URL address:
/apps/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/apps/delete.
The resource includes the fields from the T_app template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: Start, Stop.
-
Uses template:
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/apps/{{=parameters.app_name}}/deployments
.
The result is extracted from:{{=response.app_deployments}}
.The action has the following user-defined parameters:
- app_name: Required. The name of the app.
Documentation: https://docs.databricks.com/api/workspace/apps/listdeployments.
- [Read single] action
-
Endpoint URL address:
/apps/{{=parameters.app_name}}/deployments/{{=parameters.id}}
.The action has the following user-defined parameters:
- app_name: Required. The name of the app.
Documentation: https://docs.databricks.com/api/workspace/apps/getdeployment.
- [Create] action
-
Endpoint URL address:
/apps/{{=item.app_name}}/deployments
.Documentation: https://docs.databricks.com/api/workspace/apps/deploy.
The resource includes the fields from the T_app_deployment template.
Based on resource template WorkspacePagination.
- [Read List] action
-
Endpoint URL address:
/vector-search/endpoints
.
The result is extracted from:{{=response.endpoints}}
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchendpoints/listendpoints.
- [Read single] action
-
Endpoint URL address:
/vector-search/endpoints/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchendpoints/getendpoint.
- [Create] action
-
Endpoint URL address:
/vector-search/endpoints
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchendpoints/createendpoint.
- [Delete] action
-
Endpoint URL address:
/vector-search/endpoints/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchendpoints/deleteendpoint.
The resource includes the fields from the T_endpoint template.
Based on resource template WorkspacePagination.
- [Read List] action
-
Endpoint URL address:
/vector-search/indexes
.
The result is extracted from:{{=response.index_name}}
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/listindexes.
- [Read single] action
-
Endpoint URL address:
/vector-search/indexes/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/getindex.
- [Read Scan] action
-
Endpoint URL address:
/vector-search/indexes/{{=parameters.index_name}}/scan
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- index_name: Required. Name of the vector index to scan.
Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/getindex.
- [Create] action
-
Endpoint URL address:
/vector-search/indexes
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex.
- [Delete] action
-
Endpoint URL address:
/vector-search/indexes/endpoints/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/deleteindex.
The resource includes the fields from the T_index template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: Synchronize, UpsertData, DeleteData.
-
Uses template:
Based on resource template Workspace.
- [Read Query] action
-
Endpoint URL address:
/vector-search/indexes/{{=parameters.index_name}}/{{=parameters.iterator ? 'query-next-page' : 'query'}}
.
The result is extracted from:{{=Databricks.extractJsonData(response.manifest.columns, response.result.data_array)}}
.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- index_name: Required. Name of the vector index to query.
- columns: Required. List of column names to include in the response.
- endpoint_name: Optional. Name of the endpoint used in pagination.
- filters_json: Optional. JSON string representing query filters
- query_vector: Optional. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.
- query_text: Optional. Query text. Required for Delta Sync Index using model endpoint.
- score_threshold: Optional. Threshold for the approximate nearest neighbor search. Defaults to 0.0.
- query_type: Optional. The query type to use. Choices are ANN and HYBRID. Defaults to ANN.
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.iterator ? { page_token: parameters.iterator, endpoint_name: parameters.get('endpoint_name') } : _.extend({ num_results: parameters.batchSize, columns: JSON.parse(parameters.columns) }, parameters ) }}
Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/queryindex.
- [External]
-
The external fields list is extracted from:
{{=_.map( JSON.parse(parameters.columns), function (col) { return { 'Name': col, 'Template': 'ShortText' }; } )}}
.
Based on resource template Workspace.
- [Read Roles] action
-
Endpoint URL address:
/preview/accounts/access-control/assignable-roles
.
The result is extracted from:{{=response.roles}}
.The action has the following user-defined parameters:
- resource: Required. The resource name for which assignable roles will be listed.
Documentation: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getassignablerolesforresource.
- [Read Rule set] action
-
Endpoint URL address:
/preview/accounts/access-control/rule-sets
.
The result is extracted from:{{=response.grant_rules}}
.The action has the following user-defined parameters:
- name: Required. The ruleset name associated with the request.
- etag: Required. Etag used for versioning. The response is at least as fresh as the eTag provided.
Documentation: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getruleset.
- [Update] action
-
Endpoint URL address:
/preview/accounts/access-control/rule-sets
.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ name: item.name, rule_set: item } }}
Documentation: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/updateruleset.
-
application/json:
The resource includes the fields from the T_account_access_control_proxy template.
Based on resource template WorkspaceSizeAndCountPagination.
- [Read List] action
-
Endpoint URL address:
/preview/scim/v2/Groups
.
The result is extracted from:{{=response.Resources}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered.
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
Documentation: https://docs.databricks.com/api/workspace/groups/list.
- [Read single] action
-
Endpoint URL address:
/preview/scim/v2/Groups/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/groups/get.
- [Create] action
-
Endpoint URL address:
/preview/scim/v2/Groups
.Documentation: https://docs.databricks.com/api/workspace/groups/create.
- [Update] action
-
Endpoint URL address:
/preview/scim/v2/Groups/{{=item.id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/groups/patch.
- [Delete] action
-
Endpoint URL address:
/preview/scim/v2/Groups/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/groups/delete.
The resource includes the fields from the T_group_principal template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/{{=parameters.request_object_type}}/{{=parameters.request_object_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- request_object_type: Required. The type of the request object.
- request_object_id: Required. The id of the request object.
Documentation: https://docs.databricks.com/api/workspace/permissions/get.
- [Read Levels] action
-
Endpoint URL address:
/permissions/{{=parameters.request_object_type}}/{{=parameters.request_object_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- request_object_type: Required. The type of the request object.
- request_object_id: Required. The id of the request object.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/{{=parameters.request_object_type}}/{{=parameters.request_object_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- request_object_type: Required. The type of the request object.
- request_object_id: Required. The id of the request object.
Documentation: https://docs.databricks.com/api/workspace/permissions/set.
- [Update] action
-
Endpoint URL address:
/permissions/{{=parameters.request_object_type}}/{{=parameters.request_object_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- request_object_type: Required. The type of the request object.
- request_object_id: Required. The id of the request object.
Documentation: https://docs.databricks.com/api/workspace/permissions/update.
Based on resource template WorkspaceSizeAndCountPagination.
- [Read List] action
-
Endpoint URL address:
/preview/scim/v2/ServicePrincipals
.
The result is extracted from:{{=response.Resources}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered.
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/list.
- [Read single] action
-
Endpoint URL address:
/preview/scim/v2/ServicePrincipals/{{=patameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/get.
- [Create] action
-
Endpoint URL address:
/preview/scim/v2/ServicePrincipals
.Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/create.
- [Update] action
-
Endpoint URL address:
/preview/scim/v2/ServicePrincipals/{{=item.id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/patch.
- [Delete] action
-
Endpoint URL address:
/preview/scim/v2/ServicePrincipals/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/delete.
The resource includes the fields from the T_service_principal template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/authorization/passwords
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/users/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/authorization/passwords/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.Documentation: https://docs.databricks.com/api/workspace/users/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/authorization/passwords
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/permissions/set.
- [Update] action
-
Endpoint URL address:
/permissions/authorization/passwords
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/permissions/update.
Based on resource template WorkspaceSizeAndCountPagination.
- [Read Me] action
-
Endpoint URL address:
/preview/scim/v2/Me
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/currentuser/me.
- [Read List] action
-
Endpoint URL address:
/preview/scim/v2/Users
.
The result is extracted from:{{=response.Resources}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered.
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
- startIndex: Optional.Specifies the index of the first result. First item is number 1.
Documentation: https://docs.databricks.com/api/workspace/users/list.
- [Read single] action
-
Endpoint URL address:
/preview/scim/v2/Users/{{=parameters.id}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered.
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
- startIndex: Optional. Specifies the index of the first result. First item is number 1.
Documentation: https://docs.databricks.com/api/workspace/users/list.
- [Create] action
-
Endpoint URL address:
/preview/scim/v2/Users
.Documentation: https://docs.databricks.com/api/workspace/users/create.
- [Update] action
-
Endpoint URL address:
/preview/scim/v2/Users/{{=item.id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/users/patch.
- [Delete] action
-
Endpoint URL address:
/preview/scim/v2/Users/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/users/delete.
The resource includes the fields from the T_user template.
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/sql/alerts
.
The result is extracted from:{{=response.results}}
.Documentation: https://docs.databricks.com/api/workspace/alerts/list.
- [Read single] action
-
Endpoint URL address:
/sql/alerts/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/alerts/get.
- [Create] action
-
Endpoint URL address:
/sql/alerts
.The following request parameters will be automatically processed:
-
application/json:
{{={ alert: item } }}
Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sql/alerts/{{=item.id}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ alert: item, update_mask: item.update_mask, id: item.id } }}
Documentation: https://docs.databricks.com/api/workspace/alerts/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sql/alerts/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/alerts/delete.
The resource includes the fields from the T_alert template.
Based on resource template WorkspacePagePagination.
- [Read List] action
-
Endpoint URL address:
/preview/sql/dashboards
.
The result is extracted from:{{=response.results}}
.The action has the following user-defined parameters:
- order: Optional. Name of dashboard attribute to order by.
- q: Optional. Full text search term.
Documentation: https://docs.databricks.com/api/workspace/dashboards/list.
- [Read single] action
-
Endpoint URL address:
/preview/sql/dashboards/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/dashboards/get.
- [Create] action
-
Endpoint URL address:
/preview/sql/dashboards
.Documentation: https://docs.databricks.com/api/workspace/dashboards/create.
- [Update] action
-
Endpoint URL address:
/preview/sql/dashboards/{{=item.id}}
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/dashboards/update.
- [Delete] action
-
Endpoint URL address:
/preview/sql/dashboards/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/dashboards/delete.
The resource includes the fields from the T_dashboard template.
- action
Field components:
- Contains the following components: Restore.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/preview/sql/permissions/{{=parameters.objectType}}/{{=parameters.objectId}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- objectId: Required. Object ID. An ACL is returned for the object with this UUID.
- objectType: Required. The type of object permissions to check.
Documentation: https://docs.databricks.com/api/workspace/dbsqlpermissions/get.
- [Create] action
-
Endpoint URL address:
/preview/sql/permissions/{{=item.objectType}}/{{=item.objectId}}
.Documentation: https://docs.databricks.com/api/workspace/dbsqlpermissions/set.
The resource includes the fields from the T_object_acl_permissions template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: Transfer.
-
Uses template:
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/sql/queries
.
The result is extracted from:{{=response.results}}
.Documentation: https://docs.databricks.com/api/workspace/queries/list.
- [Read single] action
-
Endpoint URL address:
/sql/queries/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/queries/get.
- [Create] action
-
Endpoint URL address:
/sql/queries
.The following request parameters will be automatically processed:
-
application/json:
{{={ query: item } }}
Documentation: https://docs.databricks.com/api/workspace/queries/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sql/queries/{{=item.id}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ query: _.omit(item, ['update_mask', 'id']), update_mask: item.update_mask, id: item.id } }}
Documentation: https://docs.databricks.com/api/workspace/queries/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sql/queries/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/queries/delete.
The resource includes the fields from the T_query_resource template.
Based on resource template WorkspaceMaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/sql/history/queries
.
The result is extracted from:{{=response.res}}
.Documentation: https://docs.databricks.com/api/workspace/queryhistory/list.
The resource includes the fields from the T_query_history template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/warehouses/{{=parameters.warehouse_id}}
.
The result is extracted from:{{=response.access_control_list}}
.The action has the following user-defined parameters:
- warehouse_id: Required. The SQL warehouse for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/warehouses/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/warehouses/{{=parameters.warehouse_id}}/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.The action has the following user-defined parameters:
- warehouse_id: Required. The SQL warehouse for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/warehouses/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/warehouses/{{=parameters.warehouse_id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- warehouse_id: Required. The SQL warehouse for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/warehouses/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/warehouses/{{=parameters.warehouse_id}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- warehouse_id: Required. The SQL warehouse for which to get or manage permissions.
Documentation: https://docs.databricks.com/api/workspace/warehouses/updatepermissions.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/sql/config/warehouses
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/warehouses/getworkspacewarehouseconfig.
- [Create] action
-
Endpoint URL address:
/sql/config/warehouses
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/warehouses/setworkspacewarehouseconfig.
The resource includes the fields from the T_workspace_configuration template.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/sql/warehouses
.
The result is extracted from:{{=response.warehouses}}
.The action has the following user-defined parameters:
- run_as_user_id: Optional. Service Principal which will be used to fetch the list of warehouses.
Documentation: https://docs.databricks.com/api/workspace/warehouses/list.
- [Read single] action
-
Endpoint URL address:
/sql/warehouses/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/warehouses/get.
- [Create] action
-
Endpoint URL address:
/sql/warehouses
.Documentation: https://docs.databricks.com/api/workspace/warehouses/create.
- [Update] action
-
Endpoint URL address:
/sql/warehouses/{{=item.id}}/edit
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/warehouses/edit.
- [Delete] action
-
Endpoint URL address:
/sql/warehouses/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/warehouses/delete.
The resource includes the fields from the T_warehouse template.
- action
Field components:
- Contains the following components: Start, Stop.
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/lakeview/dashboards
.
The result is extracted from:{{=response.dashboards}}
.The action has the following user-defined parameters:
- show_trashed: Optional. The flag to include dashboards located in the trash.
- view: Optional. DASHBOARD_VIEW_BASIC only includes summary metadata from the dashboard.
Documentation: https://docs.databricks.com/api/workspace/lakeview/list.
- [Read single] action
-
Endpoint URL address:
/lakeview/dashboards/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/lakeview/get.
- [Read published] action
-
Endpoint URL address:
/lakeview/dashboards/{{=parameters.id}}/published
.The action has the following user-defined parameters:
- id: Required. UUID identifying the dashboard.
Documentation: https://docs.databricks.com/api/workspace/lakeview/get.
- [Create] action
-
Endpoint URL address:
/lakeview/dashboards
.Documentation: https://docs.databricks.com/api/workspace/lakeview/create.
- [Update] action
-
Endpoint URL address:
/lakeview/dashboards/{{=item.dashboard_id}}
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/lakeview/update.
- [Delete] action
-
Endpoint URL address:
/lakeview/dashboards/{{=item.dashboard_id}}
.Documentation: https://docs.databricks.com/api/workspace/lakeview/trash.
The resource includes the fields from the T_lakeview template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: Migrate, Publish, Unpublish.
-
Uses template:
Based on resource template Workspace21.
- [Read] action
-
Endpoint URL address:
/unity-catalog/artifact-allowlists/{{=parameters.artifact_type}}
.
The result is extracted from:{{=response.artifact_matchers}}
.The action has the following user-defined parameters:
- artifact_type: Required. The artifact type of the allowlist.
Documentation: https://docs.databricks.com/api/workspace/artifactallowlists/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/artifact-allowlists/{{=parameters.artifact_type}}
.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ artifact_matchers: batch } }}
Documentation: https://docs.databricks.com/api/workspace/artifactallowlists/update.
-
application/json:
- artifact
Template: ShortText.
- match_type
Template: ShortText.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/catalogs
.
The result is extracted from:{{=response.catalogs}}
.The action has the following user-defined parameters:
- include_browse: Optional. Whether to include catalogs in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/catalogs/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/catalogs/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_browse: Optional. Whether to include catalogs in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/catalogs/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/catalogs
.Documentation: https://docs.databricks.com/api/workspace/catalogs/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/catalogs/{{=item.name}}
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/catalogs/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/catalogs/{{=item.name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/catalogs/delete.
The resource includes the fields from the T_catalog template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/connections
.
The result is extracted from:{{=response.connections}}
.Documentation: https://docs.databricks.com/api/workspace/connections/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/connections/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/connections/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/connections
.Documentation: https://docs.databricks.com/api/workspace/connections/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/connections/{{=item.name}}
.
The action uses POST method.Documentation: https://docs.databricks.com/api/workspace/connections/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/connections/{{=item.name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/connections/delete.
The resource includes the fields from the T_connection template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/external-locations
.
The result is extracted from:{{=response.external_locations}}
.The action has the following user-defined parameters:
- include_browse: Optional. Whether to include external locations in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/externallocations/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/external-locations/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_browse: Required. Whether to include external locations in the response for which the principal can only access selective metadata for
Documentation: https://docs.databricks.com/api/workspace/externallocations/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/external-locations
.Documentation: https://docs.databricks.com/api/workspace/externallocations/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/external-locations/{{=item.name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/externallocations/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/external-locations/{{=item.name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/connections/delete.
The resource includes the fields from the T_external_location template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/functions
.
The result is extracted from:{{=response.functions}}
.The action has the following user-defined parameters:
- catalog_name: Required. Name of parent catalog for functions of interest.
- schema_name: Required. Parent schema of functions.
- include_browse: Optional. Whether to include external locations in the response for which the principal can only access selective metadata for
Documentation: https://docs.databricks.com/api/workspace/functions/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/functions/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_browse: Required. Whether to include external locations in the response for which the principal can only access selective metadata for
Documentation: https://docs.databricks.com/api/workspace/functions/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/functions
.The following request parameters will be automatically processed:
-
application/json:
{{={ function_info: item } }}
Documentation: https://docs.databricks.com/api/workspace/functions/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/unity-catalog/functions/{{=item.name}}
.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{={ owner: item.owner } }}
Documentation: https://docs.databricks.com/api/workspace/functions/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/unity-catalog/functions/{{=item.name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/functions/delete.
The resource includes the fields from the T_function template.
Based on resource template Workspace21.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/permissions/{{=parameters.securable_type}}/{{=parameters.full_name}}
.
The result is extracted from:{{=response.privilege_assignments}}
.The action has the following user-defined parameters:
- securable_type: Required. Type of securable.
- full_name: Required. Full name of securable.
- principal: Optional. If provided, only the permissions for the specified principal (user or group) are returned.
Documentation: https://docs.databricks.com/api/workspace/grants/get.
- [Read List effective] action
-
Endpoint URL address:
/unity-catalog/effective-permissions/{{=parameters.securable_type}}/{{=parameters.full_name}}
.
The result is extracted from:{{=response.privilege_assignments}}
.The action has the following user-defined parameters:
- securable_type: Required. Type of securable.
- full_name: Required. Full name of securable.
- principal: Optional. If provided, only the permissions for the specified principal (user or group) are returned.
Documentation: https://docs.databricks.com/api/workspace/grants/geteffective.
- [Update] action
-
Endpoint URL address:
/unity-catalog/permissions/{{=parameters.securable_type}}/{{=parameters.full_name}}
.
The action uses PATCH method.The action has the following user-defined parameters:
- securable_type: Required. Type of securable.
- full_name: Required. Full name of securable.
The following request parameters will be automatically processed:
-
application/json:
{{={ changes: batch } }}
Documentation: https://docs.databricks.com/api/workspace/grants/update.
The resource includes the fields from the T_grant template.
Based on resource template Workspace21.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/metastores
.
The result is extracted from:{{=response.metastores}}
.Documentation: https://docs.databricks.com/api/workspace/metastores/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/metastores/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/metastores/get.
- [Read Summary] action
-
Endpoint URL address:
/unity-catalog/metastore_summary
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/metastores/summary.
- [Create] action
-
Endpoint URL address:
/unity-catalog/metastores
.Documentation: https://docs.databricks.com/api/workspace/metastores/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/metastores/{{=item.metastore_id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/metastores/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/metastores/{{=item.name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/metastores/delete.
The resource includes the fields from the T_metastore template.
Based on resource template Workspace21.
- [Read] action
-
Endpoint URL address:
/unity-catalog/current-metastore-assignment
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/metastores/current.
- [Create] action
-
Endpoint URL address:
/unity-catalog/workspaces/{{=item.workspace_id}}/metastore
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/metastores/assign.
- [Update] action
-
Endpoint URL address:
/unity-catalog/workspaces/{{=item.workspace_id}}/metastore
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/metastores/updateassignment.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/workspaces/{{=item.workspace_id}}/metastore
.The following request parameters will be automatically processed:
-
metastore_id:
{{=item.metastore_id }}
Documentation: https://docs.databricks.com/api/workspace/metastores/unassign.
-
metastore_id:
The resource includes the fields from the T_metastore_assigment template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/models/{{=parameters.full_name}}/versions
.
The result is extracted from:{{=response.model_versions}}
.The action has the following user-defined parameters:
- full_name: Required. If not specified, all webhooks associated with the specified events are listed.
- include_browse: Optional. Whether to include model versions in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/modelversions/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/models/{{=parameters.full_name}}/versions/{{=parameters.id}}
.The action has the following user-defined parameters:
- full_name: Required. If not specified, all webhooks associated with the specified events are listed.
- include_browse: Optional. Whether to include model versions in the response for which the principal can only access selective metadata for.
- include_aliases: Optional. Whether to include aliases associated with the model version in the response.
Documentation: https://docs.databricks.com/api/workspace/modelversions/get.
- [Read By alias] action
-
Endpoint URL address:
/unity-catalog/models/{{=parameters.full_name}}/versions/{{=parameters.alias}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- full_name: Required. If not specified, all webhooks associated with the specified events are listed.
- alias: Required. The name of the alias.
- include_aliases: Optional. Whether to include aliases associated with the model version in the response.
Documentation: https://docs.databricks.com/api/workspace/modelversions/getbyalias.
- [Update] action
-
Endpoint URL address:
/unity-catalog/models/{{=item.full_name}}/versions/{{=item.version}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/modelversions/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/models/{{=item.full_name}}/versions/{{=item.version}}
.Documentation: https://docs.databricks.com/api/workspace/modelversions/delete.
The resource includes the fields from the T_model_registry_version template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/online-tables
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- name: Required. Full three-part (catalog, schema, table) name of the table.
Documentation: https://docs.databricks.com/api/workspace/onlinetables/get.
- [Create] action
-
Endpoint URL address:
/online-tables
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/onlinetables/create.
- [Delete] action
-
Endpoint URL address:
/online-tables/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/onlinetables/delete.
The resource includes the fields from the T_online_table template.
Based on resource template Workspace21.
- [Read] action
-
Endpoint URL address:
/unity-catalog/tables/{{=parameters.table_name}}/monitor
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- table_name: Required. Full name of the table.
Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/tables/{{=item.table_name}}/monitor
.Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/tables/{{=item.table_name}}/monitor
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/tables/{{=item.table_name}}/monitor
.Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/delete.
The resource includes the fields from the T_quality_monitor template.
Based on resource template Workspace21.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/tables/{{=parameters.table_name}}/monitor/refreshes
.
The result is extracted from:{{=response.refreshes}}
.The action has the following user-defined parameters:
- table_name: Required. Full name of the table.
Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/listrefreshes.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/tables/{{=parameters.table_name}}/monitor/refreshes/{{=parameters.id}}
.The action has the following user-defined parameters:
- table_name: Required. Full name of the table.
Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/getrefresh.
- [Create] action
-
Endpoint URL address:
/unity-catalog/tables/{{=item.table_name}}/monitor/refreshes
.Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/runrefresh.
The resource includes the fields from the T_quality_monitor_refresh template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/models
.
The result is extracted from:{{=response.registered_models}}
.The action has the following user-defined parameters:
- catalog_name: Optional. The identifier of the catalog under which to list registered models. If specified, schema_name must be specified.
- schema_name: Optional. The identifier of the schema under which to list registered models. If specified, catalog_name must be specified.
- include_browse: Optional. Whether to include registered models in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/registeredmodels/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/models/{{=parameters.id}}
.The action has the following user-defined parameters:
- schema_name: Optional. The identifier of the schema under which to list registered models. If specified, catalog_name must be specified.
- include_browse: Optional. Whether to include registered models in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/registeredmodels/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/models
.Documentation: https://docs.databricks.com/api/workspace/registeredmodels/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/models/{{=item.full_name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/registeredmodels/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/models/{{=item.full_name}}
.Documentation: https://docs.databricks.com/api/workspace/registeredmodels/delete.
The resource includes the fields from the T_registered_model template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: SetAlias, DeleteAlias.
-
Uses template:
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/resource-quotas/all-resource-quotas
.
The result is extracted from:{{=response.quotas}}
.Documentation: https://docs.databricks.com/api/workspace/resourcequotas/listquotas.
- [Read] action
-
Endpoint URL address:
/unity-catalog/resource-quotas/{{=parameters.parent_securable_type}}/{{=parameters.parent_full_name}}/{{=parameters.quota_name}}
.
The result is extracted from:{{=[response.quota_info]}}
.The action has the following user-defined parameters:
- parent_securable_type: Required. Securable type of the quota parent.
- parent_full_name: Required. Full name of the parent resource. Provide the metastore ID if the parent is a metastore.
- quota_name: Required. Name of the quota. Follows the pattern of the quota type, with "-quota" added as a suffix.
Documentation: https://docs.databricks.com/api/workspace/resourcequotas/getquota.
The resource includes the fields from the T_resource_quotas template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/schemas
.
The result is extracted from:{{=response.schemas}}
.The action has the following user-defined parameters:
- catalog_name: Required. Parent catalog for schemas of interest.
- include_browse: Optional. Whether to include schemas in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/schemas/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/schemas/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_browse: Optional. Whether to include schemas in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/schemas/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/schemas
.Documentation: https://docs.databricks.com/api/workspace/schemas/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/schemas/{{=item.full_name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/schemas/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/schemas/{{=item.full_name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/schemas/delete.
The resource includes the fields from the T_schema template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/storage-credentials
.
The result is extracted from:{{=response.storage_credentials}}
.Documentation: https://docs.databricks.com/api/workspace/storagecredentials/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/storage-credentials/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/storagecredentials/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/storage-credentials
.Documentation: https://docs.databricks.com/api/workspace/storagecredentials/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/storage-credentials/{{=item.full_name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/storagecredentials/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/storage-credentials/{{=item.full_name}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the function is notempty.
Documentation: https://docs.databricks.com/api/workspace/storagecredentials/delete.
The resource includes the fields from the T_storage_credentials template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/metastores/{{=parameters.metastore_id}}/systemschemas
.
The result is extracted from:{{=response.schemas}}
.The action has the following user-defined parameters:
- metastore_id: Required. The ID for the metastore in which the system schema resides.
Documentation: https://docs.databricks.com/api/workspace/systemschemas/list.
- [Create] action
-
Endpoint URL address:
/unity-catalog/metastores/{{=item.metastore_id}}/systemschemas/{{=item.schema_name}}
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/systemschemas/enable.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/metastores/{{=item.metastore_id}}/systemschemas/{{=item.schema}}
.Documentation: https://docs.databricks.com/api/workspace/systemschemas/disable.
The resource includes the fields from the T_system_schema template.
Based on resource template Workspace21.
- [Create] action
-
Endpoint URL address:
/unity-catalog/constraints
.Documentation: https://docs.databricks.com/api/workspace/tableconstraints/create.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/constraints/{{=item.full_name}}
.The action has the following user-defined parameters:
- cascade: Required. If true, try deleting all child constraints of the current constraint.
The following request parameters will be automatically processed:
-
constraint_name:
{{=item.constraint_name }}
Documentation: https://docs.databricks.com/api/workspace/tableconstraints/delete.
The resource includes the fields from the T_table_constraint template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/tables
.
The result is extracted from:{{=response.tables}}
.The action has the following user-defined parameters:
- catalog_name: Required. Name of parent catalog for tables of interest.
- schema_name: Required. Parent schema of tables.
- include_browse: Optional. Whether to include tables in the response for which the principal can only access selective metadata for.
- include_manifest_capabilities: Optional. Whether to include a manifest containing capabilities the table has.
Documentation: https://docs.databricks.com/api/workspace/tables/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/tables/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_delta_metadata: Optional. Whether delta metadata should be included in the response.
- include_browse: Optional. Whether to include tables in the response for which the principal can only access selective metadata for.
- include_manifest_capabilities: Optional. Whether to include a manifest containing capabilities the table has.
Documentation: https://docs.databricks.com/api/workspace/tables/get.
- [Read Exists] action
-
Endpoint URL address:
/unity-catalog/tables/{{=parameters.full_name}}/exists
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- full_name: Required. Full name of the table.
Documentation: https://docs.databricks.com/api/workspace/tables/exists.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/tables/{{=item.full_name}}
.Documentation: https://docs.databricks.com/api/workspace/tables/delete.
The resource includes the fields from the T_table template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/volumes
.
The result is extracted from:{{=response.volumes}}
.The action has the following user-defined parameters:
- catalog_name: Required. The identifier of the catalog.
- schema_name: Required. The identifier of the schema.
- include_browse: Optional. Whether to include tables in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/volumes/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/volumes/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_browse: Optional. Whether to include tables in the response for which the principal can only access selective metadata for.
Documentation: https://docs.databricks.com/api/workspace/volumes/read.
- [Create] action
-
Endpoint URL address:
/unity-catalog/volumes
.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ name: item.name }, item)}}
Documentation: https://docs.databricks.com/api/workspace/volumes/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/unity-catalog/volumes/{{=item.name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/volumes/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/volumes/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/volumes/delete.
The resource includes the fields from the T_volume template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/bindings/{{=parameters.securable_type}}/{{=parameters.securable_name}}
.
The result is extracted from:{{=response.bindings}}
.The action has the following user-defined parameters:
- securable_type: Required. The type of the securable to bind to a workspace.
- securable_name: Required. The name of the securable.
Documentation: https://docs.databricks.com/api/workspace/workspacebindings/getbindings.
- [Read Catalog] action
-
Endpoint URL address:
/unity-catalog/workspace-bindings/catalogs/{{=parameters.name}}
.
The result is extracted from:{{=_.map( response.workspaces, function(element) { return { 'workspace_id' : element }; } )}}
.The action has the following user-defined parameters:
- name: Required. Name of the storage credential.
Documentation: https://docs.databricks.com/api/workspace/workspacebindings/get.
- [Update] action
-
Endpoint URL address:
/
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/workspacebindings.
- workspace_id
Template: ShortText. A read-only field.
- binding_type
Template: ShortText. A read-only field.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: UpdateCatalog, UpdateSecurable.
-
Uses template:
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/providers
.
The result is extracted from:{{=response.providers}}
.The action has the following user-defined parameters:
- data_provider_global_metastore_id: Optional. If not provided, all providers will be returned..
Documentation: https://docs.databricks.com/api/workspace/providers/list.
- [Read Shares] action
-
Endpoint URL address:
/unity-catalog/{{=parameters.name}}/shares
.
The result is extracted from:{{=response.shares}}
.
The result is paginated.The action has the following user-defined parameters:
- name: Required. Name of the provider in which to list shares.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
max_results:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/providers/listshares.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/providers/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/providers/get.
- [Create] action
-
Endpoint URL address:
/unity-catalog/providers
.Documentation: https://docs.databricks.com/api/workspace/providers/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/providers/{{=item.name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/providers/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/providers/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/providers/delete.
The resource includes the fields from the T_data_sharing_provider template.
Based on resource template Workspace21.
- [Read Access token] action
-
Endpoint URL address:
/unity-catalog/public/data_sharing_activation/{{=parameters.activation_url}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- activation_url: Required. The one time activation url. It also accepts activation token.
Documentation: https://docs.databricks.com/api/workspace/recipientactivation/retrievetoken.
- [Read Share activation URL] action
-
Endpoint URL address:
/unity-catalog/public/data_sharing_activation_info/{{=parameters.activation_url}}
.The action has the following user-defined parameters:
- activation_url: Required. The one time activation url. It also accepts activation token.
Documentation: https://docs.databricks.com/api/workspace/recipientactivation/getactivationurlinfo.
The resource includes the fields from the T_recipient_activation template.
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/recipients
.
The result is extracted from:{{=response.recipients}}
.The action has the following user-defined parameters:
- data_recipient_global_metastore_id: Required. If not provided, all recipients will be returned. If no recipients exist with this ID, no results will be returned.
Documentation: https://docs.databricks.com/api/workspace/recipients/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/recipients/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/recipients/get.
- [Read Permissions] action
-
Endpoint URL address:
/unity-catalog/recipients/{{=parameter.name}}/share-permissions
.
The result is extracted from:{{=response.permissions_out}}
.
The result is paginated.The action has the following user-defined parameters:
- name: Required. Name of the recipient.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
max_results:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/recipients/sharepermissions.
- [Create] action
-
Endpoint URL address:
/unity-catalog/recipients
.Documentation: https://docs.databricks.com/api/workspace/recipients/create.
- [Update] action
-
Endpoint URL address:
/unity-catalog/recipients/{{=item.name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/recipients/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/recipients/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/recipients/delete.
The resource includes the fields from the T_recipient template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: RotateToken.
-
Uses template:
Based on resource template Workspace21MaxResultsPagination.
- [Read List] action
-
Endpoint URL address:
/unity-catalog/shares
.
The result is extracted from:{{=response.shares}}
.Documentation: https://docs.databricks.com/api/workspace/shares/list.
- [Read single] action
-
Endpoint URL address:
/unity-catalog/shares/{{=parameters.id}}
.The action has the following user-defined parameters:
- include_shared_data: Optional. Query for data to include in the share.
Documentation: https://docs.databricks.com/api/workspace/recipients/get.
- [Read Permissions] action
-
Endpoint URL address:
/unity-catalog/shares/{{=parameters.name}}/permissions
.
The result is extracted from:{{=response.privilege_assignments}}
.The action has the following user-defined parameters:
- name: Required. The name of the share.
Documentation: https://docs.databricks.com/api/workspace/shares/sharepermissions.
- [Create] action
-
Endpoint URL address:
/unity-catalog/shares
.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ name: item.name }, item)}}
Documentation: https://docs.databricks.com/api/workspace/shares/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/unity-catalog/shares/{{=item.name}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/shares/update.
- [Delete] action
-
Endpoint URL address:
/unity-catalog/shares/{{=item.name}}
.Documentation: https://docs.databricks.com/api/workspace/shares/delete.
The resource includes the fields from the T_shares template.
- action
Field components:
- Contains the following components: UpdatePermissions.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/settings/types/automatic_cluster_update/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Etag used for versioning.
Documentation: https://docs.databricks.com/api/workspace/automaticclusterupdate/get.
- [Update] action
-
Endpoint URL address:
/settings/types/automatic_cluster_update/names/default
.
The action uses PATCH method.The action has the following user-defined parameters:
- allow_missing: Required. This should always be set to true for Settings API.
The following request parameters will be automatically processed:
-
application/json:
{{={ allow_missing: parameters.allow_missing, setting: { etag: item.etag, setting_name: item.setting_name, automatic_cluster_update_workspace: item.automatic_cluster_update_workspace }, field_mask: item.field_mask } }}
Documentation: https://docs.databricks.com/api/workspace/automaticclusterupdate/update.
The resource includes the fields from the T_setting_automatic_cluster template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/settings/types/shield_csp_enablement_ws_db/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Etag used for versioning.
Documentation: https://docs.databricks.com/api/workspace/compliancesecurityprofile/get.
- [Update] action
-
Endpoint URL address:
/settings/types/shield_csp_enablement_ws_db/names/default
.
The action uses PATCH method.The action has the following user-defined parameters:
- allow_missing: Required. This should always be set to true for Settings API.
The following request parameters will be automatically processed:
-
application/json:
{{={ allow_missing: parameters.allow_missing, setting: { etag: item.etag, setting_name: item.setting_name, compliance_security_profile_workspace: item.compliance_security_profile_workspace }, field_mask: item.field_mask } }}
Documentation: https://docs.databricks.com/api/workspace/compliancesecurityprofile/update.
The resource includes the fields from the T_setting_compliance_security_profile template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/settings/types/default_namespace_ws/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Etag used for versioning.
Documentation: https://docs.databricks.com/api/workspace/defaultnamespace/get.
- [Update] action
-
Endpoint URL address:
/settings/types/default_namespace_ws/names/default
.
The action uses PATCH method.The action has the following user-defined parameters:
- allow_missing: Required. This should always be set to true for Settings API.
The following request parameters will be automatically processed:
-
application/json:
{{={ allow_missing: parameters.allow_missing, setting: { etag: item.etag, setting_name: item.setting_name, namespace: item.namespace }, field_mask: item.field_mask } }}
Documentation: https://docs.databricks.com/api/workspace/defaultnamespace/update.
- [Delete] action
-
Endpoint URL address:
/settings/types/default_namespace_ws/names/default
.The following request parameters will be automatically processed:
-
etag:
{{=item.etag}}
Documentation: https://docs.databricks.com/api/workspace/defaultnamespace/delete.
-
etag:
The resource includes the fields from the T_settings_default_namespace template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/settings/types/shield_esm_enablement_ws_db/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Etag used for versioning.
Documentation: https://docs.databricks.com/api/workspace/enhancedsecuritymonitoring/get.
- [Update] action
-
Endpoint URL address:
/settings/types/automatic_cluster_update/names/default
.
The action uses PATCH method.The action has the following user-defined parameters:
- allow_missing: Required. This should always be set to true for Settings API.
The following request parameters will be automatically processed:
-
application/json:
{{={ allow_missing: parameters.allow_missing, setting: { etag: item.etag, setting_name: item.setting_name, enhanced_security_monitoring_workspace: item.enhanced_security_monitoring_workspace }, field_mask: item.field_mask } }}
Documentation: https://docs.databricks.com/api/workspace/defaultnamespace/update.
The resource includes the fields from the T_setting_enchanced_security_monitoring template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/settings/types/restrict_workspace_admins/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Etag used for versioning.
Documentation: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/get.
- [Update] action
-
Endpoint URL address:
/settings/types/restrict_workspace_admins/names/default
.
The action uses PATCH method.The action has the following user-defined parameters:
- allow_missing: Required. This should always be set to true for Settings API.
The following request parameters will be automatically processed:
-
application/json:
{{={ allow_missing: parameters.allow_missing, setting: { etag: item.etag, setting_name: item.setting_name, restrict_workspace_admins: item.restrict_workspace_admins }, field_mask: item.field_mask } }}
Documentation: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/update.
- [Delete] action
-
Endpoint URL address:
/settings/types/restrict_workspace_admins/names/default
.The following request parameters will be automatically processed:
-
etag:
{{=item.etag}}
Documentation: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/delete.
-
etag:
The resource includes the fields from the T_setting_restrict_workspace_admins template.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/ip-access-lists
.
The result is extracted from:{{=response.ip_access_lists}}
.Documentation: https://docs.databricks.com/api/workspace/ipaccesslists/list.
- [Read single] action
-
Endpoint URL address:
/ip-access-lists/{{=parameters.id}}
.
The result is extracted from:{{=[response.ip_access_list]}}
.Documentation: https://docs.databricks.com/api/workspace/ipaccesslists/get.
- [Create] action
-
Endpoint URL address:
/ip-access-lists
.Documentation: https://docs.databricks.com/api/workspace/ipaccesslists/create.
- [Update] action
-
Endpoint URL address:
/ip-access-lists/{{=item.list_id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/ipaccesslists/update.
- [Delete] action
-
Endpoint URL address:
/ip-access-lists/{{=item.list_id}}
.Documentation: https://docs.databricks.com/api/workspace/ipaccesslists/delete.
The resource includes the fields from the T_ip_access_list template.
Based on resource template WorkspacePagePagination.
- [Read List] action
-
Endpoint URL address:
/notification-destinations
.
The result is extracted from:{{=response.results}}
.Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/list.
- [Read single] action
-
Endpoint URL address:
/notification-destinations/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/get.
- [Create] action
-
Endpoint URL address:
/notification-destinations
.Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/create.
- [Update] action
-
Endpoint URL address:
/notification-destinations/{{=item.id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/update.
- [Delete] action
-
Endpoint URL address:
/notification-destinations/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/delete.
The resource includes the fields from the T_notification_destination template.
Based on resource template Permissions.
- [Read] action
-
Endpoint URL address:
/permissions/authorization/tokens
.
The result is extracted from:{{=response.access_control_list}}
.Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/getpermissions.
- [Read Levels] action
-
Endpoint URL address:
/permissions/authorization/tokens/permissionLevels
.
The result is extracted from:{{=response.permission_levels}}
.Documentation: https://docs.databricks.com/api/workspace/warehouses/getpermissionlevels.
- [Create] action
-
Endpoint URL address:
/permissions/authorization/tokens
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/setpermissions.
- [Update] action
-
Endpoint URL address:
/permissions/authorization/tokens
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/updatepermissions.
Based on resource template Workspace.
- [Read List] action
-
Endpoint URL address:
/token-management/tokens
.
The result is extracted from:{{=response.token_infos}}
.The action has the following user-defined parameters:
- created_by_id: Optional. User ID of the user that created the token.
- created_by_username: Optional. Username of the user that created the token.
Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/list.
- [Read single] action
-
Endpoint URL address:
/token-management/tokens/{{=parameters.id}}
.
The result is extracted from:{{=[response.token_info]}}
.Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/get.
- [Create] action
-
Endpoint URL address:
/token-management/on-behalf-of/tokens
.Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/createobotoken.
- [Delete] action
-
Endpoint URL address:
/token-management/tokens/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/delete.
The resource includes the fields from the T_token_management template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/token/list
.
The result is extracted from:{{=response.token_infos}}
.Documentation: https://docs.databricks.com/api/workspace/tokens/listtokens.
- [Create] action
-
Endpoint URL address:
/token/create
.Documentation: https://docs.databricks.com/api/workspace/tokens/create.
- [Delete] action
-
Endpoint URL address:
/token/delete
.Documentation: https://docs.databricks.com/api/workspace/tokens/revoketoken.
The resource includes the fields from the T_token template.
Based on resource template Workspace21SizePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=parameters.listing_id}}/fulfillments
.
The result is extracted from:{{=response.fulfillments}}
.The action has the following user-defined parameters:
- listing_id: Required. The listing UUID.
Documentation: https://docs.databricks.com/api/workspace/consumerfulfillments/list.
- [Read Content metadata] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=parameters.listing_id}}/content
.
The result is extracted from:{{=response.shared_data_objects}}
.
The result is paginated.The action has the following user-defined parameters:
- listing_id: Required. The listing UUID.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/consumerfulfillments/get.
The resource includes the fields from the T_consumer_fulfillment template.
Based on resource template Workspace21SizePagination.
- [Read] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=parameters.listing_id}}/installations
.
The result is extracted from:{{=response.installations}}
.
The result is paginated.The action has the following user-defined parameters:
- listing_id: Required. The listing UUID.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/listlistinginstallations.
- [Read List] action
-
Endpoint URL address:
/marketplace-consumer/installations
.
The result is extracted from:{{=response.installations}}
.Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/list.
- [Create] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=item.listing_id}}/installations
.Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/create.
- [Update] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=item.listing_id}}/installations/{{=item.id}}
.
The action uses PUT method.The action has the following user-defined parameters:
- rotate_token: Optional. The token will be rotated if the rotateToken flag is true.
The following request parameters will be automatically processed:
-
application/json:
{{={ rotate_token: parameters.rotate_token, installation: item } }}
Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/update.
- [Delete] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=item.listing_id}}/installations/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/delete.
The resource includes the fields from the T_consumer_installation template.
Based on resource template Workspace21SizePaginationAndSearch.
- [Read List] action
-
Endpoint URL address:
/marketplace-consumer/listings
.
The result is extracted from:{{=response.listings}}
.The action has the following user-defined parameters:
- assets: Optional. Matches any of the following asset types.
- categories: Optional. Matches any of the following categories.
- tags: Optional. Matches any of the following tags.
- is_free: Optional. Filters each listing based on if it is free.
- is_private_exchange: Optional. Filters each listing based on if it is a private exchange.
- is_staff_pick: Optional. Filters each listing based on whether it is a staff pick.
- provider_ids: Optional. Matches any of the following provider ids.
Documentation: https://docs.databricks.com/api/workspace/consumerlistings/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=parameters.id}}
.
The result is extracted from:{{=[response.listing]}}
.Documentation: https://docs.databricks.com/api/workspace/consumerlistings/get.
- [Read Search] action
-
Endpoint URL address:
/marketplace-consumer/search-listings
.
The result is extracted from:{{=response.listings}}
.The action has the following user-defined parameters:
- query: Required. Fuzzy matches query.
- assets: Optional. Matches any of the following asset types.
- categories: Optional. Matches any of the following categories.
- tags: Optional. Matches any of the following tags.
- is_free: Optional. Filters each listing based on if it is free.
- is_private_exchange: Optional. Filters each listing based on if it is a private exchange.
- provider_ids: Optional. Matches any of the following provider ids.
Documentation: https://docs.databricks.com/api/workspace/consumerlistings/search.
The resource includes the fields from the T_provider_consumer_listings template.
Based on resource template Workspace21SizePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-consumer/personalization-requests
.
The result is extracted from:{{=response.personalization_requests}}
.Documentation: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=parameters.id}}/personalization-requests
.
The result is extracted from:{{=response.personalization_requests}}
.Documentation: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/get.
- [Create] action
-
Endpoint URL address:
/marketplace-consumer/listings/{{=parameters.listing_id}}/personalization-requests
.Documentation: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/create.
The resource includes the fields from the T_consumer_personalization_request template.
Based on resource template Workspace21SizePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-consumer/providers
.
The result is extracted from:{{=response.providers}}
.The action has the following user-defined parameters:
- is_featured: Required. Accessible by consumers only.
Documentation: https://docs.databricks.com/api/workspace/consumerproviders/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-consumer/providers/{{=parameters.id}}
.
The result is extracted from:{{=[response.provider]}}
.Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/list.
The resource includes the fields from the T_consumer_provider template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/marketplace-consumer/filters
.
The result is extracted from:{{=response.filters}}
.
The result is paginated.The action has the following user-defined parameters:
- exchange_id: Required. The exchange UUID.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/providerexchangefilters/list.
- [Create] action
-
Endpoint URL address:
/marketplace-exchange/filters
.The following request parameters will be automatically processed:
-
application/json:
{{={ filter: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerexchangefilters/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/marketplace-exchange/filters/{{=item.id}}
.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ filter: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerexchangefilters/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/marketplace-exchange/filters/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/providerexchangefilters/delete.
The resource includes the fields from the T_provider_exchange_filters template.
Based on resource template WorkspacePagePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-exchange/exchanges
.
The result is extracted from:{{=response.exchanges}}
.Documentation: https://docs.databricks.com/api/workspace/providerexchanges/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-exchange/exchanges/{{=parameters.id}}
.
The result is extracted from:{{=[response.exchange]}}
.Documentation: https://docs.databricks.com/api/workspace/providerexchanges/get.
- [Create] action
-
Endpoint URL address:
/marketplace-exchange/exchanges
.The following request parameters will be automatically processed:
-
application/json:
{{={ exchange: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerexchanges/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/marketplace-exchange/exchanges/{{=item.id}}
.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ exchange: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerexchanges/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/marketplace-exchange/exchanges/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/providerexchanges/delete.
The resource includes the fields from the T_provider_exchange template.
Based on resource template Workspace.
- [Read List exchanges] action
-
Endpoint URL address:
/marketplace-exchange/exchanges-for-listing
.
The result is extracted from:{{=response.exchange_listing}}
.
The result is paginated.The action has the following user-defined parameters:
- listing_id: Required. The listing UUID.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/providerexchanges/listexchangesforlisting.
- [Read List listings] action
-
Endpoint URL address:
/marketplace-exchange/listings-for-exchange
.
The result is extracted from:{{=response.exchange_listings}}
.
The result is paginated.The action has the following user-defined parameters:
- exchange_id: Required. The exchange UUID.
The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/workspace/providerexchanges/listlistingsforexchange.
- [Create] action
-
Endpoint URL address:
/marketplace-exchange/exchanges-for-listing
.Documentation: https://docs.databricks.com/api/workspace/providerexchanges/addlistingtoexchange.
- [Delete] action
-
Endpoint URL address:
/marketplace-exchange/exchanges-for-listing/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/providerexchanges/deletelistingfromexchange.
The resource includes the fields from the T_provider_exchange_for_listing template.
Based on resource template WorkspacePagePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-provider/files
.
The result is extracted from:{{=response.file_infos}}
.The action has the following user-defined parameters:
- file_parent: Required. The parent of the file.
Documentation: https://docs.databricks.com/api/workspace/providerfiles/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-provider/files/{{=parameters.id}}
.
The result is extracted from:{{=[response.file_info]}}
.Documentation: https://docs.databricks.com/api/workspace/providerfiles/get.
- [Create] action
-
Endpoint URL address:
/marketplace-provider/files
.Documentation: https://docs.databricks.com/api/workspace/providerfiles/create.
- [Delete] action
-
Endpoint URL address:
/marketplace-provider/files/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/providerfiles/delete.
The resource includes the fields from the T_provider_file template.
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-provider/listings
.
The result is extracted from:{{=response.listings}}
.Documentation: https://docs.databricks.com/api/workspace/providerlistings/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-provider/listings/{{=parameters.id}}
.
The result is extracted from:{{=[response.listing]}}
.Documentation: https://docs.databricks.com/api/workspace/providerlistings/get.
- [Create] action
-
Endpoint URL address:
/marketplace-provider/listing
.The following request parameters will be automatically processed:
-
application/json:
{{={ listing: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerlistings/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/marketplace-provider/listing/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ listing: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerlistings/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/marketplace-provider/listings{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/providerlistings/delete.
The resource includes the fields from the T_provider_consumer_listings template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/marketplace-provider/personalization-requests
.
The result is extracted from:{{=response.personalization_requests}}
.Documentation: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/list.
- [Update] action
-
Endpoint URL address:
/marketplace-provider/listings/{{=item.listing_id}}/personalization-requests/{{=item.id}}/request-status
.Documentation: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/update.
The resource includes the fields from the T_provider_personalization_request template.
Based on resource template Workspace.
- [Read] action
-
Endpoint URL address:
/marketplace-provider/analytics_dashboard
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/get.
- [Read latest] action
-
Endpoint URL address:
/marketplace-provider/analytics_dashboard/latest
.
The result is extracted from:{{=[response]}}
.Documentation: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/getlatestversion.
- [Create] action
-
Endpoint URL address:
/marketplace-provider/analytics_dashboard
.Documentation: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/create.
- [Update] action
-
Endpoint URL address:
/marketplace-provider/analytics_dashboard/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ version: item.version } }}
Documentation: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/update.
-
application/json:
The resource includes the fields from the T_provider_analytics_dashboard template.
Based on resource template WorkspaceSizePagination.
- [Read List] action
-
Endpoint URL address:
/marketplace-provider/providers
.
The result is extracted from:{{=response.providers}}
.Documentation: https://docs.databricks.com/api/workspace/providerproviders/list.
- [Read single] action
-
Endpoint URL address:
/marketplace-provider/providers/{{=parameters.id}}
.
The result is extracted from:{{=[response.provider]}}
.Documentation: https://docs.databricks.com/api/workspace/providerproviders/get.
- [Create] action
-
Endpoint URL address:
/marketplace-provider/provider
.The following request parameters will be automatically processed:
-
application/json:
{{={ provider: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerproviders/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/marketplace-provider/providers/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ provider: item } }}
Documentation: https://docs.databricks.com/api/workspace/providerproviders/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/marketplace-provider/providers/{{=item.id}}
.Documentation: https://docs.databricks.com/api/workspace/providerproviders/delete.
The resource includes the fields from the T_marketplace_provider template.
Based on resource template Workspace.
- [Read] action
-
The result is extracted from:{{=Databricks.executeStatement(parameters)}}
.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- statement: Required. The SQL statement to execute. The statement can optionally be parameterized, see parameters.
- warehouse_id: Required. Warehouse upon which to execute a statement.
- disposition: Required. The fetch disposition provides two modes of fetching results: INLINE and EXTERNAL_LINKS.
- catalog: Optional. Sets default catalog for statement execution, similar to USE CATALOG in SQL.
- schema: Optional. Sets default schema for statement execution, similar to USE SCHEMA in SQL.
- parameters: Optional. A list of parameters to pass into a SQL statement containing parameter markers.
- row_limit: Optional. Applies the given row limit to the statement's result set, but unlike the LIMIT clause in SQL, it also sets the truncated field in the response to indicate whether the result was trimmed due to the limit or not.
- byte_limit: Optional. Applies the given byte limit to the statement's result size.
- wait_timeout: Optional. The time in seconds the call will wait for the statement's result set as Ns, where N can be set to 0 or to a value between 5 and 50.
- on_wait_timeout: Optional. When wait_timeout > 0s, the call will block up to the specified time. If the statement execution doesn't finish within this time, on_wait_timeout determines whether the execution should continue or be canceled.
Documentation: https://docs.databricks.com/api/gcp/workspace/statementexecution/executestatement.
- [External]
-
The external fields list is extracted from:
{{=Databricks.getStatementColumns(parameters)}}
.
Based on resource template AccountWithPreviewUrl.
- [Read List] action
-
Endpoint URL address:
/{{=connection.user.account_id}}/access-control/assignable-roles
.
The result is extracted from:{{=response.roles}}
.The action has the following user-defined parameters:
- resource: Required. The resource name for which assignable roles will be listed.
Documentation: https://docs.databricks.com/api/account/accountaccesscontrol/getassignablerolesforresource.
- [Read Rule set] action
-
Endpoint URL address:
/{{=connection.user.account_id}}/access-control/rule-sets
.
The result is extracted from:{{=response.grant_rules}}
.The action has the following user-defined parameters:
- name: Required. The ruleset name associated with the request.
- etag: Required. Etag used for versioning. The response is at least as fresh as the eTag provided. Can be empty.
Documentation: https://docs.databricks.com/api/account/accountaccesscontrol/getruleset.
- [Update] action
-
Endpoint URL address:
/{{=connection.user.account_id}}/access-control/rule-sets
.The following request parameters will be automatically processed:
-
application/json:
{{={ name: item.name, rule_set: item } }}
Documentation: https://docs.databricks.com/api/account/accountaccesscontrol/updateruleset.
-
application/json:
- name
Template: ShortText.
- grant_rules
Field components:
- An array.
- Contains the following components: principals, role.
- etag
Template: ShortText.
Based on resource template AccountPaginated.
- [Read List] action
-
Endpoint URL address:
/scim/v2/Groups
.
The result is extracted from:{{=response.Resources}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered. Supported operators are equals(eq), contains(co), starts with(sw) and not equals(ne).
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
Documentation: https://docs.databricks.com/api/account/accountgroups/list.
- [Read single] action
-
Endpoint URL address:
/scim/v2/Groups/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/accountgroups/get.
- [Create] action
-
Endpoint URL address:
/scim/v2/Groups
.Documentation: https://docs.databricks.com/api/account/accountgroups/create.
- [Update] action
-
Endpoint URL address:
/scim/v2/Groups/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/accountgroups/update.
- [Delete] action
-
Endpoint URL address:
/scim/v2/Groups/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/accountgroups/delete.
- id
Template: ShortText.
- displayName
Template: ShortText.
- members
Template: T_group_obj_array.
- roles
Template: T_group_obj_array.
- externalId
Template: ShortText.
Based on resource template AccountPaginated.
- [Read List] action
-
Endpoint URL address:
/scim/v2/ServicePrincipals
.
The result is extracted from:{{=response.Resources}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered. Supported operators are equals(eq), contains(co), starts with(sw) and not equals(ne).
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
Documentation: https://docs.databricks.com/api/account/accountserviceprincipals/list.
- [Read single] action
-
Endpoint URL address:
/scim/v2/ServicePrincipals/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/accountserviceprincipals/get.
- [Create] action
-
Endpoint URL address:
/scim/v2/ServicePrincipals
.Documentation: https://docs.databricks.com/api/account/accountserviceprincipals/create.
- [Update] action
-
Endpoint URL address:
/scim/v2/ServicePrincipals/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/accountserviceprincipals/update.
- [Delete] action
-
Endpoint URL address:
/scim/v2/ServicePrincipals/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/accountserviceprincipals/delete.
- id
Template: ShortText.
- applicationId
Template: ShortText.
- displayName
Template: ShortText.
- roles
Template: T_group_obj_array.
- externalId
Template: ShortText.
- active
Template: ShortText.
Based on resource template AccountPaginated.
- [Read List] action
-
Endpoint URL address:
/scim/v2/Users
.
The result is extracted from:{{=response.Resources}}
.The action has the following user-defined parameters:
- filter: Optional. Query by which the results have to be filtered. Supported operators are equals(eq), contains(co), starts with(sw) and not equals(ne).
- attributes: Optional. Comma-separated list of attributes to return in response.
- excludedAttributes: Optional. Comma-separated list of attributes to exclude in response.
- sortBy: Optional. Attribute to sort the results.
- sortOrder: Optional. The order to sort the results.
Documentation: https://docs.databricks.com/api/account/accountusers/list.
- [Read single] action
-
Endpoint URL address:
/scim/v2/Users/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/accountusers/get.
- [Create] action
-
Endpoint URL address:
/scim/v2/Users
.Documentation: https://docs.databricks.com/api/account/accountusers/create.
- [Update] action
-
Endpoint URL address:
/scim/v2/Users/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/accountusers/update.
- [Delete] action
-
Endpoint URL address:
/scim/v2/Users/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/accountusers/delete.
- id
Template: ShortText.
- userName
Template: ShortText.
- emails
Template: T_group_obj_array.
- name
Field components:
-
Uses template:
ShortText
. - Contains the following components: givenName, familyName.
-
Uses template:
- displayName
Template: ShortText.
- roles
Template: T_group_obj_array.
- externalId
Template: ShortText.
- active
Data type: DT_BOOL
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/workspaces/{{=parameters.workspace_id}}/permissionassignments
.
The result is extracted from:{{=response.permission_assignments}}
.The action has the following user-defined parameters:
- workspace_id: Required. The workspace ID for the account.
Documentation: https://docs.databricks.com/api/account/workspaceassignment/list.
- [Read Permissions] action
-
Endpoint URL address:
/workspaces/{{=parameters.workspace_id}}/permissionassignments/permissions
.
The result is extracted from:{{=response.permissions}}
.The action has the following user-defined parameters:
- workspace_id: Required. The workspace ID for the account.
Documentation: https://docs.databricks.com/api/account/workspaceassignment/get.
- [Upsert] action
-
Endpoint URL address:
/api/2.0/workspaces/{{=item.workspace_id}}/permissionassignments/principals/{{=item.principal_id}}
.
The action uses PUT method.Documentation: https://docs.databricks.com/api/account/workspaceassignment/update.
- [Delete] action
-
Endpoint URL address:
/workspaces/{{=item.workspace_id}}/permissionassignments/principals/{{=item.principal_id}}
.Documentation: https://docs.databricks.com/api/account/workspaceassignment/delete.
- workspace_id
A key field. Template: ShortText.
- principal_id
A key field. Template: ShortText.
- principal
A read-only field. Field components:
-
Uses template:
ShortText
. - Contains the following components: user_name, group_name, service_principal_name, principal_id, display_name.
-
Uses template:
- permissions
Template: LongText. A composite field.
- permission_level
Template: ShortText. A read-only field.
- description
Template: ShortText. A read-only field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/metastores/{{=parameters.metastore_id}}/workspaces
.
The result is extracted from:{{=_.map(response.workspace_ids, function(item) { return {'workspace_id': item} }) }}
.The action has the following user-defined parameters:
- metastore_id: Required. Unity Catalog metastore ID.
Documentation: https://docs.databricks.com/api/account/accountmetastoreassignments/list.
- [Read For a workspace] action
-
Endpoint URL address:
/workspaces/{{=parameters.workspace_id}}/metastore
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- workspace_id: Required. Workspace ID.
Documentation: https://docs.databricks.com/api/account/accountmetastoreassignments/get.
- [Create] action
-
Endpoint URL address:
/workspaces/{{=item.workspace_id}}/metastores/{{=item.metastore_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ metastore_assignment: item } }}
Documentation: https://docs.databricks.com/api/account/accountmetastoreassignments/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/workspaces/{{=item.workspace_id}}/metastores/{{=item.metastore_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ metastore_assignment: item } }}
Documentation: https://docs.databricks.com/api/account/accountmetastoreassignments/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/workspaces/{{=item.workspace_id}}/metastores/{{=item.metastore_id}}
.Documentation: https://docs.databricks.com/api/account/accountmetastoreassignments/delete.
- workspace_id
A key field. Template: ShortText.
- metastore_id
Template: ShortText.
- default_catalog_name
Template: ShortText.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/metastores
.
The result is extracted from:{{=response.metastores}}
.Documentation: https://docs.databricks.com/api/account/accountmetastores/list.
- [Read single] action
-
Endpoint URL address:
/metastores/{{=parameters.id}}
.
The result is extracted from:{{=[response.metastore_info]}}
.Documentation: https://docs.databricks.com/api/account/accountmetastores/get.
- [Create] action
-
Endpoint URL address:
/metastores
.The following request parameters will be automatically processed:
-
application/json:
{{={ metastore_info: item } }}
Documentation: https://docs.databricks.com/api/account/accountmetastores/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/metastores/{{=item.metastore_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ metastore_info: item } }}
Documentation: https://docs.databricks.com/api/account/accountmetastores/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/metastores/{{=item.metastore_id}}
.The action has the following user-defined parameters:
- force: Optional. Force deletion even if the metastore is not empty. Default is false.
Documentation: https://docs.databricks.com/api/account/accountmetastores/delete.
- metastore_id
A key field. Template: ShortText.
- name
Template: ShortText.
- new_name
Template: ShortText.
- storage_root
Template: ShortText.
- region
Template: ShortText.
- default_data_access_config_id
Template: ShortText. A read-only field.
- storage_root_credential_id
Template: ShortText.
- delta_sharing_scope
Template: ShortText.
- delta_sharing_recipient_token_lifetime_in_seconds
Template: Int.
- delta_sharing_organization_name
Template: ShortText.
- owner
Template: ShortText.
- privilege_model_version
Template: ShortText.
- created_at
Template: DateTime2. A read-only field.
- created_by
Template: ShortText. A read-only field.
- updated_at
Template: DateTime2. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- storage_root_credential_name
Template: ShortText. A read-only field.
- cloud
Template: ShortText. A read-only field.
- global_metastore_id
Template: ShortText. A read-only field.
- external_access_enabled
Template: ShortText. A read-only field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/metastores/{{=parameters.metastore_id}}/storage-credentials
.
The result is extracted from:{{=response.storage_credentials}}
.The action has the following user-defined parameters:
- metastore_id: Required. Unity Catalog metastore ID.
Documentation: https://docs.databricks.com/api/account/accountstoragecredentials/list.
- [Read single] action
-
Endpoint URL address:
/metastores/{{=parameters.metastore_id}}/storage-credentials/{{=parameters.id}}
.
The result is extracted from:{{=[response.credential_info]}}
.The action has the following user-defined parameters:
- metastore_id: Required. Unity Catalog metastore ID.
Documentation: https://docs.databricks.com/api/account/accountstoragecredentials/get.
- [Create] action
-
Endpoint URL address:
/metastores/{{=item.metastore_id}}/storage-credentials
.The following request parameters will be automatically processed:
-
application/json:
{{={ credential_info: item } }}
Documentation: https://docs.databricks.com/api/account/accountstoragecredentials/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/metastores/{{=item.metastore_id}}/storage-credentials/{{=item.storage_credential_name}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ credential_info: item } }}
Documentation: https://docs.databricks.com/api/account/accountstoragecredentials/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/metastores/{{=item.metastore_id}}/storage-credentials/{{=item.storage_credential_name}}
.Documentation: https://docs.databricks.com/api/account/accountstoragecredentials/delete.
- metastore_id
A key field. Template: ShortText.
- storage_credential_name
A key field. Template: ShortText.
- name
Template: ShortText.
- new_name
Template: ShortText.
- aws_iam_role
Field components:
-
Uses template:
ShortText
. - Contains the following components: role_arn, unity_catalog_iam_arn, external_id.
-
Uses template:
- databricks_gcp_service_account
Field components:
-
Uses template:
ShortText
. - Contains the following components: email, credential_id.
-
Uses template:
- azure_service_principal
Field components:
-
Uses template:
ShortText
. - Contains the following components: directory_id, application_id, client_secret.
-
Uses template:
- azure_managed_identity
Field components:
-
Uses template:
ShortText
. - Contains the following components: access_connector_id, managed_identity_id, credential_id.
-
Uses template:
- skip_validation
Template: ShortText.
- comment
Template: ShortText.
- read_only
Template: ShortText.
- owner
Template: ShortText. A read-only field.
- created_at
Template: DateTime2. A read-only field.
- created_by
Template: ShortText. A read-only field.
- updated_at
Template: DateTime2. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- used_for_managed_storage
Template: ShortText. A read-only field.
- isolation_mode
Template: ShortText.
- force
Template: ShortText.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/ip-access-lists
.
The result is extracted from:{{=response.ip_access_lists}}
.Documentation: https://docs.databricks.com/api/account/accountstoragecredentials/get.
- [Read single] action
-
Endpoint URL address:
/ip-access-lists/{{=parameters.id}}
.
The result is extracted from:{{=[response.ip_access_list]}}
.Documentation: https://docs.databricks.com/api/account/accountipaccesslists/get.
- [Create] action
-
Endpoint URL address:
/ip-access-lists
.Documentation: https://docs.databricks.com/api/account/accountipaccesslists/create.
- [Update] action
-
Endpoint URL address:
/ip-access-lists/{{=item.ip_access_list_id}}
.Documentation: https://docs.databricks.com/api/account/accountipaccesslists/replace.
- [Delete] action
-
Endpoint URL address:
/ip-access-lists/{{=item.ip_access_list_id}}
.Documentation: https://docs.databricks.com/api/account/accountipaccesslists/delete.
- ip_access_list_id
A key field. Template: ShortText.
- list_id
Template: ShortText.
- label
Template: ShortText.
- ip_addresses
Template: LongText. A composite field.
- address_count
Template: Int.
- list_type
Template: ShortText.
- created_at
Template: DateTime2. A read-only field.
- created_by
Template: ShortText. A read-only field.
- updated_at
Template: DateTime2. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- enabled
Template: ShortText.
Based on resource template Account.
- [Read] action
-
Endpoint URL address:
/settings/types/shield_csp_enablement_ac/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Used for versioning. The response is at least as fresh as the eTag provided.
Documentation: https://docs.databricks.com/api/account/cspenablementaccount/get.
- [Update] action
-
Endpoint URL address:
/settings/types/shield_csp_enablement_ac/names/default
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/account/cspenablementaccount/update.
- etag
Template: ShortText. A read-only field.
- setting_name
Template: ShortText. A read-only field.
- csp_enablement_account
A read-only field. Field components:
-
Uses template:
ShortText
. - Contains the following components: is_enforced, compliance_standards.
-
Uses template:
- allow_missing
Template: ShortText.
- setting
Field components:
-
Uses template:
ShortText
. - Contains the following components: etag, setting_name, csp_enablement_account.
-
Uses template:
- field_mask
Template: ShortText.
Based on resource template Account.
- [Read] action
-
Endpoint URL address:
/settings/types/shield_csp_enablement_ac/names/default
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- etag: Optional. Used for versioning. The response is at least as fresh as the eTag provided.
Documentation: https://docs.databricks.com/api/account/cspenablementaccount/get.
- [Update] action
-
Endpoint URL address:
/settings/types/shield_esm_enablement_ac/names/default
.Documentation: https://docs.databricks.com/api/account/esmenablementaccount/update.
- etag
Template: ShortText. A read-only field.
- setting_name
Template: ShortText. A read-only field.
- esm_enablement_account
A read-only field. Field components:
-
Uses template:
ShortText
. - Contains the following components: is_enforced.
-
Uses template:
- allow_missing
Template: ShortText.
- setting
Field components:
-
Uses template:
ShortText
. - Contains the following components: etag, setting_name, esm_enablement_account.
-
Uses template:
- field_mask
Template: ShortText.
Based on resource template AccountTokenPaginated.
- [Read List] action
-
Endpoint URL address:
/network-connectivity-configs
.
The result is extracted from:{{=response.items}}
.Documentation: https://docs.databricks.com/api/account/networkconnectivity/listnetworkconnectivityconfigurations.
- [Read single] action
-
Endpoint URL address:
/network-connectivity-configs/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/networkconnectivity/getnetworkconnectivityconfiguration.
- [Create] action
-
Endpoint URL address:
/network-connectivity-configs
.Documentation: https://docs.databricks.com/api/account/networkconnectivity/createnetworkconnectivityconfiguration.
- [Delete] action
-
Endpoint URL address:
/network-connectivity-configs/{{=item.network_connectivity_config_id}}
.Documentation: https://docs.databricks.com/api/account/networkconnectivity/deletenetworkconnectivityconfiguration.
- network_connectivity_config_id
A key field. Template: ShortText.
- name
Template: ShortText.
- region
Template: ShortText.
- egress_config
A read-only field. Field components:
- Contains the following components: default_rules, target_rules.
- creation_time
Template: DateTime2. A read-only field.
- updated_time
Template: DateTime2. A read-only field.
Based on resource template AccountTokenPaginated.
- [Read List] action
-
Endpoint URL address:
/network-connectivity-configs/{{=parameters.network_connectivity_config_id}}/private-endpoint-rules
.
The result is extracted from:{{=response.items}}
.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
Documentation: https://docs.databricks.com/api/azure/account/networkconnectivity/listprivateendpointrules.
-
page_token:
- [Read single] action
-
Endpoint URL address:
/network-connectivity-configs/{{=parameters.network_connectivity_config_id}}/private-endpoint-rules/{{=parameters.id}}
.The action has the following user-defined parameters:
- network_connectivity_config_id: Required. Your Network Connectvity Configuration ID.
Documentation: https://docs.databricks.com/api/azure/account/networkconnectivity/getprivateendpointrule.
- [Create] action
-
Endpoint URL address:
/network-connectivity-configs/{{=item.network_connectivity_config_id}}/private-endpoint-rules
.Documentation: https://docs.databricks.com/api/azure/account/networkconnectivity/createprivateendpointrule.
- [Delete] action
-
Endpoint URL address:
/network-connectivity-configs/{{=item.network_connectivity_config_id}}/private-endpoint-rules/{{=item.rule_id}}
.Documentation: https://docs.databricks.com/api/azure/account/networkconnectivity/deleteprivateendpointrule.
- rule_id
A key field. Template: ShortText.
- network_connectivity_config_id
A key field. Template: ShortText.
- resource_id
Template: ShortText.
- group_id
Template: ShortText.
- endpoint_name
Template: ShortText. A read-only field.
- connection_state
Template: ShortText. A read-only field.
- deactivated
Data type: DT_BOOL A read-only field.
- deactivated_at
Template: DateTime2. A read-only field.
- creation_time
Template: DateTime2. A read-only field.
- updated_time
Template: DateTime2. A read-only field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/credentials
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/credentials/list.
- [Read single] action
-
Endpoint URL address:
/credentials/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/credentials/get.
- [Create] action
-
Endpoint URL address:
/credentials
.Documentation: https://docs.databricks.com/api/account/credentials/create.
- [Delete] action
-
Endpoint URL address:
/credentials/{{=item.credentials_id}}
.Documentation: https://docs.databricks.com/api/account/credentials/delete.
- credentials_id
A key field. Template: ShortText.
- credentials_name
Template: ShortText.
- aws_credentials
Field components:
- Contains the following components: sts_role.
- creation_time
Template: DateTime2. A read-only field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/customer-managed-keys
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/encryptionkeys/list.
- [Read single] action
-
Endpoint URL address:
/customer-managed-keys/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/encryptionkeys/get.
- [Create] action
-
Endpoint URL address:
/customer-managed-keys
.Documentation: https://docs.databricks.com/api/account/encryptionkeys/create.
- [Delete] action
-
Endpoint URL address:
/customer-managed-keys/{{=item.customer_managed_key_id}}
.Documentation: https://docs.databricks.com/api/account/encryptionkeys/delete.
- customer_managed_key_id
A key field. Template: ShortText.
- account_id
Template: ShortText. A read-only field.
- aws_key_info
Field components:
-
Uses template:
ShortText
. - Contains the following components: key_arn, key_alias, key_region, reuse_key_for_cluster_volumes.
-
Uses template:
- gcp_key_info
Field components:
-
Uses template:
ShortText
. - Contains the following components: kms_key_id.
-
Uses template:
- creation_time
Template: DateTime2. A read-only field.
- use_cases
Template: LongText. A composite field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/networks
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/networks/list.
- [Read single] action
-
Endpoint URL address:
/networks/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/networks/get.
- [Create] action
-
Endpoint URL address:
/networks
.Documentation: https://docs.databricks.com/api/account/networks/create.
- [Delete] action
-
Endpoint URL address:
/networks/{{=item.network_id}}
.Documentation: https://docs.databricks.com/api/account/networks/delete.
- account_id
Template: ShortText. A read-only field.
- network_id
A key field. Template: ShortText.
- network_name
Template: ShortText.
- vpc_id
Template: ShortText.
- subnet_ids
Template: LongText. A composite field.
- security_group_ids
Template: LongText. A composite field.
- vpc_status
Template: ShortText. A read-only field.
- workspace_id
Template: ShortText. A read-only field.
- creation_time
Template: DateTime2. A read-only field.
- vpc_endpoints
Field components:
-
Uses template:
LongText
. - Contains the following components: rest_api, dataplane_relay.
-
Uses template:
- gcp_network_info
Field components:
-
Uses template:
ShortText
. - Contains the following components: network_project_id, vpc_id, subnet_id, subnet_region, pod_ip_range_name, service_ip_range_name.
-
Uses template:
- warning_messages
A read-only field. Field components:
- An array.
- Contains the following components: warning_type, warning_message.
- error_messages
A read-only field. Field components:
- An array.
- Contains the following components: error_type, error_message.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/private-access-settings
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/privateaccess/list.
- [Read single] action
-
Endpoint URL address:
/private-access-settings/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/privateaccess/create.
- [Create] action
-
Endpoint URL address:
/private-access-settings
.Documentation: https://docs.databricks.com/api/account/privateaccess/create.
- [Update] action
-
Endpoint URL address:
/private-access-settings/{{=item.private_access_settings_id}}
.Documentation: https://docs.databricks.com/api/account/privateaccess/replace.
- [Delete] action
-
Endpoint URL address:
/private-access-settings/{{=item.private_access_settings_id}}
.Documentation: https://docs.databricks.com/api/account/privateaccess/delete.
- account_id
Template: ShortText. A read-only field.
- private_access_settings_id
A key field. Template: ShortText.
- private_access_settings_name
Template: ShortText.
- public_access_enabled
Template: ShortText.
- region
Template: ShortText.
- private_access_level
Template: ShortText.
- allowed_vpc_endpoint_ids
Template: LongText. A composite field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/storage-configurations
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/storage/list.
- [Read single] action
-
Endpoint URL address:
/storage-configurations/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/storage/get.
- [Create] action
-
Endpoint URL address:
/storage-configurations
.Documentation: https://docs.databricks.com/api/account/storage/create.
- [Delete] action
-
Endpoint URL address:
/storage-configurations/{{=item.storage_configuration_id}}
.Documentation: https://docs.databricks.com/api/account/storage/delete.
- account_id
Template: ShortText. A read-only field.
- storage_configuration_id
A key field. Template: ShortText.
- storage_configuration_name
Template: ShortText.
- root_bucket_info
Field components:
-
Uses template:
ShortText
. - Contains the following components: bucket_name.
-
Uses template:
- creation_time
Template: DateTime2. A read-only field.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/vpc-endpoints
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/vpcendpoints/list.
- [Read single] action
-
Endpoint URL address:
/vpc-endpoints/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/storage/get.
- [Create] action
-
Endpoint URL address:
/vpc-endpoints
.Documentation: https://docs.databricks.com/api/account/vpcendpoints/create.
- [Delete] action
-
Endpoint URL address:
/vpc-endpoints/{{=item.vpc_endpoint_id}}
.Documentation: https://docs.databricks.com/api/account/vpcendpoints/delete.
- account_id
A key field. Template: ShortText.
- vpc_endpoint_id
A key field. Template: ShortText.
- aws_endpoint_service_id
Template: ShortText. A read-only field.
- use_case
Template: ShortText. A read-only field.
- aws_account_id
Template: ShortText. A read-only field.
- state
Template: ShortText. A read-only field.
- vpc_endpoint_name
Template: ShortText.
- aws_vpc_endpoint_id
Template: ShortText.
- region
Template: ShortText.
- gcp_vpc_endpoint_info
Field components:
-
Uses template:
ShortText
. - Contains the following components: project_id, psc_endpoint_name, endpoint_region, psc_connection_id, service_attachment_id.
-
Uses template:
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/workspaces
.
The result is extracted from:{{=response}}
.Documentation: https://docs.databricks.com/api/account/workspaces/list.
- [Read single] action
-
Endpoint URL address:
/workspaces/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/workspaces/get.
- [Create] action
-
Endpoint URL address:
/workspaces
.Documentation: https://docs.databricks.com/api/account/workspaces/create.
- [Update] action
-
Endpoint URL address:
/workspaces/{{=item.workspace_id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/account/workspaces/update.
- [Delete] action
-
Endpoint URL address:
/workspaces/{{=item.workspace_id}}
.Documentation: https://docs.databricks.com/api/account/workspaces/delete.
- account_id
Template: ShortText. A read-only field.
- workspace_id
A key field. Template: ShortText.
- workspace_name
Template: ShortText.
- deployment_name
Template: ShortText.
- network_id
Template: ShortText.
- aws_region
Template: ShortText.
- credentials_id
Template: ShortText.
- storage_configuration_id
Template: ShortText.
- workspace_status
Template: ShortText. A read-only field.
- workspace_status_message
Template: ShortText. A read-only field.
- managed_services_customer_managed_key_id
Template: ShortText.
- private_access_settings_id
Template: ShortText.
- creation_time
Template: DateTime2. A read-only field.
- pricing_tier
Template: ShortText.
- storage_customer_managed_key_id
Template: ShortText.
- custom_tags
Template: LongText. A composite field.
- network_connectivity_config_id
Template: ShortText.
- cloud
Template: ShortText.
- location
Template: ShortText.
- cloud_resource_container
Field components:
- Contains the following components: gcp.
- gke_config
Field components:
-
Uses template:
ShortText
. - Contains the following components: connectivity_type, master_ip_range.
-
Uses template:
- gcp_managed_network_config
Field components:
-
Uses template:
ShortText
. - Contains the following components: subnet_cidr, gke_cluster_pod_ip_range, gke_cluster_service_ip_range.
-
Uses template:
Based on resource template Account.
- [Read] action
-
Endpoint URL address:
/usage/download
.
The result is extracted from:{{=Databricks.getCsvData(response)}}
.The action has the following user-defined parameters:
- start_month: Required. Format: YYYY-MM. First month to return billable usage logs for.
- end_month: Required. Format: YYYY-MM. Last month to return billable usage logs for.
- personal_data: Required. Specify whether to include personally identifiable information in the billable usage logs, for example the email addresses of cluster creators. Handle this information with care.
Documentation: https://docs.databricks.com/api/account/billableusage/download.
- workspaceId
Template: ShortText.
- timestamp
Template: Date.
- clusterId
Template: ShortText.
- clusterName
Template: ShortText.
- clusterNodeType
Template: ShortText.
- clusterOwnerUserId
Template: ShortText.
- clusterCustomTags
Template: LongText.
- sku
Template: ShortText.
- dbus
Template: Double.
- machineHours
Template: Double.
- clusterOwnerUserName
Template: ShortText.
- tags
Template: LongText.
Based on resource template Account.
- [Read List] action
-
Endpoint URL address:
/log-delivery
.
The result is extracted from:{{=response.log_delivery_configurations}}
.The action has the following user-defined parameters:
- status: Optional. Filter by status ENABLED or DISABLED.
- credentials_id: Optional. Filter by credential configuration ID.
- storage_configuration_id: Optional. Filter by storage configuration ID.
Documentation: https://docs.databricks.com/api/account/logdelivery/list.
- [Read single] action
-
Endpoint URL address:
/log-delivery/{{=parameters.id}}
.
The result is extracted from:{{=[response.log_delivery_configuration]}}
.Documentation: https://docs.databricks.com/api/account/logdelivery/get.
- [Create] action
-
Endpoint URL address:
/log-delivery
.The following request parameters will be automatically processed:
-
application/json:
{{={ log_delivery_configuration: item } }}
Documentation: https://docs.databricks.com/api/account/logdelivery/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/log-delivery/{{=item.log_delivery_configuration_id}}
.
The action uses PATCH method.Documentation: https://docs.databricks.com/api/account/logdelivery/patchstatus.
- log_delivery_configuration_id
A key field. Template: ShortText.
- account_id
A key field. Template: ShortText.
- config_id
Template: ShortText. A read-only field.
- creation_time
Template: DateTime2. A read-only field.
- update_time
Template: DateTime2. A read-only field.
- log_delivery_status
A read-only field. Field components:
-
Uses template:
ShortText
. - Contains the following components: status, message, last_attempt_time, last_successful_attempt_time.
-
Uses template:
- config_name
Template: ShortText.
- status
Template: ShortText.
- log_type
Template: ShortText.
- output_format
Template: ShortText.
- credentials_id
Template: ShortText.
- storage_configuration_id
Template: ShortText.
- workspace_ids_filter
Template: LongText. A composite field.
- delivery_path_prefix
Template: ShortText.
- delivery_start_time
Template: ShortText.
Based on resource template Account.
- [Read] action
-
Endpoint URL address:
/dashboard
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- workspace_id: Optional. The workspace ID of the workspace in which the usage dashboard is created.
- dashboard_type: Optional. Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account.
Documentation: https://docs.databricks.com/api/account/usagedashboards/create.
- [Create] action
-
Endpoint URL address:
/dashboard
.Documentation: https://docs.databricks.com/api/account/usagedashboards/create.
- dashboard_id
Template: ShortText. A read-only field.
- dashboard_url
Template: ShortText. A read-only field.
- workspace_id
Template: Long.
- dashboard_type
Template: ShortText.
Based on resource template AccountTokenPaginated21.
- [Read List] action
-
Endpoint URL address:
/budgets
.
The result is extracted from:{{=response.budgets}}
.Documentation: https://docs.databricks.com/api/account/budgets/list.
- [Read single] action
-
Endpoint URL address:
/budgets/{{=parameters.id}}
.
The result is extracted from:{{=[response.budget]}}
.Documentation: https://docs.databricks.com/api/account/budgets/get.
- [Create] action
-
Endpoint URL address:
/budgets
.The following request parameters will be automatically processed:
-
application/json:
{{={ budget: item } }}
Documentation: https://docs.databricks.com/api/account/budgets/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/budgets/{{=item.budget_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ budget: item } }}
Documentation: https://docs.databricks.com/api/account/budgets/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/budgets/{{=item.budget_id}}
.Documentation: https://docs.databricks.com/api/account/budgets/delete.
- budget_id
A key field. Template: ShortText.
- budget_configuration_id
Template: ShortText.
- account_id
Template: ShortText.
- create_time
Template: DateTime2. A read-only field.
- update_time
Template: DateTime2. A read-only field.
- alert_configurations
Field components:
- An array.
- Contains the following components: alert_configuration_id, time_period, trigger_type, quantity_type, quantity_threshold, action_configurations.
- filter
Field components:
- Contains the following components: workspace_id, tags.
- display_name
Template: ShortText.
Based on resource template AccountTokenPaginatedSize.
- [Read List] action
-
Endpoint URL address:
/oauth2/custom-app-integrations
.
The result is extracted from:{{=response.apps}}
.The action has the following user-defined parameters:
- include_creator_username: Optional. Whether to include the creater username.
Documentation: https://docs.databricks.com/api/account/customappintegration/list.
- [Read single] action
-
Endpoint URL address:
/oauth2/custom-app-integrations/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/customappintegration/get.
- [Create] action
-
Endpoint URL address:
/oauth2/custom-app-integrations
.The following request parameters will be automatically processed:
-
application/json:
{{={ value: _.omit(item, 'summary'), summary: item.summary } }}
Documentation: https://docs.databricks.com/api/account/customappintegration/create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/oauth2/custom-app-integrations/{{=item.integration_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ value: item } }}
Documentation: https://docs.databricks.com/api/account/customappintegration/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/oauth2/custom-app-integrations/{{=item.integration_id}}
.Documentation: https://docs.databricks.com/api/account/customappintegration/delete.
- account_id
A key field. Template: ShortText.
- summary
Template: ShortText.
- integration_id
A key field. Template: ShortText.
- client_id
Template: ShortText. A read-only field.
- redirect_urls
Template: LongText. A composite field.
- name
Template: ShortText.
- confidential
Template: ShortText.
- token_access_policy
Field components:
-
Uses template:
Int
. - Contains the following components: access_token_ttl_in_minutes, refresh_token_ttl_in_minutes.
-
Uses template:
- scopes
Template: LongText. A composite field.
- created_by
Template: Int. A read-only field.
- create_time
Template: DateTime2. A read-only field.
- creator_username
Template: ShortText. A read-only field.
Based on resource template AccountTokenPaginated.
- [Read List OAuth apps] action
-
Endpoint URL address:
/oauth2/published-apps
.
The result is extracted from:{{=response.apps}}
.
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
Documentation: https://docs.databricks.com/api/account/oauthpublishedapps/list.
-
page_token:
- [Read List] action
-
Endpoint URL address:
/oauth2/published-app-integrations
.
The result is extracted from:{{=response.apps}}
.Documentation: https://docs.databricks.com/api/account/publishedappintegration/list.
- [Read single] action
-
Endpoint URL address:
/oauth2/published-app-integrations/{{=parameters.id}}
.Documentation: https://docs.databricks.com/api/account/publishedappintegration/get.
- [Create] action
-
Endpoint URL address:
/oauth2/published-app-integrations
.Documentation: https://docs.databricks.com/api/account/publishedappintegration/create.
- [Update] action
-
Endpoint URL address:
/oauth2/published-app-integrations/{{=item.integration_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ value: item } }}
Documentation: https://docs.databricks.com/api/account/publishedappintegration/update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/oauth2/published-app-integrations/{{=item.integration_id}}
.Documentation: https://docs.databricks.com/api/account/publishedappintegration/delete.
- client_id
Template: ShortText. A read-only field.
- description
Template: ShortText. A read-only field.
- is_confidential_client
Template: ShortText. A read-only field.
- redirect_urls
Template: LongText. A read-only field. A composite field.
- scopes
Template: LongText. A read-only field. A composite field.
- app_id
Template: ShortText.
- integration_id
A key field. Template: ShortText.
- name
Template: ShortText. A read-only field.
- token_access_policy
Field components:
-
Uses template:
Int
. - Contains the following components: access_token_ttl_in_minutes, refresh_token_ttl_in_minutes.
-
Uses template:
- created_by
Template: ShortText. A read-only field.
- create_time
Template: DateTime2. A read-only field.
Based on resource template AccountTokenPaginated.
- [Read] action
-
Endpoint URL address:
/servicePrincipals/{{=parameters.service_principal_id}}/credentials/secrets
.
The result is extracted from:{{=response.secrets}}
.The action has the following user-defined parameters:
- service_principal_id: Required. The service principal ID.
Documentation: https://docs.databricks.com/api/account/serviceprincipalsecrets/list.
- [Create] action
-
Endpoint URL address:
/servicePrincipals/{{=item.service_principal_id}}/credentials/secrets
.Documentation: https://docs.databricks.com/api/account/serviceprincipalsecrets/create.
- [Delete] action
-
Endpoint URL address:
/servicePrincipals/{{=item.service_principal_id}}/credentials/secrets/{{=item.id}}
.Documentation: https://docs.databricks.com/api/account/serviceprincipalsecrets/delete.
- account_id
A key field. Template: ShortText.
- service_principal_id
A key field. Template: ShortText.
- id
A key field. Template: ShortText.
- secret
Template: ShortText.
- secret_hash
Template: ShortText.
- create_time
Template: Date.
- update_time
Template: Date.
- status
Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Read single] action
-
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify record identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Workspace.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_token:
Based on resource template Workspace.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
-
page:
Based on resource template WorkspacePagination.
- [Read List] action
-
The following request parameters will be automatically processed:
-
page_size:
{{=parameters.batchSize}}
-
page_size:
Based on resource template WorkspacePagination.
- [Read List] action
-
The following request parameters will be automatically processed:
-
max_results:
{{=parameters.batchSize}}
-
max_results:
Based on resource template WorkspaceMaxResultsPagination.
- [Read Search] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
max_results:
{{=parameters.batchSize}}
-
page_token:
Based on resource template Workspace.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
startIndex:
{{=parameters.iterator}}
-
count:
{{=parameters.batchSize}}
-
startIndex:
Based on resource template Workspace21.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
limit:
{{=parameters.batchSize}}
-
page_token:
Based on resource template WorkspaceMaxResultsPagination.
Based on resource template WorkspaceSizePagination.
Based on resource template Workspace21SizePagination.
- [Read Search] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_size:
{{=parameters.batchSize}}
-
page_token:
Based on resource template Base.
- [Create] action
-
The following request parameters will be automatically processed:
-
application/json:
{{={ access_control_list: batch } }}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ access_control_list: batch } }}
-
application/json:
The resource includes the fields from the T_permissions template.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Account.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
count:
{{=parameters.batchSize}}
-
startIndex:
{{=parameters.iterator}}
-
count:
Based on resource template Account.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_token:
Based on resource template AccountTokenPaginated.
- [Read List] action
-
The following request parameters will be automatically processed:
-
page_size:
{{=parameters.batchSize}}
-
page_size:
Based on resource template Account21.
- [Read List] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page_token:
{{=parameters.iterator}}
-
page_token:
- ShortText
Data type: DT_WSTR ( length 256 )
- LongText
Data type: DT_WSTR ( length 1024 )
- Int
Data type: DT_I4
- Long
Data type: DT_I8
- Double
Data type: DT_R8
- Bool
Data type: DT_BOOL
- DateTime2
Data type: DT_DBTIMESTAMP2 The gathered value is processed with
{{=new Date(value)}}
expression.- Date
Data type: DT_DATE
- Decimal
Data type: DT_DECIMAL
- ActionT
- T_grant_rules
-
Field components:
- An array.
- Contains the following components: principals, role.
Documentation: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/updateruleset#grant_rules.
- T_git_source
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: git_branch, git_provider, git_url, git_tag, git_commit, git_snapshot.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-git_source.
-
Uses template:
- T_notebook_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: notebook_path, base_parameters, source, warehouse_id.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-notebook_task.
-
Uses template:
- T_spark_jar_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: jar_uri, parameters, main_class_name.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-spark_jar_task.
-
Uses template:
- T_spark_python_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: python_file, parameters, source.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-spark_python_task.
-
Uses template:
- T_spark_submit_task
-
Field components:
-
Uses template:
LongText
. - Contains the following components: parameters.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-spark_submit_task.
-
Uses template:
- T_pipeline_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: pipeline_id, full_refresh.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-pipeline_task.
-
Uses template:
- T_python_wheel_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: package_name, entry_point, parameters, named_parameters.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-python_wheel_task.
-
Uses template:
- T_dbt_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: project_directory, schema, commands, warehouse_id, profiles_directory, catalog, source.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-dbt_task.
-
Uses template:
- T_sql_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: query, schema, parameters, dashboard, alert, file, warehouse_id.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-sql_task.
-
Uses template:
- T_run_job_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: job_id, jar_params, notebook_params, python_params, spark_submit_params, python_named_params, sql_params, dbt_commands, pipeline_params, job_parameters, idempotency_token, queue.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-run_job_task.
-
Uses template:
- T_condition_task
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: op, left, right, outcome.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-condition_task.
-
Uses template:
- T_for_each_task
-
Field components:
-
Uses template:
LongText
. - Contains the following components: inputs, concurrency, task.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-for_each_task.
-
Uses template:
- T_init_scripts
-
Field components:
- An array.
- Contains the following components: workspace, volumes, s3, file, dbfs, abfss, gcs.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-new_cluster-init_scripts.
- T_aws_attributes
-
Field components:
-
Uses template:
Int
. - Contains the following components: first_on_demand, availability, zone_id, instance_profile_arn, spot_bid_price_percent, ebs_volume_type, ebs_volume_count, ebs_volume_size, ebs_volume_iops, ebs_volume_throughput.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-new_cluster-aws_attributes.
-
Uses template:
- T_azure_attributes
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: log_analytics_info, first_on_demand, availability, spot_bid_max_price.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/list#jobs-settings-job_clusters-new_cluster-azure_attributes.
-
Uses template:
- T_gcp_attributes
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: google_service_account, boot_disk_size, availability, local_ssd_count, use_preemptible_executors, zone_id.
Documentation: https://docs.databricks.com/api/gcp/workspace/jobs/list#jobs-settings-job_clusters-new_cluster-gcp_attributes.
-
Uses template:
- T_new_cluster
-
Field components:
-
Uses template:
Int
. - Contains the following components: num_workers, autoscale, cluster_name, spark_version, spark_conf, aws_attributes, azure_attributes, gcp_attributes, node_type_id, driver_node_type_id, ssh_public_keys, custom_tags, cluster_log_conf, init_scripts, spark_env_vars, autotermination_minutes, enable_elastic_disk, instance_pool_id, policy_id, enable_local_disk_encryption, driver_instance_pool_id, workload_type, runtime_engine, docker_image, data_security_mode, single_user_name, apply_policy_default_values.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-new_cluster.
-
Uses template:
- T_docker_image
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: url, basic_auth.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-new_cluster-docker_image.
-
Uses template:
- T_notification_settings
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: no_alert_for_skipped_runs, no_alert_for_canceled_runs, alert_on_last_attempt.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-notification_settings.
-
Uses template:
- T_library
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: jar, egg, pypi, maven, cran, whl, requirements.
Documentation: https://docs.databricks.com/api/workspace/libraries/install#libraries.
-
Uses template:
- T_libraries
-
Field components:
- An array.
-
Uses template:
T_library
.
Documentation: https://docs.databricks.com/api/workspace/libraries/install#libraries.
- T_managed_library
-
Template: T_library. Field components:
-
Uses template:
ShortText
. - Contains the following components: cluster_id, library_statuses.
Documentation: https://docs.databricks.com/api/workspace/libraries/allclusterlibrarystatuses.
-
Uses template:
- T_email_notifications
-
Field components:
-
Uses template:
LongText
. - Contains the following components: on_start, on_success, on_failure, on_duration_warning_threshold_exceeded, no_alert_for_skipped_runs.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-email_notifications.
-
Uses template:
- T_webhook_notifications
-
Field components:
- Contains the following components: on_start, on_success, on_failure, on_duration_warning_threshold_exceeded.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks-webhook_notifications.
- T_state
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: life_cycle_state, result_state, state_message, user_cancelled_or_timedout, queue_reason.
Documentation: https://docs.databricks.com/api/workspace/jobs/listruns#runs-state.
-
Uses template:
- T_schedule
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: quartz_cron_expression, timezone_id, pause_status.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-schedule.
-
Uses template:
- T_instance_pool
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: instance_pool_name, min_idle_instances, max_capacity, aws_attributes, gcp_attributes, azure_attributes, node_type_id, custom_tags, idle_instance_autotermination_minutes, enable_elastic_disk, disk_spec, preloaded_docker_images, preloaded_spark_versions, instance_pool_id, default_tags, state, stats, status.
Documentation: https://docs.databricks.com/api/workspace/instancepools/list#instance_pools.
-
Uses template:
- T_workload_type
-
Field components:
- Contains the following components: clients.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details-attributes-workload_type.
- T_cluster_log_conf
-
Field components:
- Contains the following components: dbfs, s3.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getupdate#update-config-clusters-cluster_log_conf.
- T_pipeline_clusters
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: label, spark_conf, aws_attributes, gcp_attributes, azure_attributes, node_type_id, driver_node_type_id, ssh_public_keys, custom_tags, cluster_log_conf, init_scripts, spark_env_vars, instance_pool_id, driver_instance_pool_id, policy_id, num_workers, autoscale, apply_policy_default_values, enable_local_disk_encryption.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getupdate#update-config-clusters.
-
Uses template:
- T_Attributes
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: cluster_name, spark_version, spark_conf, aws_attributes, node_type_id, driver_node_type_id, ssh_public_keys, custom_tags, cluster_log_conf, init_scripts, spark_env_vars, autotermination_minutes, enable_elastic_disk, instance_pool_id, policy_id, enable_local_disk_encryption, workload_type, runtime_engine, docker_image, data_security_mode, single_user_name.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details-attributes.
-
Uses template:
- T_cluster_instance
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: cluster_id, spark_context_id.
Documentation: https://docs.databricks.com/api/workspace/jobs/listruns#runs-cluster_instance.
-
Uses template:
- T_cluster_size
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: num_workers, autoscale.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details-cluster_size.
-
Uses template:
- T_reason
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: code, parameters, type.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details-reason.
-
Uses template:
- T_execution_details
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: status, execution_duration_seconds, error_message.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details-init_scripts-cluster-execution_details.
-
Uses template:
- T_global_init_scripts
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: reported_for_node, global, cluster.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details-init_scripts.
-
Uses template:
- T_data_plane_event_details
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: event_type, timestamp, host_id, executor_failures.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-data_plane_event_details.
-
Uses template:
- T_event_details
-
Field components:
-
Uses template:
Int
. - Contains the following components: current_num_workers, target_num_workers, previous_attributes, attributes, previous_cluster_size, cluster_size, cause, reason, user, previous_disk_size, disk_size, free_space, instance_id, driver_state_message, init_scripts, job_run_name, enable_termination_for_node_blocklisted, current_num_vcpus, target_num_vcpus.
Documentation: https://docs.databricks.com/api/workspace/clusters/events#events-details.
-
Uses template:
- T_task
-
Field components:
-
Uses template:
Int
. - Contains the following components: max_retries, task_key, run_if, description, min_retry_interval_millis, depends_on, timeout_seconds, libraries, retry_on_timeout, existing_cluster_id, job_cluster_key, spark_jar_task, notebook_task, spark_python_task, spark_submit_task, pipeline_task, python_wheel_task, dbt_task, sql_task, run_job_task, condition_task, for_each_task, new_cluster, email_notifications, notification_settings, webhook_notifications, environment_key, run_duration, queue_duration.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs-settings-tasks.
-
Uses template:
- T_permissions
Field components:
-
Uses template:
ShortText
. - Contains the following components: user_name, group_name, service_principal_name, permission_level, display_name, description, all_permissions.
-
Uses template:
- T_deployment
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: kind, metadata_file_path.
Documentation: https://docs.databricks.com/api/workspace/jobs/create#deployment.
-
Uses template:
- T_Job
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: job_id, creator_user_name, run_as_user_name, created_time, name, description, email_notifications, webhook_notifications, notification_settings, timeout_seconds, health, schedule, trigger, continuous, max_concurrent_runs, tasks, job_clusters, git_source, tags, format, queue, parameters, run_as, edit_mode, deployment, environments, access_control_list.
Documentation: https://docs.databricks.com/api/workspace/jobs/list#jobs.
-
Uses template:
- T_oneTimeJob
-
Template: T_Job. Field components:
-
Uses template:
ShortText
. - Contains the following components: run_name, idempotency_token.
Documentation: https://docs.databricks.com/api/workspace/jobs/submit.
-
Uses template:
- T_notebook_output
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: result, truncated.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/getrunoutput#notebook_output.
-
Uses template:
- T_sql_output
-
Field components:
- Contains the following components: query_output, dashboard_output, alert_output.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/getrunoutput#sql_output.
- T_run_job_output
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: run_id.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/getrunoutput#run_job_output.
-
Uses template:
- T_dbt_output
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: artifacts_link, artifacts_headers.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/getrunoutput#dbt_output.
-
Uses template:
- T_cluster_additional
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: node_type_id, key, name, zones, default_zone, node_info, is_graviton, photon_driver_capable, photon_worker_capable, is_encrypted_in_transit, memory_mb, num_cores, description, instance_type_id, is_deprecated, category, support_ebs_volumes, support_cluster_tags, num_gpus, node_instance_type, is_hidden, support_port_forwarding, supports_elastic_disk, display_order, is_io_cache_enabled, cluster_id, timestamp, event_type, data_plane_event_details, event_details.
Documentation: https://docs.databricks.com/api/workspace/clusters/listnodetypes.
-
Uses template:
- T_job_run
-
Field components:
-
Uses template:
Long
. - Contains the following components: job_run_id, job_id, run_id, creator_user_name, number_in_job, original_attempt_run_id, state, schedule, cluster_spec, cluster_instance, overriding_parameters, start_time, setup_duration, execution_duration, cleanup_duration, end_time, run_duration, queue_duration, trigger, trigger_info, run_name, run_page_url, run_type, tasks, description, attempt_number, job_clusters, git_source, repair_history, job_parameters, status.
Documentation: https://docs.databricks.com/api/workspace/jobs/listruns#runs.
-
Uses template:
- T_status
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: state, queue_details, termination_details.
Documentation: https://docs.databricks.com/api/workspace/jobs/listruns#runs-status.
-
Uses template:
- T_queue_details
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: code, message.
Documentation: https://docs.databricks.com/api/workspace/jobs/listruns#runs-status-queue_details.
-
Uses template:
- T_termination_details
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: code, type, message.
Documentation: https://docs.databricks.com/api/workspace/jobs/listruns#runs-status-termination_details.
-
Uses template:
- T_jobrun_output_and_operations
-
Template: T_run_job_task. Field components:
-
Uses template:
T_dbt_output
. - Contains the following components: dbt_output, run_job_output, sql_output, notebook_output, error, info, logs, logs_truncated, error_trace, run_id, latest_repair_id, rerun_tasks, rerun_all_failed_tasks, rerun_dependent_tasks, content, name, type.
Documentation: https://docs.databricks.com/api/azure/workspace/jobs/getrunoutput.
-
Uses template:
- T_pipeline_event
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, sequence, origin, timestamp, message, level, error, event_type, maturity_level.
Documentation: https://docs.databricks.com/api/workspace/pipelines/listpipelineevents#events.
-
Uses template:
- T_pipeline_update
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: update_id, pipeline_id, config, cause, state, cluster_id, creation_time, validate_only, full_refresh, refresh_selection, full_refresh_selection.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getupdate#update.
-
Uses template:
- T_pipeline_spec
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, cause, configuration, serverless, catalog, channel, edition, photon, development, continuous, trigger, filters, notifications, deployment, clusters, libraries, storage, target, allow_duplicate_names, dry_run.
Documentation: https://docs.databricks.com/api/workspace/pipelines/getupdate#update-config.
-
Uses template:
- T_pipeline
-
Template: T_pipeline_spec. Field components:
-
Uses template:
ShortText
. - Contains the following components: pipeline_id, health, last_modified, state, latest_updates, creator_user_name, run_as_user_name, cluster_id.
Documentation: https://docs.databricks.com/api/workspace/pipelines/listpipelines#statuses.
-
Uses template:
- T_ai21labs_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: ai21labs_api_key, ai21labs_api_key_plaintext.
Documentation: https://docs.databricks.com/api/workspace/commandexecution/commandstatus#results.
-
Uses template:
- T_anthropic_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: anthropic_api_key, anthropic_api_key_plaintext.
Documentation: https://docs.databricks.com/api/workspace/commandexecution/commandstatus#results.
-
Uses template:
- T_amazon_bedrock_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: aws_region, aws_access_key_id, aws_access_key_id_plaintext, aws_secret_access_key, aws_secret_access_key_plaintext, bedrock_provider.
Documentation: https://docs.databricks.com/api/workspace/commandexecution/commandstatus#results.
-
Uses template:
- T_cohere_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: cohere_api_key, cohere_api_key_plaintext, cohere_api_base.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-external_model-cohere_config.
-
Uses template:
- T_google_cloud_vertex_ai_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: private_key, private_key_plaintext, region, project_id.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-external_model-google_cloud_vertex_ai_config.
-
Uses template:
- T_databricks_model_serving_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: databricks_api_token, databricks_api_token_plaintext, databricks_workspace_url.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-external_model-databricks_model_serving_config.
-
Uses template:
- T_openai_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: openai_api_key, openai_api_key_plaintext, openai_api_type, openai_api_base, openai_api_version, openai_organization, openai_deployment_name, microsoft_entra_tenant_id, microsoft_entra_client_id, microsoft_entra_client_secret, microsoft_entra_client_secret_plaintext.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-external_model-openai_config.
-
Uses template:
- T_palm_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: palm_api_key, palm_api_key_plaintext.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-external_model-palm_config.
-
Uses template:
- T_external_model
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: provider, name, task, ai21labs_config, anthropic_config, amazon_bedrock_config, cohere_config, google_cloud_vertex_ai_config, databricks_model_serving_config, openai_config, palm_config.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-external_model.
-
Uses template:
- T_command_execution
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, status, results, clusterId, contextId, language.
Documentation: https://docs.databricks.com/api/workspace/commandexecution/commandstatus#results.
-
Uses template:
- T_foundation_model
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, display_name, docs, description.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-foundation_model.
-
Uses template:
- T_serving_state
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: deployment, deployment_state_message.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities-state.
-
Uses template:
- T_served_entities
-
Field components:
- An array.
- Contains the following components: name, external_model, foundation_model, entity_name, entity_version, min_provisioned_throughput, max_provisioned_throughput, workload_size, workload_type, scale_to_zero_enabled, environment_vars, instance_profile_arn, state, creator, creation_timestamp.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_entities.
- T_served_models
-
Field components:
- An array.
- Contains the following components: name, model_name, model_version, workload_size, workload_type, scale_to_zero_enabled, environment_vars, instance_profile_arn, state, creator, creation_timestamp.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-served_models.
- T_traffic_config
-
Field components:
- Contains the following components: routes.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-traffic_config.
- T_auto_capture_config
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: catalog_name, schema_name, table_name_prefix, enabled, state.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/create#config-auto_capture_config.
-
Uses template:
- T_serving_endpoint_query
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: object, created, model, choices, usage, predictions, data, outputs.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/query.
-
Uses template:
- T_serving_endpoint
-
Template: T_serving_endpoint_query. Field components:
-
Uses template:
ShortText
. - Contains the following components: content, logs, name, creator, creation_timestamp, last_updated_timestamp, state, config, pending_config, id, permission_level, tags, task, route_optimized, endpoint_url, data_plane_info.
Documentation: https://docs.databricks.com/api/workspace/servingendpoints/list#endpoints.
-
Uses template:
- T_embedding_source_columns
-
Field components:
- An array.
- Contains the following components: name, embedding_model_endpoint_name.
Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex#delta_sync_index_spec-embedding_source_columns.
- T_embedding_vector_columns
-
Field components:
- An array.
- Contains the following components: name, embedding_dimension.
Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex#delta_sync_index_spec-embedding_vector_columns.
- T_group_obj_array
-
Field components:
- An array.
- Contains the following components: $ref, value, display, primary, type.
Documentation: https://docs.databricks.com/api/workspace/groups/list#Resources-members.
- T_operations
-
Field components:
- An array.
- Contains the following components: op, path, value.
Documentation: https://docs.databricks.com/api/workspace/groups/patch#Operations.
- T_group_principal
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, schemas, displayName, members, groups, roles, entitlements, externalId, Operations.
Documentation: https://docs.databricks.com/api/workspace/groups/list#Resources.
-
Uses template:
- T_service_principal
-
Field components:
-
Uses template:
LongText
. - Contains the following components: schemas, id, applicationId, displayName, groups, roles, entitlements, externalId, active.
Documentation: https://docs.databricks.com/api/workspace/serviceprincipals/list#Resources.
-
Uses template:
- T_cluster
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: autoscale, ssh_public_keys, cluster_log_conf, init_scripts, spark_env_vars, instance_pool_id, policy_id, driver_instance_pool_id, workload_type, runtime_engine, docker_image, data_security_mode, apply_policy_default_values, single_user_name, driver, executors, jdbc_port, last_restarted_time, cluster_memory_mb, cluster_cores, cluster_log_status, cluster_id, spark_conf, custom_tags, spark_context_id, cluster_name, spark_version, aws_attributes, azure_attributes, gcp_attributes, node_type_id, driver_node_type_id, autotermination_minutes, enable_elastic_disk, disk_spec, cluster_source, enable_local_disk_encryption, instance_source, driver_instance_source, state, state_message, start_time, terminated_time, last_state_loss_time, num_workers, default_tags, creator_user_name, termination_reason, init_scripts_safe_mode, clone_from.
Documentation: https://docs.databricks.com/api/workspace/clusters/list#clusters.
-
Uses template:
- T_git_credentials
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: credential_id, id, git_username, git_provider, personal_access_token.
Documentation: https://docs.databricks.com/api/azure/workspace/gitcredentials/update#git_provider.
-
Uses template:
- T_repo
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, url, provider, path, branch, tag, head_commit_id, sparse_checkout.
Documentation: https://docs.databricks.com/api/azure/workspace/repos/list#repos-provider.
-
Uses template:
- T_ACL
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: scope, principal, permission.
Documentation: https://docs.databricks.com/api/azure/workspace/secrets/putacl#principal.
-
Uses template:
- T_secret
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: key, last_updated_timestamp, value, scope, string_value, bytes_value.
Documentation: https://docs.databricks.com/api/azure/workspace/secrets/putsecret#string_value.
-
Uses template:
- T_secret_scope
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, backend_type, scope, initial_manage_principal, scope_backend_type, backend_azure_keyvault.
Documentation: https://docs.databricks.com/api/azure/workspace/secrets/createscope#scope_backend_type.
-
Uses template:
- T_workspace_object
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: format, path, language, content, overwrite, recursive, object_type, object_id.
Documentation: https://docs.databricks.com/api/workspace/workspace/list#objects.
-
Uses template:
- T_cluster_policy
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: policy_id, name, description, definition, policy_family_id, policy_family_definition_overrides, is_default, max_clusters_per_user, libraries, creator_user_name, created_at_timestamp.
Documentation: https://docs.databricks.com/api/workspace/clusterpolicies/list#policies.
-
Uses template:
- T_global_init_script_resource
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: script_id, name, position, enabled, created_by, created_at, updated_by, updated_at, script.
Documentation: https://docs.databricks.com/api/workspace/globalinitscripts/list#scripts.
-
Uses template:
- T_instance_profile
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: instance_profile_arn, is_meta_instance_profile, iam_role_arn, skip_validation.
Documentation: https://docs.databricks.com/api/workspace/instanceprofiles/list#instance_profiles.
-
Uses template:
- T_policy_compliance_for_cluster
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: cluster_id, validate_only, is_compliant, violations.
Documentation: https://docs.databricks.com/api/workspace/policycomplianceforclusters/listcompliance#clusters.
-
Uses template:
- T_policy_famliy
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: policy_family_id, name, description, definition.
Documentation: https://docs.databricks.com/api/workspace/policyfamilies/list#policy_families.
-
Uses template:
- T_job_policy_compliance
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: job_id, validate_only, is_compliant, violations.
Documentation: https://docs.databricks.com/api/workspace/policycomplianceforjobs/listcompliance#jobs.
-
Uses template:
- T_file_resource
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: path, is_directory, file_size, last_modified, name.
-
Uses template:
- T_experiment
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: experiment_id, name, new_name, artifact_location, lifecycle_stage, last_update_time, creation_time, tags.
Documentation: https://docs.databricks.com/api/workspace/experiments/listexperiments#experiments.
-
Uses template:
- T_experiment_run
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: run_id, run_uuid, status, start_time, end_time, experiment_id, user_id, artifact_uri, lifecycle_stage, tags, metrics, params, dataset_inputs.
Documentation: https://docs.databricks.com/api/workspace/experiments/searchruns#runs.
-
Uses template:
- T_model_version
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, artifact_uri, version, creation_timestamp, last_updated_timestamp, user_id, current_stage, description, source, run_id, status, status_message, tags, run_link.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/searchmodelversions#model_versions.
-
Uses template:
- T_model_version_transition
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, stage, version, comment, creator, creation_timestamp, last_updated_timestamp, user_id, activity_type, from_stage, to_stage, system_comment.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/transitionstage#name.
-
Uses template:
- T_model
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, creation_timestamp, last_updated_timestamp, user_id, description, latest_versions, id, permission_level, tags.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/listmodels#registered_models.
-
Uses template:
- T_model_webhook
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, events, creation_timestamp, last_updated_timestamp, description, status, http_url_spec, job_spec, model_name.
Documentation: https://docs.databricks.com/api/workspace/modelregistry/listmodels#registered_models.
-
Uses template:
- T_app
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, description, compute_status, app_status, url, active_deployment, create_time, creator, update_time, updater, pending_deployment, resources, service_principal_id, service_principal_name, default_source_code_path.
Documentation: https://docs.databricks.com/api/workspace/apps/list#apps.
-
Uses template:
- T_app_deployment
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: app_name, deployment_id, source_code_path, mode, deployment_artifacts, status, create_time, creator, update_time.
Documentation: https://docs.databricks.com/api/workspace/apps/listdeployments#app_deployments.
-
Uses template:
- T_endpoint
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, endpoint_type, creator, creation_timestamp, last_updated_timestamp, last_updated_user, id, endpoint_status, num_indexes.
Documentation: https://docs.databricks.com/api/workspace/vectorsearchendpoints/listendpoints#endpoints.
-
Uses template:
- T_index
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, endpoint_name, primary_key, index_type, creator, delta_sync_index_spec, direct_access_index_spec, status, fields.
Documentation: https://docs.databricks.com/api/workspace/vectorsearchindexes/listindexes#vector_indexes.
-
Uses template:
- T_account_access_control_proxy
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, principals, role, etag, grant_rules.
Documentation: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getassignablerolesforresource#roles.
-
Uses template:
- T_user
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, schemas, userName, emails, name, displayName, groups, roles, entitlements, externalId, active, Operations.
Documentation: https://docs.databricks.com/api/workspace/users/list#Resources.
-
Uses template:
- T_alert
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, update_mask, state, seconds_to_retrigger, owner_user_name, display_name, condition, query_id, lifecycle_state, update_time, create_time, custom_body, custom_subject, parent_path.
Documentation: https://docs.databricks.com/api/workspace/alerts/list#results.
-
Uses template:
- T_dashboard
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, slug, user_id, widgets, is_archived, is_draft, updated_at, created_at, can_edit, permission_tier, user, options, parent, name, run_as_role, tags, is_favorite, dashboard_filters_enabled.
Documentation: https://docs.databricks.com/api/workspace/dashboards/list#results.
-
Uses template:
- T_object_acl_permissions
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: object_id, object_type, access_control_list.
Documentation: https://docs.databricks.com/api/workspace/dbsqlpermissions/get#access_control_list.
-
Uses template:
- T_query_resource
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, update_mask, description, apply_auto_limit, schema, catalog, owner_user_name, tags, display_name, parent_path, lifecycle_state, last_modifier_user_name, query_text, parameters, update_time, warehouse_id, run_as_mode, create_time.
Documentation: https://docs.databricks.com/api/workspace/queries/list#results.
-
Uses template:
- T_query_history
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: query_id, status, query_text, query_start_time_ms, execution_end_time_ms, query_end_time_ms, user_id, user_name, spark_ui_url, endpoint_id, rows_produced, error_message, lookup_key, metrics, executed_as_user_id, executed_as_user_name, is_final, channel_used, plans_state, query_source, statement_type, warehouse_id, duration.
Documentation: https://docs.databricks.com/api/workspace/queryhistory/list#res.
-
Uses template:
- T_workspace_configuration
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: security_policy, data_access_config, instance_profile_arn, channel, global_param, config_param, sql_configuration_parameters, google_service_account, enabled_warehouse_types.
Documentation: https://docs.databricks.com/api/workspace/warehouses/getworkspacewarehouseconfig#sql_configuration_parameters.
-
Uses template:
- T_warehouse
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, cluster_size, min_num_clusters, max_num_clusters, auto_stop_mins, creator_name, instance_profile_arn, tags, spot_instance_policy, enable_photon, channel, enable_serverless_compute, warehouse_type, num_clusters, num_active_sessions, state, jdbc_url, odbc_params, health.
Documentation: https://docs.databricks.com/api/workspace/warehouses/list#warehouses.
-
Uses template:
- T_lakeview
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: dashboard_id, display_name, path, warehouse_id, etag, serialized_dashboard, embed_credentials, lifecycle_state, parent_path, revision_create_time, create_time, update_time.
Documentation: https://docs.databricks.com/api/workspace/lakeview/list#dashboards.
-
Uses template:
- T_catalog
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, owner, comment, properties, storage_root, provider_name, share_name, enable_predictive_optimization, metastore_id, created_at, created_by, updated_at, updated_by, catalog_type, storage_location, effective_predictive_optimization_flag, isolation_mode, connection_name, options, full_name, securable_kind, securable_type, provisioning_info, browse_only, new_name.
Documentation: https://docs.databricks.com/api/workspace/catalogs/list#catalogs.
-
Uses template:
- T_effective_predictive_optimization_flag
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: value, inherited_from_type, inherited_from_name.
Documentation: https://docs.databricks.com/api/workspace/catalogs/list#catalogs-effective_predictive_optimization_flag.
-
Uses template:
- T_connection
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, connection_type, options, owner, read_only, comment, properties, full_name, url, credential_type, connection_id, metastore_id, created_at, created_by, updated_at, updated_by, securable_kind, securable_type, provisioning_info, new_name.
Documentation: https://docs.databricks.com/api/workspace/connections/list#connections.
-
Uses template:
- T_external_location
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, url, credential_name, read_only, comment, owner, access_point, metastore_id, credential_id, created_at, created_by, updated_at, updated_by, browse_only, isolation_mode, new_name, skip_validation, force.
Documentation: https://docs.databricks.com/api/workspace/externallocations/list#external_locations.
-
Uses template:
- T_function
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, catalog_name, schema_name, input_params, data_type, full_data_type, return_params, routine_body, routine_definition, routine_dependencies, parameter_style, is_deterministic, sql_data_access, is_null_call, security_type, specific_name, external_name, external_language, sql_path, owner, comment, properties, metastore_id, full_name, created_at, created_by, updated_at, updated_by, function_id, browse_only.
Documentation: https://docs.databricks.com/api/workspace/functions/list#functions.
-
Uses template:
- T_grant
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: principal, privileges, add, remove.
Documentation: https://docs.databricks.com/api/workspace/grants/get#privilege_assignments.
-
Uses template:
- T_metastore
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: metastore_id, name, new_name, storage_root, default_data_access_config_id, storage_root_credential_id, delta_sharing_scope, delta_sharing_recipient_token_lifetime_in_seconds, delta_sharing_organization_name, owner, privilege_model_version, region, workspace_id, created_at, created_by, updated_at, updated_by, storage_root_credential_name, cloud, global_metastore_id.
Documentation: https://docs.databricks.com/api/workspace/metastores/list#metastores.
-
Uses template:
- T_metastore_assigment
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: metastore_id, workspace_id, default_catalog_name.
Documentation: https://docs.databricks.com/api/workspace/metastores/create.
-
Uses template:
- T_dependencies
Field components:
- Contains the following components: dependencies.
- T_model_registry_version
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: full_name, version, model_name, browse_only, catalog_name, schema_name, comment, source, run_id, run_workspace_id, model_version_dependencies, aliases, status, id, metastore_id, created_at, created_by, updated_at, updated_by, storage_location.
Documentation: https://docs.databricks.com/api/workspace/modelversions/list#model_versions.
-
Uses template:
- T_progress
Field components:
-
Uses template:
Long
. - Contains the following components: latest_version_currently_processing, synced_row_count, total_row_count, sync_progress_completion, estimated_completion_time_seconds.
-
Uses template:
- T_online_table
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, spec, status, table_serving_url.
Documentation: https://docs.databricks.com/api/workspace/onlinetables/get#status.
-
Uses template:
- T_quality_monitor
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: skip_builtin_dashboard, warehouse_id, assets_dir, output_schema_name, inference_log, time_series, snapshot, slicing_exprs, custom_metrics, baseline_table_name, schedule, notifications, table_name, status, latest_monitor_failure_msg, profile_metrics_table_name, drift_metrics_table_name, dashboard_id, monitor_version.
Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/get#custom_metrics.
-
Uses template:
- T_quality_monitor_refresh
-
Field components:
-
Uses template:
Long
. - Contains the following components: refresh_id, table_name, state, message, start_time_ms, end_time_ms, trigger.
Documentation: https://docs.databricks.com/api/workspace/qualitymonitors/get#inference_log.
-
Uses template:
- T_registered_model
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, new_name, catalog_name, schema_name, full_name, owner, id, metastore_id, created_at, created_by, updated_at, updated_by, storage_location, securable_type, securable_kind, comment, browse_only, aliases.
Documentation: https://docs.databricks.com/api/workspace/registeredmodels/list#registered_models.
-
Uses template:
- T_resource_quotas
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: parent_securable_type, parent_full_name, quota_name, quota_count, quota_limit, last_refreshed_at.
Documentation: https://docs.databricks.com/api/workspace/resourcequotas/listquotas#quotas.
-
Uses template:
- T_schema
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: full_name, name, catalog_name, owner, comment, properties, storage_root, enable_predictive_optimization, new_name, metastore_id, storage_location, created_at, created_by, updated_at, updated_by, catalog_type, effective_predictive_optimization_flag, browse_only, schema_id.
Documentation: https://docs.databricks.com/api/workspace/schemas/list#schemas.
-
Uses template:
- T_storage_credentials
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, full_name, aws_iam_role, databricks_gcp_service_account, azure_service_principal, azure_managed_identity, comment, read_only, skip_validation, owner, isolation_mode, new_name, force, id, metastore_id, created_at, created_by, updated_at, updated_by, used_for_managed_storage.
Documentation: https://docs.databricks.com/api/workspace/storagecredentials/list#storage_credentials.
-
Uses template:
- T_system_schema
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: schema, state, metastore_id, schema_name.
Documentation: https://docs.databricks.com/api/workspace/systemschemas/list#schemas.
-
Uses template:
- T_constraint
-
Field components:
- Contains the following components: primary_key_constraint, foreign_key_constraint, named_table_constraint.
Documentation: https://docs.databricks.com/api/workspace/tableconstraints/create#constraint.
- T_table_constraint
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: full_name_arg, constraint, full_name, constraint_name.
Documentation: https://docs.databricks.com/api/workspace/tableconstraints/create#primary_key_constraint.
-
Uses template:
- T_table
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: table_exists, name, catalog_name, schema_name, table_type, data_source_format, columns, storage_location, view_definition, view_dependencies, sql_path, owner, comment, properties, storage_credential_name, table_constraints, row_filter, enable_predictive_optimization, metastore_id, full_name, data_access_configuration_id, created_at, created_by, updated_at, updated_by, deleted_at, table_id, delta_runtime_properties_kvpairs, effective_predictive_optimization_flag, access_point, pipeline_id, browse_only.
Documentation: https://docs.databricks.com/api/workspace/tables/list#tables.
-
Uses template:
- T_volume
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, catalog_name, schema_name, volume_type, storage_location, comment, new_name, owner, full_name, volume_id, metastore_id, created_at, created_by, updated_at, updated_by, browse_only, access_point.
Documentation: https://docs.databricks.com/api/workspace/volumes/list#volumes.
-
Uses template:
- T_data_sharing_provider
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, authentication_type, recipient_profile_str, comment, owner, recipient_profile, created_at, created_by, updated_at, updated_by, cloud, region, metastore_id, data_provider_global_metastore_id.
Documentation: https://docs.databricks.com/api/workspace/providers/list#providers.
-
Uses template:
- T_recipient_activation
-
Field components:
-
Uses template:
Int
. - Contains the following components: shareCredentialsVersion, bearerToken, endpoint, expirationTime.
Documentation: https://docs.databricks.com/api/workspace/recipientactivation/retrievetoken.
-
Uses template:
- T_recipient
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, authentication_type, sharing_code, data_recipient_global_metastore_id, owner, comment, ip_access_list, properties_kvpairs, expiration_time, activation_url, activated, created_at, created_by, tokens, updated_at, updated_by, cloud, region, metastore_id, share_name, privilege_assignments.
Documentation: https://docs.databricks.com/api/workspace/recipients/list#recipients.
-
Uses template:
- T_data_object
-
Field components:
- An array.
- Contains the following components: name, comment, shared_as, string_shared_as, content, history_data_sharing_status, partitions, cdf_enabled, start_version, data_object_type, added_at, added_by, status.
Documentation: https://docs.databricks.com/api/workspace/shares/create#objects.
- T_shares
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, owner, comment, storage_root, new_name, objects, created_at, created_by, updated_at, updated_by, storage_location, updates, principal, privileges.
Documentation: https://docs.databricks.com/api/workspace/shares/list#shares.
-
Uses template:
- T_setting_automatic_cluster
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: field_mask, etag, setting_name, automatic_cluster_update_workspace.
Documentation: https://docs.databricks.com/api/workspace/automaticclusterupdate/get#automatic_cluster_update_workspace.
-
Uses template:
- T_setting_compliance_security_profile
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: field_mask, etag, setting_name, compliance_security_profile_workspace.
Documentation: https://docs.databricks.com/api/workspace/compliancesecurityprofile/get#compliance_security_profile_workspace.
-
Uses template:
- T_settings_default_namespace
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: field_mask, etag, setting_name, namespace.
Documentation: https://docs.databricks.com/api/workspace/defaultnamespace/get#namespace.
-
Uses template:
- T_setting_enchanced_security_monitoring
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: field_mask, etag, setting_name, enhanced_security_monitoring_workspace.
Documentation: https://docs.databricks.com/api/workspace/enhancedsecuritymonitoring/get#enhanced_security_monitoring_workspace.
-
Uses template:
- T_setting_restrict_workspace_admins
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: field_mask, etag, setting_name, restrict_workspace_admins.
Documentation: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/get#restrict_workspace_admins.
-
Uses template:
- T_ip_access_list
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: list_id, label, ip_addresses, list_type, address_count, created_at, created_by, updated_at, updated_by, enabled.
Documentation: https://docs.databricks.com/api/workspace/ipaccesslists/list#ip_access_lists.
-
Uses template:
- T_notification_destination
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, destination_type, display_name, config.
Documentation: https://docs.databricks.com/api/workspace/notificationdestinations/list#results.
-
Uses template:
- T_token_management
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: token_id, comment, application_id, lifetime_seconds, creation_time, expiry_time, created_by_id, created_by_username, owner_id, workspace_id.
Documentation: https://docs.databricks.com/api/workspace/tokenmanagement/list#token_infos.
-
Uses template:
- T_token
-
Field components:
-
Uses template:
Int
. - Contains the following components: lifetime_seconds, token_id, creation_time, expiry_time, comment.
Documentation: https://docs.databricks.com/api/workspace/tokens/listtokens#token_infos.
-
Uses template:
- T_consumer_fulfillment
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, data_object_type, listing_id, fulfillment_type, share_info, repo_info, recipient_type.
Documentation: https://docs.databricks.com/api/workspace/consumerfulfillments/list#fulfillments.
-
Uses template:
- T_consumer_installation
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, listing_id, share_name, catalog_name, installed_on, status, error_message, listing_name, repo_name, repo_path, recipient_type, tokens, token_detail, repo_detail, accepted_consumer_terms.
Documentation: https://docs.databricks.com/api/workspace/consumerinstallations/listlistinginstallations#installations.
-
Uses template:
- T_consumer_personalization_request
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, consumer_region, contact_info, comment, intended_use, status, status_message, share, created_at, listing_id, updated_at, metastore_id, listing_name, is_from_lighthouse, provider_id, recipient_type, first_name, last_name, company, accepted_consumer_terms.
Documentation: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/list#personalization_requests.
-
Uses template:
- T_consumer_provider
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, description, icon_file_path, business_contact_email, support_contact_email, is_featured, published_by, company_website_link, icon_file_id, term_of_service_link, privacy_policy_link, dark_mode_icon_file_id, dark_mode_icon_file_path.
Documentation: https://docs.databricks.com/api/workspace/consumerproviders/list#providers.
-
Uses template:
- T_provider_exchange_filters
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, exchange_id, filter_value, name, created_at, created_by, updated_at, updated_by, filter_type.
Documentation: https://docs.databricks.com/api/workspace/providerexchangefilters/list#filters.
-
Uses template:
- T_provider_exchange
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, comment, filters, created_at, created_by, updated_at, updated_by, linked_listings.
Documentation: https://docs.databricks.com/api/workspace/providerexchanges/list#exchanges.
-
Uses template:
- T_provider_exchange_for_listing
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, exchange_id, exchange_name, listing_id, listing_name, created_at, created_by.
Documentation: https://docs.databricks.com/api/workspace/providerexchanges/listexchangesforlisting#exchange_listing.
-
Uses template:
- T_provider_file
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, download_link, created_at, updated_at, status, status_message, file_parent, marketplace_file_type, mime_type, display_name.
Documentation: https://docs.databricks.com/api/workspace/providerfiles/list#file_infos.
-
Uses template:
- T_provider_consumer_listings
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, summary, detail.
Documentation: https://docs.databricks.com/api/workspace/providerlistings/list#listings.
-
Uses template:
- T_consumer_region
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: cloud, region.
Documentation: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/list#personalization_requests-consumer_region.
-
Uses template:
- T_contact_info
-
A read-only field. Field components:
-
Uses template:
ShortText
. - Contains the following components: first_name, last_name, email, company.
Documentation: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/list#personalization_requests-contact_info.
-
Uses template:
- T_provider_personalization_request
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, listing_id, consumer_region, contact_info, comment, reason, intended_use, status, status_message, share, created_at, updated_at, metastore_id, listing_name, is_from_lighthouse, provider_id, recipient_type.
Documentation: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/list#personalization_requests.
-
Uses template:
- T_provider_analytics_dashboard
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, version, dashboard_id.
Documentation: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/get.
-
Uses template:
- T_marketplace_provider
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, description, icon_file_path, business_contact_email, support_contact_email, is_featured, published_by, company_website_link, icon_file_id, term_of_service_link, privacy_policy_link, dark_mode_icon_file_id, dark_mode_icon_file_path.
Documentation: https://docs.databricks.com/api/workspace/providerproviders/list#providers.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.