Update App (v1)
curl --request PATCH \
--url https://mycluster.domino.tech/api/apps/v1/apps/{appId} \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"accessStatuses": [
{
"userId": "<string>"
}
],
"description": "<string>",
"discoverable": true,
"mountDatasets": true,
"name": "<string>",
"sendNotifications": true
}
'import requests
url = "https://mycluster.domino.tech/api/apps/v1/apps/{appId}"
payload = {
"accessStatuses": [{ "userId": "<string>" }],
"description": "<string>",
"discoverable": True,
"mountDatasets": True,
"name": "<string>",
"sendNotifications": True
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accessStatuses: [{userId: '<string>'}],
description: '<string>',
discoverable: true,
mountDatasets: true,
name: '<string>',
sendNotifications: true
})
};
fetch('https://mycluster.domino.tech/api/apps/v1/apps/{appId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/api/apps/v1/apps/{appId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'accessStatuses' => [
[
'userId' => '<string>'
]
],
'description' => '<string>',
'discoverable' => true,
'mountDatasets' => true,
'name' => '<string>',
'sendNotifications' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/apps/v1/apps/{appId}"
payload := strings.NewReader("{\n \"accessStatuses\": [\n {\n \"userId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"discoverable\": true,\n \"mountDatasets\": true,\n \"name\": \"<string>\",\n \"sendNotifications\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://mycluster.domino.tech/api/apps/v1/apps/{appId}")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessStatuses\": [\n {\n \"userId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"discoverable\": true,\n \"mountDatasets\": true,\n \"name\": \"<string>\",\n \"sendNotifications\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/apps/v1/apps/{appId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accessStatuses\": [\n {\n \"userId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"discoverable\": true,\n \"mountDatasets\": true,\n \"name\": \"<string>\",\n \"sendNotifications\": true\n}"
response = http.request(request)
puts response.read_body{
"accessControl": {
"accessStatuses": [
{
"userId": "<string>"
}
],
"discoverable": true
},
"authorship": {
"isDraft": true,
"author": {
"id": "<string>",
"name": "<string>"
}
},
"configurationType": "STANDARD",
"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,
"id": "<string>",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"updatedAt": 123,
"bundle": {
"id": "<string>",
"name": "<string>"
},
"content": {
"mountDatasets": true,
"dataPlaneId": "<string>",
"dfsCommitId": "<string>",
"entryScript": "<string>",
"environmentId": "<string>",
"environmentRevisionId": "<string>",
"extendedIdentityPropagationToAppsEnabled": true,
"externalVolumeMountIds": [
"<string>"
],
"gitRef": {
"value": "<string>"
},
"importedGitRepoRefs": [
{
"gitRef": {
"value": "<string>"
},
"repoId": "<string>",
"repoName": "<string>"
}
],
"netAppVolumeIds": [
"<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>"
}
]
}
},
"currentInstance": {
"createdAt": 123,
"id": "<string>",
"status": "<string>",
"describeUrl": "<string>",
"dfsCommitId": "<string>",
"gitCommitId": "<string>",
"lastSynced": {
"syncedAt": 123,
"dfsCommitId": "<string>",
"importedRepoCommits": [
{
"ref": "<string>",
"repoId": "<string>"
}
],
"mainRepoCommitId": "<string>"
},
"publisher": {
"id": "<string>",
"name": "<string>"
}
},
"deployment": {
"autoscalingSpecification": {
"enabled": true,
"maxReplicas": 15,
"minReplicas": 15,
"scaleDownStabilizationWindowSeconds": 1800,
"scaleUpStabilizationWindowSeconds": 1800,
"targetCpuAvgUtilizationPct": 50,
"targetMemoryAvgUtilizationPct": 50,
"useSessionAffinity": true
},
"hardwareTierId": "<string>",
"vanityUrl": "<string>"
},
"description": "<string>",
"versionNumber": 123
},
"description": "<string>",
"properties": [
{
"fields": [
{
"propertyId": "<string>",
"propertyLabel": "<string>",
"updatedAt": 123,
"updatedBy": {
"userId": "<string>",
"username": "<string>"
},
"value": "<string>"
}
],
"groupName": "<string>"
}
],
"taxonomyTags": [
{
"id": "<string>",
"label": "<string>",
"namespaceId": "<string>",
"description": "<string>",
"fullPath": [
"<string>"
],
"namespaceLabel": "<string>"
}
],
"thumbnailEtag": "<string>",
"updatedAt": 123,
"vanityUrl": "<string>"
}{
"error": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "Authentication is required to access this resource."
}{
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"error": "<string>"
}{
"error": "<string>"
}Apps
Update App (v1)
Update app metadata and defaults. Does not touch versions or instances. entryPoint is immutable and not accepted.
PATCH
/
api
/
apps
/
v1
/
apps
/
{appId}
Update App (v1)
curl --request PATCH \
--url https://mycluster.domino.tech/api/apps/v1/apps/{appId} \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"accessStatuses": [
{
"userId": "<string>"
}
],
"description": "<string>",
"discoverable": true,
"mountDatasets": true,
"name": "<string>",
"sendNotifications": true
}
'import requests
url = "https://mycluster.domino.tech/api/apps/v1/apps/{appId}"
payload = {
"accessStatuses": [{ "userId": "<string>" }],
"description": "<string>",
"discoverable": True,
"mountDatasets": True,
"name": "<string>",
"sendNotifications": True
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accessStatuses: [{userId: '<string>'}],
description: '<string>',
discoverable: true,
mountDatasets: true,
name: '<string>',
sendNotifications: true
})
};
fetch('https://mycluster.domino.tech/api/apps/v1/apps/{appId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/api/apps/v1/apps/{appId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'accessStatuses' => [
[
'userId' => '<string>'
]
],
'description' => '<string>',
'discoverable' => true,
'mountDatasets' => true,
'name' => '<string>',
'sendNotifications' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/apps/v1/apps/{appId}"
payload := strings.NewReader("{\n \"accessStatuses\": [\n {\n \"userId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"discoverable\": true,\n \"mountDatasets\": true,\n \"name\": \"<string>\",\n \"sendNotifications\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://mycluster.domino.tech/api/apps/v1/apps/{appId}")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessStatuses\": [\n {\n \"userId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"discoverable\": true,\n \"mountDatasets\": true,\n \"name\": \"<string>\",\n \"sendNotifications\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/apps/v1/apps/{appId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accessStatuses\": [\n {\n \"userId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"discoverable\": true,\n \"mountDatasets\": true,\n \"name\": \"<string>\",\n \"sendNotifications\": true\n}"
response = http.request(request)
puts response.read_body{
"accessControl": {
"accessStatuses": [
{
"userId": "<string>"
}
],
"discoverable": true
},
"authorship": {
"isDraft": true,
"author": {
"id": "<string>",
"name": "<string>"
}
},
"configurationType": "STANDARD",
"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,
"id": "<string>",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"updatedAt": 123,
"bundle": {
"id": "<string>",
"name": "<string>"
},
"content": {
"mountDatasets": true,
"dataPlaneId": "<string>",
"dfsCommitId": "<string>",
"entryScript": "<string>",
"environmentId": "<string>",
"environmentRevisionId": "<string>",
"extendedIdentityPropagationToAppsEnabled": true,
"externalVolumeMountIds": [
"<string>"
],
"gitRef": {
"value": "<string>"
},
"importedGitRepoRefs": [
{
"gitRef": {
"value": "<string>"
},
"repoId": "<string>",
"repoName": "<string>"
}
],
"netAppVolumeIds": [
"<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>"
}
]
}
},
"currentInstance": {
"createdAt": 123,
"id": "<string>",
"status": "<string>",
"describeUrl": "<string>",
"dfsCommitId": "<string>",
"gitCommitId": "<string>",
"lastSynced": {
"syncedAt": 123,
"dfsCommitId": "<string>",
"importedRepoCommits": [
{
"ref": "<string>",
"repoId": "<string>"
}
],
"mainRepoCommitId": "<string>"
},
"publisher": {
"id": "<string>",
"name": "<string>"
}
},
"deployment": {
"autoscalingSpecification": {
"enabled": true,
"maxReplicas": 15,
"minReplicas": 15,
"scaleDownStabilizationWindowSeconds": 1800,
"scaleUpStabilizationWindowSeconds": 1800,
"targetCpuAvgUtilizationPct": 50,
"targetMemoryAvgUtilizationPct": 50,
"useSessionAffinity": true
},
"hardwareTierId": "<string>",
"vanityUrl": "<string>"
},
"description": "<string>",
"versionNumber": 123
},
"description": "<string>",
"properties": [
{
"fields": [
{
"propertyId": "<string>",
"propertyLabel": "<string>",
"updatedAt": 123,
"updatedBy": {
"userId": "<string>",
"username": "<string>"
},
"value": "<string>"
}
],
"groupName": "<string>"
}
],
"taxonomyTags": [
{
"id": "<string>",
"label": "<string>",
"namespaceId": "<string>",
"description": "<string>",
"fullPath": [
"<string>"
],
"namespaceLabel": "<string>"
}
],
"thumbnailEtag": "<string>",
"updatedAt": 123,
"vanityUrl": "<string>"
}{
"error": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "Authentication is required to access this resource."
}{
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
nucleus_DominoApiKeynucleus_BearerAuthentication
Path Parameters
Body
application/json
Update app metadata and defaults. entryPoint is immutable and not accepted. The mountDatasets default takes effect on next version creation; existing version snapshots retain their values. renderIFrame is not accepted here; it is overridden via the start endpoint as a deployment-field override. PATCH never stops running instances, creates new versions, or starts instances. This schema is a structural subset of AppCreationRequestV1: every field accepted here can also be supplied at creation time.
Show child attributes
Show child attributes
App-level default for whether to mount Domino Datasets into the App's runtime. Updates the App only; existing version snapshots are untouched and the next created version inherits the new default. Per-version overrides via the version-creation endpoints still win.
When access is granted to new users via accessStatuses, controls whether those users receive an email notification. Defaults to false when omitted.
Available options:
AUTHENTICATED, GRANT_BASED, GRANT_BASED_STRICT, PUBLIC Response
Success
Visibility and access-grant settings for an App.
Show child attributes
Show child attributes
Identity metadata for an App: whether it is a draft and the user who created it.
Show child attributes
Show child attributes
Type of configuration for the app which determines different deployment resources and settings.
Available options:
STANDARD, AISYSTEM App-level default for whether to mount Domino Datasets into the App's runtime.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Property values assigned to this app, grouped by group name.
Show child attributes
Show child attributes
Taxonomy tags assigned to this app. Omitted when the taxonomy feature is disabled.
Show child attributes
Show child attributes
Was this page helpful?
⌘I