Skip to main content
PATCH
/
api
/
apps
/
beta
/
apps
/
{appId}
Update App
curl --request PATCH \
  --url https://api.example.com/api/apps/beta/apps/{appId} \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "accessStatuses": [
    {
      "userId": "<string>"
    }
  ],
  "description": "<string>",
  "discoverable": true,
  "entryPoint": "<string>",
  "mountDatasets": true,
  "name": "<string>",
  "renderIFrame": true,
  "sendNotifications": true,
  "version": {
    "bundleId": "<string>",
    "dataPlaneId": "<string>",
    "description": "<string>",
    "dfsCommitId": "<string>",
    "entryScript": "<string>",
    "environmentId": "<string>",
    "environmentRevisionId": "<string>",
    "extendedIdentityPropagationToAppsEnabled": false,
    "externalVolumeMountIds": [
      "<string>"
    ],
    "hardwareTierId": "<string>",
    "netAppVolumeIds": [
      "<string>"
    ],
    "resolvedDfsCommitId": "<string>",
    "resolvedGitCommitId": "<string>",
    "resolvedImportedGitRepos": [
      {
        "ref": "<string>",
        "repoId": "<string>",
        "repoName": "<string>"
      }
    ],
    "resolvedImportedProjects": [
      {
        "commitId": "<string>",
        "directoryName": "<string>",
        "ownerId": "<string>",
        "projectId": "<string>",
        "projectName": "<string>",
        "release": "<string>"
      }
    ],
    "tags": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "vanityUrl": "<string>"
  }
}
'
{
  "accessStatuses": [
    {
      "userId": "<string>"
    }
  ],
  "configurationType": "STANDARD",
  "discoverable": true,
  "entryPoint": "<string>",
  "id": "<string>",
  "mountDatasets": true,
  "name": "<string>",
  "project": {
    "id": "<string>",
    "name": "<string>",
    "ownerId": "<string>",
    "ownerUsername": "<string>"
  },
  "renderIFrame": true,
  "url": "<string>",
  "views": 123,
  "currentVersion": {
    "createdAt": 123,
    "environmentId": "<string>",
    "environmentRevisionId": "<string>",
    "extendedIdentityPropagationToAppsEnabled": true,
    "externalVolumeMountIds": [
      "<string>"
    ],
    "hardwareTierId": "<string>",
    "id": "<string>",
    "netAppVolumeIds": [
      "<string>"
    ],
    "tags": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "updatedAt": 123,
    "autoscalingSpecification": {
      "enabled": true,
      "maxReplicas": 15,
      "minReplicas": 15,
      "scaleDownStabilizationWindowSeconds": 1800,
      "scaleUpStabilizationWindowSeconds": 1800,
      "targetCpuAvgUtilizationPct": 50,
      "targetMemoryAvgUtilizationPct": 50,
      "useSessionAffinity": true
    },
    "bundleId": "<string>",
    "bundleName": "<string>",
    "currentInstance": {
      "createdAt": 123,
      "id": "<string>",
      "status": "<string>",
      "describeUrl": "<string>",
      "dfsCommitId": "<string>",
      "gitCommitId": "<string>"
    },
    "description": "<string>",
    "dfsCommitId": "<string>",
    "entryScript": "<string>",
    "gitRef": {
      "value": "<string>"
    },
    "publisher": {
      "id": "<string>",
      "name": "<string>"
    },
    "resolvedCommits": {
      "dfsCommitId": "<string>",
      "gitCommitId": "<string>",
      "importedGitRepos": [
        {
          "ref": "<string>",
          "repoId": "<string>",
          "repoName": "<string>"
        }
      ],
      "importedProjects": [
        {
          "commitId": "<string>",
          "directoryName": "<string>",
          "ownerId": "<string>",
          "projectId": "<string>",
          "projectName": "<string>",
          "release": "<string>"
        }
      ]
    },
    "vanityUrl": "<string>",
    "versionNumber": 123
  },
  "customFields": [
    {
      "fields": [
        {
          "customFieldId": "<string>",
          "customFieldLabel": "<string>",
          "updatedAt": 123,
          "updatedBy": {
            "userId": "<string>",
            "username": "<string>"
          },
          "value": "<string>"
        }
      ],
      "groupName": "<string>"
    }
  ],
  "description": "<string>",
  "publisher": {
    "id": "<string>",
    "name": "<string>"
  },
  "taxonomyTags": [
    {
      "id": "<string>",
      "label": "<string>",
      "namespaceId": "<string>",
      "description": "<string>",
      "fullPath": [
        "<string>"
      ],
      "namespaceLabel": "<string>"
    }
  ],
  "thumbnailEtag": "<string>",
  "updatedAt": 123,
  "vanityUrl": "<string>"
}

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
​
customFields
object[]

Custom field values assigned to this app, grouped by group name.

​
description
string
​
publisher
object
​
taxonomyTags
object[]

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

​
thumbnailEtag
string
​
updatedAt
number<epoch>
​
vanityUrl
string