Skip to main content
PATCH
Update App

Authorizations

X-Domino-Api-Key
string
header
required

Path Parameters

appId
string
required

The id of the app to update.

Body

application/json

Request to update an app

Request body for updating an app. All fields are optional; omitted fields preserve existing values. The side effects of an update depend on which fields changed:

  • Reproducibility fields (mountDatasets, and any reproducibility fields inside the nested version object such as dfsCommitId, gitRef, environmentId, environmentRevisionId, externalVolumeMountIds, netAppVolumeIds, and entryScript) create a new app version and stop the currently running instance. Note: bundleId is immutable after creation and is not affected by updates.
  • Execution fields (renderIFrame, and execution fields inside the nested version object such as hardwareTierId, autoscalingSpecification, and vanityUrl) update the version in-place, stop the running instance, and restart from the same version.
  • Metadata fields (name, description, entryPoint, visibility, accessStatuses, discoverable) are updated in-place without restarting.
accessStatuses
object[]

Access statuses for the app. Metadata field: updated without restarting.

description
string

App description. Metadata field: updated without restarting.

discoverable
boolean

Whether the app is discoverable. Metadata field: updated without restarting.

entryPoint
string

App entry point. Metadata field: updated without restarting.

mountDatasets
boolean

Whether to mount datasets. Reproducibility field: changing this creates a new version.

name
string

Display name for the app. Metadata field: updated without restarting.

renderIFrame
boolean

Whether to render the app in an iframe. Execution field: changing this triggers a restart.

sendNotifications
boolean

When access is granted to new users via accessStatuses, controls whether those users receive an email notification. Defaults to false when omitted.

version
object
visibility
enum<string>

App visibility level. Metadata field: updated without restarting.

Available options:
AUTHENTICATED,
GRANT_BASED,
GRANT_BASED_STRICT,
PUBLIC

Response

Success

accessStatuses
object[]
required
configurationType
enum<string>
default:STANDARD
required

Type of configuration for the app which determines different deployment resources and settings.

Available options:
STANDARD,
AISYSTEM
discoverable
boolean
required
entryPoint
string
required
id
string
required
mountDatasets
boolean
required
name
string
required
project
object
required
renderIFrame
boolean
required
url
string
required
views
number
required
visibility
enum<string>
required
Available options:
AUTHENTICATED,
GRANT_BASED,
GRANT_BASED_STRICT,
PUBLIC
currentVersion
object

The most recently started (which may be different from the most recently created) version of this App. If no version has been started, defaults to most recently created version.

description
string
properties
object[]

Property values assigned to this app, grouped by group name.

publisher
object
taxonomyTags
object[]

Taxonomy tags assigned to this app. Omitted when the taxonomy feature is disabled.

thumbnailEtag
string
updatedAt
number<epoch>
vanityUrl
string
Last modified on June 26, 2026