App
An app that runs on Databricks Apps. The app runs on managed compute in the workspace and is deployed from a workspace folder or a Git repository. Each app acts as its own dedicated service principal.
App object
An app that runs on Databricks Apps. The app runs on managed compute in the workspace and is deployed from a workspace folder or a Git repository. Each app acts as its own dedicated service principal.
- namestring[ 2 .. 30 ] characters
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
- descriptionstring<= 500 characters
The description of the app.
- compute_statusobjectOutput only
Status of the compute that runs the app.
Show child attributesHide child attributes
- statestringOutput only
State of the app compute.
ERRORDELETINGSTARTINGSTOPPINGUPDATINGSTOPPEDACTIVE
- messagestringOutput only
Human-readable detail about the compute state.
- active_instancesint32Output only
The number of active compute instances currently used and billed for this application.
- app_statusobjectOutput only
Status of the application process on the app compute, as reported by the app runtime.
Show child attributesHide child attributes
- statestringOutput only
State of the application.
DEPLOYINGRUNNINGCRASHEDUNAVAILABLE
- messagestringOutput only
Human-readable detail about the application state.
- running_instancesint32Output only
The number of app instances whose application process is running.
- urlstringOutput only
The URL of the app once it is deployed.
- active_deploymentobjectOutput only
The active deployment of the app. A deployment is considered active when it has been deployed to the app compute.
Show child attributesHide child attributes
- deployment_idstring
The unique id of the deployment.
- source_code_pathstring
The workspace file system path of the source code used to create the app deployment. This is different from
deployment_artifacts.source_code_path, which is the path used by the deployed app. The former refers to the original source code location of the app in the workspace during deployment creation, whereas the latter provides a system generated stable snapshotted source code path used by the deployment.
- git_sourceobject
Git repository to use as the source for the app deployment.
Show child attributesHide child attributes
- git_repositoryobjectOutput only
Git repository configuration. Populated from the app's git_repository configuration.
Show child attributesHide child attributes
- urlstring<= 300 characters
URL of the Git repository.
- providerstring
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
- resolved_commitstring<= 64 charactersOutput only
The resolved commit SHA that was actually used for the deployment. This is populated by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch or tag pointed to at deployment time.
- modestring
The mode of which the deployment will manage the source code.
SNAPSHOTAUTO_SYNC
- deployment_artifactsobjectOutput only
The deployment artifacts for an app.
Show child attributesHide child attributes
- source_code_pathstring
The snapshotted workspace file system path of the source code loaded by the deployed app.
- statusobjectOutput only
Status and status message of the deployment
Show child attributesHide child attributes
- statestringOutput only
State of the deployment.
SUCCEEDEDFAILEDIN_PROGRESSCANCELLED
- messagestringOutput only
Message corresponding with the deployment state.
- create_timestringOutput only
The creation time of the deployment. Formatted timestamp in ISO 6801.
- creatorstringOutput only
The email of the user creates the deployment.
- update_timestringOutput only
The update time of the deployment. Formatted timestamp in ISO 6801.
- commandarray of string
The command with which to run the app. This will override the command specified in the app.yaml file.
- env_varsarray of object
The environment variables to set in the app runtime environment. This will override the environment variables specified in the app.yaml file.
Show child attributesHide child attributes
- namestring
The name of the environment variable.
- valuestring
The value for the environment variable.
- value_fromstring
The name of an external <Databricks> resource that contains the value, such as a secret or a database table.
- scan_statusstringBetaOutput only
The security scan outcome for this deployment. UNSPECIFIED means no scan result has been recorded: the scan may still be in flight, or it ended without recording one, so don't wait indefinitely for it to change. The other values are terminal.
APP_DEPLOYMENT_SCAN_STATUS_CLEANAPP_DEPLOYMENT_SCAN_STATUS_FINDINGSAPP_DEPLOYMENT_SCAN_STATUS_PARTIALAPP_DEPLOYMENT_SCAN_STATUS_UNAVAILABLEAPP_DEPLOYMENT_SCAN_STATUS_NOT_SCANNED
- scan_omitted_findings_countint32BetaOutput only
The number of findings the scan reported but did not store, because the deployment hit the per-deployment findings cap. Non-zero means the listed findings are incomplete.
- scan_omitted_count_is_lower_boundbooleanBetaOutput only
Whether
scan_omitted_findings_countis a lower bound rather than an exact count, because the scanner itself stopped counting.
- create_timestringOutput only
The creation time of the app. Formatted timestamp in ISO 8601.
- creatorstringOutput only
The email of the user that created the app.
- update_timestringOutput only
The update time of the app. Formatted timestamp in ISO 8601.
- updaterstringOutput only
The email of the user that last updated the app.
- pending_deploymentobjectOutput only
The pending deployment of the app. A deployment is considered pending when it is being prepared for deployment to the app compute.
Show child attributesHide child attributes
- deployment_idstring
The unique id of the deployment.
- source_code_pathstring
The workspace file system path of the source code used to create the app deployment. This is different from
deployment_artifacts.source_code_path, which is the path used by the deployed app. The former refers to the original source code location of the app in the workspace during deployment creation, whereas the latter provides a system generated stable snapshotted source code path used by the deployment.
- git_sourceobject
Git repository to use as the source for the app deployment.
Show child attributesHide child attributes
- git_repositoryobjectOutput only
Git repository configuration. Populated from the app's git_repository configuration.
Show child attributesHide child attributes
- urlstring<= 300 characters
URL of the Git repository.
- providerstring
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
- resolved_commitstring<= 64 charactersOutput only
The resolved commit SHA that was actually used for the deployment. This is populated by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch or tag pointed to at deployment time.
- modestring
The mode of which the deployment will manage the source code.
SNAPSHOTAUTO_SYNC
- deployment_artifactsobjectOutput only
The deployment artifacts for an app.
Show child attributesHide child attributes
- source_code_pathstring
The snapshotted workspace file system path of the source code loaded by the deployed app.
- statusobjectOutput only
Status and status message of the deployment
Show child attributesHide child attributes
- statestringOutput only
State of the deployment.
SUCCEEDEDFAILEDIN_PROGRESSCANCELLED
- messagestringOutput only
Message corresponding with the deployment state.
- create_timestringOutput only
The creation time of the deployment. Formatted timestamp in ISO 6801.
- creatorstringOutput only
The email of the user creates the deployment.
- update_timestringOutput only
The update time of the deployment. Formatted timestamp in ISO 6801.
- commandarray of string
The command with which to run the app. This will override the command specified in the app.yaml file.
- env_varsarray of object
The environment variables to set in the app runtime environment. This will override the environment variables specified in the app.yaml file.
Show child attributesHide child attributes
- namestring
The name of the environment variable.
- valuestring
The value for the environment variable.
- value_fromstring
The name of an external <Databricks> resource that contains the value, such as a secret or a database table.
- scan_statusstringBetaOutput only
The security scan outcome for this deployment. UNSPECIFIED means no scan result has been recorded: the scan may still be in flight, or it ended without recording one, so don't wait indefinitely for it to change. The other values are terminal.
APP_DEPLOYMENT_SCAN_STATUS_CLEANAPP_DEPLOYMENT_SCAN_STATUS_FINDINGSAPP_DEPLOYMENT_SCAN_STATUS_PARTIALAPP_DEPLOYMENT_SCAN_STATUS_UNAVAILABLEAPP_DEPLOYMENT_SCAN_STATUS_NOT_SCANNED
- scan_omitted_findings_countint32BetaOutput only
The number of findings the scan reported but did not store, because the deployment hit the per-deployment findings cap. Non-zero means the listed findings are incomplete.
- scan_omitted_count_is_lower_boundbooleanBetaOutput only
Whether
scan_omitted_findings_countis a lower bound rather than an exact count, because the scanner itself stopped counting.
- resourcesarray of object
Databricks resources the app depends on. Each entry grants the app's service principal the listed permission on one resource and makes that resource available to the app under the entry's name.
Show child attributesHide child attributes
- namestring[ 2 .. 30 ] characters
Key that identifies the resource within the app. The app configuration (app.yaml) references the resource by this key.
- descriptionstring<= 50 characters
Description of the App Resource.
- secretobject
Secret the app is granted access to.
Show child attributesHide child attributes
- scopestring
Scope of the secret to grant permission on.
- keystring
Key of the secret to grant permission on.
- permissionstring
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE".
READWRITEMANAGE
- sql_warehouseobject
SQL warehouse the app is granted access to.
Show child attributesHide child attributes
- idstring
Id of the SQL warehouse to grant permission on.
- permissionstring
Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER".
CAN_MANAGECAN_USEIS_OWNER
- serving_endpointobject
Model serving endpoint the app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the serving endpoint to grant permission on.
- permissionstring
Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW".
CAN_MANAGECAN_QUERYCAN_VIEW
- jobobject
Lakeflow job the app is granted access to.
Show child attributesHide child attributes
- idstring
Id of the job to grant permission on.
- permissionstring
Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW".
CAN_MANAGEIS_OWNERCAN_MANAGE_RUNCAN_VIEW
- uc_securableobject
Unity Catalog securable (volume, table, function, connection or model service) the app is granted a privilege on.
Show child attributesHide child attributes
- securable_full_namestring
Full name of the Unity Catalog securable. For volumes, tables and functions this is the three-level catalog.schema.object name.
- securable_typestring
Kind of Unity Catalog securable that
securable_full_namerefers to.VOLUMETABLEFUNCTIONCONNECTIONMODEL_SERVICE
- permissionstring
Privilege to grant the app on the securable. The privilege must be valid for the securable type, such as READ_VOLUME for a volume or SELECT for a table.
READ_VOLUMEWRITE_VOLUMESELECTEXECUTEUSE_CONNECTIONMODIFY
- securable_kindstringOutput only
The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind.
- databaseobject
Lakebase Provisioned database the app is granted access to.
Show child attributesHide child attributes
- instance_namestring
Name of the Lakebase database instance.
- database_namestring
Name of the database within the instance.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- genie_spaceobject
Genie space the app is granted access to.
Show child attributesHide child attributes
- namestring
- space_idstring
ID of the Genie space.
- permissionstring
Permission to grant the app on the Genie space.
CAN_MANAGECAN_EDITCAN_RUNCAN_VIEW
- experimentobject
MLflow experiment the app is granted access to.
Show child attributesHide child attributes
- experiment_idstring
ID of the MLflow experiment.
- permissionstring
Permission to grant the app on the experiment.
CAN_MANAGECAN_EDITCAN_READ
- appobject
Another app in the workspace that this app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the app to grant access to.
- permissionstring
Permission to grant on that app.
CAN_USE
- postgresobject
Lakebase Autoscaling Postgres database the app is granted access to.
Show child attributesHide child attributes
- branchstring
Resource name of the Lakebase Autoscaling branch, in the form
projects/{project}/branches/{branch}.
- databasestring
Resource name of the database within the branch, in the form
projects/{project}/branches/{branch}/databases/{database}.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- service_principal_idint64Output only
Numeric ID of the service principal the app runs as. Databricks creates a dedicated service principal for each app and deletes it with the app. Apps in some older spaces run as the space's shared service principal instead.
- service_principal_namestringOutput only
Display name of the app's service principal.
- default_source_code_pathstringOutput only
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
- default_git_sourceobjectOutput only
The Git source of the app's most recent active deployment, including the repository configuration and the resolved reference. Populated by the system after a Git-based deployment and used as the default reference when automatic deployments are enabled.
Show child attributesHide child attributes
- git_repositoryobjectOutput only
Git repository configuration. Populated from the app's git_repository configuration.
Show child attributesHide child attributes
- urlstring<= 300 characters
URL of the Git repository.
- providerstring
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
- resolved_commitstring<= 64 charactersOutput only
The resolved commit SHA that was actually used for the deployment. This is populated by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch or tag pointed to at deployment time.
- budget_policy_idstringuuid= 36 charactersPublic Preview
ID of the serverless budget policy that the app's compute usage is attributed to. Budget policies and usage policies are alternatives: set at most one of
budget_policy_idandusage_policy_id.
- effective_budget_policy_idstringuuidPublic PreviewOutput only
ID of the budget policy in effect for the app, after Databricks applies any defaults.
- service_principal_client_idstringuuidOutput only
OAuth client ID of the app's service principal. The app runtime exposes it to the app as the DATABRICKS_CLIENT_ID environment variable.
- user_api_scopesarray of stringPublic Preview
API scopes the app requests for user authorization. The user access token that Databricks forwards to the app is limited to these scopes plus the default identity scopes, so the app can act on the user's behalf only within them. Workspace admins can restrict which scopes apps in the workspace may request. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/auth.
- idstringOutput only
The unique identifier of the app.
- effective_user_api_scopesarray of stringPublic PreviewOutput only
The effective api scopes granted to the user access token.
- oauth2_app_integration_idstringPublic PreviewOutput only
ID of the OAuth app integration that Databricks creates for the app to sign in its users.
- oauth2_app_client_idstringPublic PreviewOutput only
OAuth client ID of the app integration that signs in the app's users.
- compute_sizestring
Size of the compute instances the app runs on. Defaults to MEDIUM. Larger sizes provide more CPU and memory at a higher hourly cost. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/compute-size.
MEDIUMLARGEXLARGE
- usage_policy_idstringuuid= 36 charactersPublic Preview
ID of the usage policy that the app's compute usage is attributed to. Alternative to
budget_policy_id.
- effective_usage_policy_idstringuuidPublic PreviewOutput only
ID of the usage policy in effect for the app, after Databricks applies any defaults.
- compute_min_instancesint32
Minimum number of app instances the app is configured to run. Must be set together with
compute_max_instances.
- compute_max_instancesint32
Maximum number of app instances the app is configured to run. Must be set together with
compute_min_instances.
- git_repositoryobject
Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).
Show child attributesHide child attributes
- urlstring<= 300 characters
URL of the Git repository.
- providerstring
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- telemetry_export_destinationsarray of object
Destinations that receive the app's OpenTelemetry logs, metrics and traces. Changes take effect when the app is next deployed.
Show child attributesHide child attributes
- unity_catalogobject
Unity Catalog tables that receive the telemetry.
Show child attributesHide child attributes
- logs_tablestring
Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is created if it does not exist.
- metrics_tablestring
Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is created if it does not exist.
- traces_tablestring
Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The table is created if it does not exist.
- thumbnail_urlstringOutput only
The URL of the thumbnail image for the app.
- spacestring[ 2 .. 30 ] charactersBeta
Name of the space this app belongs to.
- source_code_pathstringInput only
Workspace file system path of the app source code. On create, the app is deployed from this path. Alternative to
git_source.
- git_sourceobjectInput only
The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) and an optional path to the app source code within the repository configured in git_repository.
Show child attributesHide child attributes
- git_repositoryobjectOutput only
Git repository configuration. Populated from the app's git_repository configuration.
Show child attributesHide child attributes
- urlstring<= 300 characters
URL of the Git repository.
- providerstring
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
- resolved_commitstring<= 64 charactersOutput only
The resolved commit SHA that was actually used for the deployment. This is populated by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch or tag pointed to at deployment time.
Get an app GA
GET
Retrieves information for the app with the supplied name.
API scopes: apps
Parameters
- namestringRequiredpath
The name of the app.
Response
Returns the App object.
List apps GA
GET
Lists all apps in the workspace.
API scopes: apps
Parameters
- page_tokenstringquery
Pagination token to go to the next page of apps. Requests first page if absent.
- page_sizeint32query
Upper bound for items returned.
Response
Returns a list of App objects.
Create an app GA
POST
Creates a new app.
API scopes: apps
Parameters
- no_computebooleanquery
If true, the app will not be started after creation.
Request body
- namestring[ 2 .. 30 ] charactersRequired
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
- descriptionstring<= 500 characters
The description of the app.
- resourcesarray of object
Databricks resources the app depends on. Each entry grants the app's service principal the listed permission on one resource and makes that resource available to the app under the entry's name.
Show child attributesHide child attributes
- namestring[ 2 .. 30 ] charactersRequired
Key that identifies the resource within the app. The app configuration (app.yaml) references the resource by this key.
- descriptionstring<= 50 characters
Description of the App Resource.
- secretobject
Secret the app is granted access to.
Show child attributesHide child attributes
- scopestringRequired
Scope of the secret to grant permission on.
- keystringRequired
Key of the secret to grant permission on.
- permissionstringRequired
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE".
READWRITEMANAGE
- sql_warehouseobject
SQL warehouse the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the SQL warehouse to grant permission on.
- permissionstringRequired
Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER".
CAN_MANAGECAN_USEIS_OWNER
- serving_endpointobject
Model serving endpoint the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
Name of the serving endpoint to grant permission on.
- permissionstringRequired
Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW".
CAN_MANAGECAN_QUERYCAN_VIEW
- jobobject
Lakeflow job the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the job to grant permission on.
- permissionstringRequired
Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW".
CAN_MANAGEIS_OWNERCAN_MANAGE_RUNCAN_VIEW
- uc_securableobject
Unity Catalog securable (volume, table, function, connection or model service) the app is granted a privilege on.
Show child attributesHide child attributes
- securable_full_namestringRequired
Full name of the Unity Catalog securable. For volumes, tables and functions this is the three-level catalog.schema.object name.
- securable_typestringRequired
Kind of Unity Catalog securable that
securable_full_namerefers to.VOLUMETABLEFUNCTIONCONNECTIONMODEL_SERVICE
- permissionstringRequired
Privilege to grant the app on the securable. The privilege must be valid for the securable type, such as READ_VOLUME for a volume or SELECT for a table.
READ_VOLUMEWRITE_VOLUMESELECTEXECUTEUSE_CONNECTIONMODIFY
- databaseobject
Lakebase Provisioned database the app is granted access to.
Show child attributesHide child attributes
- instance_namestringRequired
Name of the Lakebase database instance.
- database_namestringRequired
Name of the database within the instance.
- permissionstringRequired
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- genie_spaceobject
Genie space the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
- space_idstringRequired
ID of the Genie space.
- permissionstringRequired
Permission to grant the app on the Genie space.
CAN_MANAGECAN_EDITCAN_RUNCAN_VIEW
- experimentobject
MLflow experiment the app is granted access to.
Show child attributesHide child attributes
- experiment_idstringRequired
ID of the MLflow experiment.
- permissionstringRequired
Permission to grant the app on the experiment.
CAN_MANAGECAN_EDITCAN_READ
- appobject
Another app in the workspace that this app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the app to grant access to.
- permissionstring
Permission to grant on that app.
CAN_USE
- postgresobject
Lakebase Autoscaling Postgres database the app is granted access to.
Show child attributesHide child attributes
- branchstring
Resource name of the Lakebase Autoscaling branch, in the form
projects/{project}/branches/{branch}.
- databasestring
Resource name of the database within the branch, in the form
projects/{project}/branches/{branch}/databases/{database}.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- budget_policy_idstringuuid= 36 charactersPublic Preview
ID of the serverless budget policy that the app's compute usage is attributed to. Budget policies and usage policies are alternatives: set at most one of
budget_policy_idandusage_policy_id.
- user_api_scopesarray of stringPublic Preview
API scopes the app requests for user authorization. The user access token that Databricks forwards to the app is limited to these scopes plus the default identity scopes, so the app can act on the user's behalf only within them. Workspace admins can restrict which scopes apps in the workspace may request. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/auth.
- compute_sizestring
Size of the compute instances the app runs on. Defaults to MEDIUM. Larger sizes provide more CPU and memory at a higher hourly cost. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/compute-size.
MEDIUMLARGEXLARGE
- usage_policy_idstringuuid= 36 charactersPublic Preview
ID of the usage policy that the app's compute usage is attributed to. Alternative to
budget_policy_id.
- compute_min_instancesint32
Minimum number of app instances the app is configured to run. Must be set together with
compute_max_instances.
- compute_max_instancesint32
Maximum number of app instances the app is configured to run. Must be set together with
compute_min_instances.
- git_repositoryobject
Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).
Show child attributesHide child attributes
- urlstring<= 300 charactersRequired
URL of the Git repository.
- providerstringRequired
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- telemetry_export_destinationsarray of object
Destinations that receive the app's OpenTelemetry logs, metrics and traces. Changes take effect when the app is next deployed.
Show child attributesHide child attributes
- unity_catalogobject
Unity Catalog tables that receive the telemetry.
Show child attributesHide child attributes
- logs_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is created if it does not exist.
- metrics_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is created if it does not exist.
- traces_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The table is created if it does not exist.
- spacestring[ 2 .. 30 ] charactersBeta
Name of the space this app belongs to.
- source_code_pathstringInput only
Workspace file system path of the app source code. On create, the app is deployed from this path. Alternative to
git_source.
- git_sourceobjectInput only
The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) and an optional path to the app source code within the repository configured in git_repository.
Show child attributesHide child attributes
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
Response
Returns the App object.
Update an app GA
PATCH
Updates the app with the supplied name. This is a full replacement: fields omitted from the request are cleared, so send the complete app.
API scopes: apps
Parameters
- namestring[ 2 .. 30 ] charactersRequiredpath
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
Request body
- descriptionstring<= 500 characters
The description of the app.
- resourcesarray of object
Databricks resources the app depends on. Each entry grants the app's service principal the listed permission on one resource and makes that resource available to the app under the entry's name.
Show child attributesHide child attributes
- namestring[ 2 .. 30 ] charactersRequired
Key that identifies the resource within the app. The app configuration (app.yaml) references the resource by this key.
- descriptionstring<= 50 characters
Description of the App Resource.
- secretobject
Secret the app is granted access to.
Show child attributesHide child attributes
- scopestringRequired
Scope of the secret to grant permission on.
- keystringRequired
Key of the secret to grant permission on.
- permissionstringRequired
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE".
READWRITEMANAGE
- sql_warehouseobject
SQL warehouse the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the SQL warehouse to grant permission on.
- permissionstringRequired
Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER".
CAN_MANAGECAN_USEIS_OWNER
- serving_endpointobject
Model serving endpoint the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
Name of the serving endpoint to grant permission on.
- permissionstringRequired
Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW".
CAN_MANAGECAN_QUERYCAN_VIEW
- jobobject
Lakeflow job the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the job to grant permission on.
- permissionstringRequired
Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW".
CAN_MANAGEIS_OWNERCAN_MANAGE_RUNCAN_VIEW
- uc_securableobject
Unity Catalog securable (volume, table, function, connection or model service) the app is granted a privilege on.
Show child attributesHide child attributes
- securable_full_namestringRequired
Full name of the Unity Catalog securable. For volumes, tables and functions this is the three-level catalog.schema.object name.
- securable_typestringRequired
Kind of Unity Catalog securable that
securable_full_namerefers to.VOLUMETABLEFUNCTIONCONNECTIONMODEL_SERVICE
- permissionstringRequired
Privilege to grant the app on the securable. The privilege must be valid for the securable type, such as READ_VOLUME for a volume or SELECT for a table.
READ_VOLUMEWRITE_VOLUMESELECTEXECUTEUSE_CONNECTIONMODIFY
- databaseobject
Lakebase Provisioned database the app is granted access to.
Show child attributesHide child attributes
- instance_namestringRequired
Name of the Lakebase database instance.
- database_namestringRequired
Name of the database within the instance.
- permissionstringRequired
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- genie_spaceobject
Genie space the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
- space_idstringRequired
ID of the Genie space.
- permissionstringRequired
Permission to grant the app on the Genie space.
CAN_MANAGECAN_EDITCAN_RUNCAN_VIEW
- experimentobject
MLflow experiment the app is granted access to.
Show child attributesHide child attributes
- experiment_idstringRequired
ID of the MLflow experiment.
- permissionstringRequired
Permission to grant the app on the experiment.
CAN_MANAGECAN_EDITCAN_READ
- appobject
Another app in the workspace that this app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the app to grant access to.
- permissionstring
Permission to grant on that app.
CAN_USE
- postgresobject
Lakebase Autoscaling Postgres database the app is granted access to.
Show child attributesHide child attributes
- branchstring
Resource name of the Lakebase Autoscaling branch, in the form
projects/{project}/branches/{branch}.
- databasestring
Resource name of the database within the branch, in the form
projects/{project}/branches/{branch}/databases/{database}.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- budget_policy_idstringuuid= 36 charactersPublic Preview
ID of the serverless budget policy that the app's compute usage is attributed to. Budget policies and usage policies are alternatives: set at most one of
budget_policy_idandusage_policy_id.
- user_api_scopesarray of stringPublic Preview
API scopes the app requests for user authorization. The user access token that Databricks forwards to the app is limited to these scopes plus the default identity scopes, so the app can act on the user's behalf only within them. Workspace admins can restrict which scopes apps in the workspace may request. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/auth.
- compute_sizestring
Size of the compute instances the app runs on. Defaults to MEDIUM. Larger sizes provide more CPU and memory at a higher hourly cost. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/compute-size.
MEDIUMLARGEXLARGE
- usage_policy_idstringuuid= 36 charactersPublic Preview
ID of the usage policy that the app's compute usage is attributed to. Alternative to
budget_policy_id.
- compute_min_instancesint32
Minimum number of app instances the app is configured to run. Must be set together with
compute_max_instances.
- compute_max_instancesint32
Maximum number of app instances the app is configured to run. Must be set together with
compute_min_instances.
- git_repositoryobject
Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).
Show child attributesHide child attributes
- urlstring<= 300 charactersRequired
URL of the Git repository.
- providerstringRequired
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- telemetry_export_destinationsarray of object
Destinations that receive the app's OpenTelemetry logs, metrics and traces. Changes take effect when the app is next deployed.
Show child attributesHide child attributes
- unity_catalogobject
Unity Catalog tables that receive the telemetry.
Show child attributesHide child attributes
- logs_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is created if it does not exist.
- metrics_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is created if it does not exist.
- traces_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The table is created if it does not exist.
- spacestring[ 2 .. 30 ] charactersBeta
Name of the space this app belongs to.
- source_code_pathstringInput only
Workspace file system path of the app source code. On create, the app is deployed from this path. Alternative to
git_source.
- git_sourceobjectInput only
The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) and an optional path to the app source code within the repository configured in git_repository.
Show child attributesHide child attributes
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
Response
Returns the App object.
Delete an app GA
DELETE
Deletes an app and the dedicated service principal created for it.
API scopes: apps
Parameters
- namestringRequiredpath
The name of the app.
Response
Returns the App object.
Create an app update GA
POST
Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method.
API scopes: apps
Parameters
- app_namestringRequiredpath
The name of the app to update.
Request body
- appobject
The new values for the app. Only the fields named in
update_maskare applied; the others must still be valid.Show child attributesHide child attributes
- namestring[ 2 .. 30 ] charactersRequired
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
- descriptionstring<= 500 characters
The description of the app.
- resourcesarray of object
Databricks resources the app depends on. Each entry grants the app's service principal the listed permission on one resource and makes that resource available to the app under the entry's name.
Show child attributesHide child attributes
- namestring[ 2 .. 30 ] charactersRequired
Key that identifies the resource within the app. The app configuration (app.yaml) references the resource by this key.
- descriptionstring<= 50 characters
Description of the App Resource.
- secretobject
Secret the app is granted access to.
Show child attributesHide child attributes
- scopestringRequired
Scope of the secret to grant permission on.
- keystringRequired
Key of the secret to grant permission on.
- permissionstringRequired
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE".
READWRITEMANAGE
- sql_warehouseobject
SQL warehouse the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the SQL warehouse to grant permission on.
- permissionstringRequired
Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER".
CAN_MANAGECAN_USEIS_OWNER
- serving_endpointobject
Model serving endpoint the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
Name of the serving endpoint to grant permission on.
- permissionstringRequired
Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW".
CAN_MANAGECAN_QUERYCAN_VIEW
- jobobject
Lakeflow job the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the job to grant permission on.
- permissionstringRequired
Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW".
CAN_MANAGEIS_OWNERCAN_MANAGE_RUNCAN_VIEW
- uc_securableobject
Unity Catalog securable (volume, table, function, connection or model service) the app is granted a privilege on.
Show child attributesHide child attributes
- securable_full_namestringRequired
Full name of the Unity Catalog securable. For volumes, tables and functions this is the three-level catalog.schema.object name.
- securable_typestringRequired
Kind of Unity Catalog securable that
securable_full_namerefers to.VOLUMETABLEFUNCTIONCONNECTIONMODEL_SERVICE
- permissionstringRequired
Privilege to grant the app on the securable. The privilege must be valid for the securable type, such as READ_VOLUME for a volume or SELECT for a table.
READ_VOLUMEWRITE_VOLUMESELECTEXECUTEUSE_CONNECTIONMODIFY
- databaseobject
Lakebase Provisioned database the app is granted access to.
Show child attributesHide child attributes
- instance_namestringRequired
Name of the Lakebase database instance.
- database_namestringRequired
Name of the database within the instance.
- permissionstringRequired
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- genie_spaceobject
Genie space the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
- space_idstringRequired
ID of the Genie space.
- permissionstringRequired
Permission to grant the app on the Genie space.
CAN_MANAGECAN_EDITCAN_RUNCAN_VIEW
- experimentobject
MLflow experiment the app is granted access to.
Show child attributesHide child attributes
- experiment_idstringRequired
ID of the MLflow experiment.
- permissionstringRequired
Permission to grant the app on the experiment.
CAN_MANAGECAN_EDITCAN_READ
- appobject
Another app in the workspace that this app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the app to grant access to.
- permissionstring
Permission to grant on that app.
CAN_USE
- postgresobject
Lakebase Autoscaling Postgres database the app is granted access to.
Show child attributesHide child attributes
- branchstring
Resource name of the Lakebase Autoscaling branch, in the form
projects/{project}/branches/{branch}.
- databasestring
Resource name of the database within the branch, in the form
projects/{project}/branches/{branch}/databases/{database}.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- budget_policy_idstringuuid= 36 charactersPublic Preview
ID of the serverless budget policy that the app's compute usage is attributed to. Budget policies and usage policies are alternatives: set at most one of
budget_policy_idandusage_policy_id.
- user_api_scopesarray of stringPublic Preview
API scopes the app requests for user authorization. The user access token that Databricks forwards to the app is limited to these scopes plus the default identity scopes, so the app can act on the user's behalf only within them. Workspace admins can restrict which scopes apps in the workspace may request. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/auth.
- compute_sizestring
Size of the compute instances the app runs on. Defaults to MEDIUM. Larger sizes provide more CPU and memory at a higher hourly cost. See https://docs.databricks.com/aws/en/dev-tools/databricks-apps/compute-size.
MEDIUMLARGEXLARGE
- usage_policy_idstringuuid= 36 charactersPublic Preview
ID of the usage policy that the app's compute usage is attributed to. Alternative to
budget_policy_id.
- compute_min_instancesint32
Minimum number of app instances the app is configured to run. Must be set together with
compute_max_instances.
- compute_max_instancesint32
Maximum number of app instances the app is configured to run. Must be set together with
compute_min_instances.
- git_repositoryobject
Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).
Show child attributesHide child attributes
- urlstring<= 300 charactersRequired
URL of the Git repository.
- providerstringRequired
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- caller_credential_idint64Input only
ID of a personal access token Git credential owned by the caller, used to grant the app's service principal access to this repository.
- telemetry_export_destinationsarray of object
Destinations that receive the app's OpenTelemetry logs, metrics and traces. Changes take effect when the app is next deployed.
Show child attributesHide child attributes
- unity_catalogobject
Unity Catalog tables that receive the telemetry.
Show child attributesHide child attributes
- logs_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is created if it does not exist.
- metrics_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is created if it does not exist.
- traces_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The table is created if it does not exist.
- spacestring[ 2 .. 30 ] charactersBeta
Name of the space this app belongs to.
- source_code_pathstringInput only
Workspace file system path of the app source code. On create, the app is deployed from this path. Alternative to
git_source.
- git_sourceobjectInput only
The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) and an optional path to the app source code within the repository configured in git_repository.
Show child attributesHide child attributes
- branchstring<= 255 characters
Git branch to checkout.
- tagstring<= 255 characters
Git tag to checkout.
- commitstring<= 64 characters
Git commit SHA to checkout.
- source_code_pathstring<= 500 characters
Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.
- update_maskstringRequired
Comma-separated names of the
appfields to update, such asdescriptionorresources. A field named in the mask but absent fromappis cleared, exceptcompute_size, which resets toMEDIUM.
Response
- statusobjectOutput only
Progress of the update.
Show child attributesHide child attributes
- statestringOutput only
State of the update.
NOT_UPDATEDIN_PROGRESSSUCCEEDEDFAILED
- messagestringOutput only
Human-readable detail about the update state.
- descriptionstring
Description requested by the update.
- budget_policy_idstring
Budget policy ID requested by the update.
- resourcesarray of object
Resources requested by the update.
Show child attributesHide child attributes
- namestring[ 2 .. 30 ] charactersRequired
Key that identifies the resource within the app. The app configuration (app.yaml) references the resource by this key.
- descriptionstring<= 50 characters
Description of the App Resource.
- secretobject
Secret the app is granted access to.
Show child attributesHide child attributes
- scopestringRequired
Scope of the secret to grant permission on.
- keystringRequired
Key of the secret to grant permission on.
- permissionstringRequired
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE".
READWRITEMANAGE
- sql_warehouseobject
SQL warehouse the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the SQL warehouse to grant permission on.
- permissionstringRequired
Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER".
CAN_MANAGECAN_USEIS_OWNER
- serving_endpointobject
Model serving endpoint the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
Name of the serving endpoint to grant permission on.
- permissionstringRequired
Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW".
CAN_MANAGECAN_QUERYCAN_VIEW
- jobobject
Lakeflow job the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the job to grant permission on.
- permissionstringRequired
Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW".
CAN_MANAGEIS_OWNERCAN_MANAGE_RUNCAN_VIEW
- uc_securableobject
Unity Catalog securable (volume, table, function, connection or model service) the app is granted a privilege on.
Show child attributesHide child attributes
- securable_full_namestringRequired
Full name of the Unity Catalog securable. For volumes, tables and functions this is the three-level catalog.schema.object name.
- securable_typestringRequired
Kind of Unity Catalog securable that
securable_full_namerefers to.VOLUMETABLEFUNCTIONCONNECTIONMODEL_SERVICE
- permissionstringRequired
Privilege to grant the app on the securable. The privilege must be valid for the securable type, such as READ_VOLUME for a volume or SELECT for a table.
READ_VOLUMEWRITE_VOLUMESELECTEXECUTEUSE_CONNECTIONMODIFY
- securable_kindstringOutput only
The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind.
- databaseobject
Lakebase Provisioned database the app is granted access to.
Show child attributesHide child attributes
- instance_namestringRequired
Name of the Lakebase database instance.
- database_namestringRequired
Name of the database within the instance.
- permissionstringRequired
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- genie_spaceobject
Genie space the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
- space_idstringRequired
ID of the Genie space.
- permissionstringRequired
Permission to grant the app on the Genie space.
CAN_MANAGECAN_EDITCAN_RUNCAN_VIEW
- experimentobject
MLflow experiment the app is granted access to.
Show child attributesHide child attributes
- experiment_idstringRequired
ID of the MLflow experiment.
- permissionstringRequired
Permission to grant the app on the experiment.
CAN_MANAGECAN_EDITCAN_READ
- appobject
Another app in the workspace that this app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the app to grant access to.
- permissionstring
Permission to grant on that app.
CAN_USE
- postgresobject
Lakebase Autoscaling Postgres database the app is granted access to.
Show child attributesHide child attributes
- branchstring
Resource name of the Lakebase Autoscaling branch, in the form
projects/{project}/branches/{branch}.
- databasestring
Resource name of the database within the branch, in the form
projects/{project}/branches/{branch}/databases/{database}.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- user_api_scopesarray of string
User API scopes requested by the update.
- compute_sizestring
Compute size requested by the update.
MEDIUMLARGEXLARGE
- usage_policy_idstring
Usage policy ID requested by the update.
- compute_min_instancesint32
Minimum number of app instances the app is configured to run. Must be set together with
compute_max_instances.
- compute_max_instancesint32
Maximum number of app instances the app is configured to run. Must be set together with
compute_min_instances.
- git_repositoryobject
Git repository configuration requested by the update.
Show child attributesHide child attributes
- urlstring<= 300 charactersRequired
URL of the Git repository.
- providerstringRequired
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- telemetry_export_destinationsarray of object
Telemetry export destinations requested by the update.
Show child attributesHide child attributes
- unity_catalogobject
Unity Catalog tables that receive the telemetry.
Show child attributesHide child attributes
- logs_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is created if it does not exist.
- metrics_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is created if it does not exist.
- traces_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The table is created if it does not exist.
Get an app update GA
GET
Gets the status of an app update.
API scopes: apps
Parameters
- app_namestringRequiredpath
The name of the app.
Response
- statusobjectOutput only
Progress of the update.
Show child attributesHide child attributes
- statestringOutput only
State of the update.
NOT_UPDATEDIN_PROGRESSSUCCEEDEDFAILED
- messagestringOutput only
Human-readable detail about the update state.
- descriptionstring
Description requested by the update.
- budget_policy_idstring
Budget policy ID requested by the update.
- resourcesarray of object
Resources requested by the update.
Show child attributesHide child attributes
- namestring[ 2 .. 30 ] charactersRequired
Key that identifies the resource within the app. The app configuration (app.yaml) references the resource by this key.
- descriptionstring<= 50 characters
Description of the App Resource.
- secretobject
Secret the app is granted access to.
Show child attributesHide child attributes
- scopestringRequired
Scope of the secret to grant permission on.
- keystringRequired
Key of the secret to grant permission on.
- permissionstringRequired
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE".
READWRITEMANAGE
- sql_warehouseobject
SQL warehouse the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the SQL warehouse to grant permission on.
- permissionstringRequired
Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER".
CAN_MANAGECAN_USEIS_OWNER
- serving_endpointobject
Model serving endpoint the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
Name of the serving endpoint to grant permission on.
- permissionstringRequired
Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW".
CAN_MANAGECAN_QUERYCAN_VIEW
- jobobject
Lakeflow job the app is granted access to.
Show child attributesHide child attributes
- idstringRequired
Id of the job to grant permission on.
- permissionstringRequired
Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW".
CAN_MANAGEIS_OWNERCAN_MANAGE_RUNCAN_VIEW
- uc_securableobject
Unity Catalog securable (volume, table, function, connection or model service) the app is granted a privilege on.
Show child attributesHide child attributes
- securable_full_namestringRequired
Full name of the Unity Catalog securable. For volumes, tables and functions this is the three-level catalog.schema.object name.
- securable_typestringRequired
Kind of Unity Catalog securable that
securable_full_namerefers to.VOLUMETABLEFUNCTIONCONNECTIONMODEL_SERVICE
- permissionstringRequired
Privilege to grant the app on the securable. The privilege must be valid for the securable type, such as READ_VOLUME for a volume or SELECT for a table.
READ_VOLUMEWRITE_VOLUMESELECTEXECUTEUSE_CONNECTIONMODIFY
- securable_kindstringOutput only
The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind.
- databaseobject
Lakebase Provisioned database the app is granted access to.
Show child attributesHide child attributes
- instance_namestringRequired
Name of the Lakebase database instance.
- database_namestringRequired
Name of the database within the instance.
- permissionstringRequired
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- genie_spaceobject
Genie space the app is granted access to.
Show child attributesHide child attributes
- namestringRequired
- space_idstringRequired
ID of the Genie space.
- permissionstringRequired
Permission to grant the app on the Genie space.
CAN_MANAGECAN_EDITCAN_RUNCAN_VIEW
- experimentobject
MLflow experiment the app is granted access to.
Show child attributesHide child attributes
- experiment_idstringRequired
ID of the MLflow experiment.
- permissionstringRequired
Permission to grant the app on the experiment.
CAN_MANAGECAN_EDITCAN_READ
- appobject
Another app in the workspace that this app is granted access to.
Show child attributesHide child attributes
- namestring
Name of the app to grant access to.
- permissionstring
Permission to grant on that app.
CAN_USE
- postgresobject
Lakebase Autoscaling Postgres database the app is granted access to.
Show child attributesHide child attributes
- branchstring
Resource name of the Lakebase Autoscaling branch, in the form
projects/{project}/branches/{branch}.
- databasestring
Resource name of the database within the branch, in the form
projects/{project}/branches/{branch}/databases/{database}.
- permissionstring
Permission to grant the app on the database.
CAN_CONNECT_AND_CREATE
- user_api_scopesarray of string
User API scopes requested by the update.
- compute_sizestring
Compute size requested by the update.
MEDIUMLARGEXLARGE
- usage_policy_idstring
Usage policy ID requested by the update.
- compute_min_instancesint32
Minimum number of app instances the app is configured to run. Must be set together with
compute_max_instances.
- compute_max_instancesint32
Maximum number of app instances the app is configured to run. Must be set together with
compute_min_instances.
- git_repositoryobject
Git repository configuration requested by the update.
Show child attributesHide child attributes
- urlstring<= 300 charactersRequired
URL of the Git repository.
- providerstringRequired
Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
- auto_deployboolean
When true, automatically deploys the app on push events to the branch configured in the app's deployment_source.git_source.
- telemetry_export_destinationsarray of object
Telemetry export destinations requested by the update.
Show child attributesHide child attributes
- unity_catalogobject
Unity Catalog tables that receive the telemetry.
Show child attributesHide child attributes
- logs_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is created if it does not exist.
- metrics_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is created if it does not exist.
- traces_tablestringRequired
Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The table is created if it does not exist.
Start an app GA
POST
Start the last active deployment of the app in the workspace.
API scopes: apps
Parameters
- namestringRequiredpath
The name of the app.
Response
Returns the App object.
Stop an app GA
POST
Stops the active deployment of the app in the workspace.
API scopes: apps
Parameters
- namestringRequiredpath
The name of the app.
Response
Returns the App object.