Extensions
List Domino Official Extension install options
Returns the available Domino Official Extension installs and upgrades.
GET
/
api
/
extensions
/
beta
/
official-install-menu
List Domino Official Extension install options
curl --request GET \
--url https://mycluster.domino.tech/api/extensions/beta/official-install-menu \
--header 'X-Domino-Api-Key: <api-key>'import requests
url = "https://mycluster.domino.tech/api/extensions/beta/official-install-menu"
headers = {"X-Domino-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Domino-Api-Key': '<api-key>'}};
fetch('https://mycluster.domino.tech/api/extensions/beta/official-install-menu', 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/extensions/beta/official-install-menu",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/extensions/beta/official-install-menu"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mycluster.domino.tech/api/extensions/beta/official-install-menu")
.header("X-Domino-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/extensions/beta/official-install-menu")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"degraded": true,
"meta": {
"limit": 123,
"offset": 123,
"orderBy": "asc",
"sortBy": "installDisplayName",
"totalCount": 123
},
"officialExtensionInstalls": [
{
"availableVersions": [
{
"extensionVersion": "<string>",
"isCompatible": true,
"manifestSchemaVersion": 123,
"minDominoVersion": "<string>",
"releaseTag": "<string>",
"additionalInstallationInstructions": "<string>",
"description": "<string>",
"isProvisional": true,
"maxDominoVersion": "<string>",
"releaseLink": "<string>",
"testedWithDominoVersions": [
"<string>"
]
}
],
"remoteRepo": "<string>",
"versionsFetchFailed": true,
"currentInstall": {
"extensionInstallId": "<string>",
"extensionReleaseTag": "<string>",
"extensionVersion": "<string>",
"id": "<string>",
"isComplete": true,
"manifestSchemaVersion": 123,
"startedAt": "2023-11-07T05:31:56Z",
"startedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"steps": [
{
"logs": [
{
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"name": "ManageProject",
"transitions": [
{
"changedAt": "2023-11-07T05:31:56Z",
"status": "Pending",
"error": "<string>",
"statusString": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z"
}
],
"cancelRequested": true,
"completedAt": "2023-11-07T05:31:56Z",
"managedDominoEntitiesV1": {
"manifestSchemaVersion": 123,
"appId": "<string>",
"appVersionId": "<string>",
"environmentId": "<string>",
"environmentRevisionId": "<string>",
"extensionId": "<string>",
"projectId": "<string>"
},
"manifestV1": {
"app": {
"appDescription": "<string>",
"appName": "<string>",
"appVersionDescription": "<string>",
"computeEnvironment": {
"type": "DCE",
"customEnvironment": {
"baseImage": "<string>",
"dockerfilePath": "<string>",
"autoCompatibleWithDomino": true,
"buildArgs": {},
"name": "<string>",
"visibility": "Global"
}
},
"entryPoint": "<string>",
"vanityUrl": "<string>",
"autoscalingSpec": {
"enabled": true,
"maxReplicas": 123,
"minReplicas": 123,
"scaleDownStabilizationWindowSeconds": 123,
"scaleUpStabilizationWindowSeconds": 123,
"targetCpuAvgUtilizationPct": 123,
"targetMemoryAvgUtilizationPct": 123,
"useSessionAffinity": true
},
"discoverable": true,
"enableDeepLinking": true,
"externalVolumeMounts": [
"<string>"
],
"hardwareTierIdSuggestion": "<string>",
"mountDatasets": true,
"visibility": "Authenticated"
},
"extension": {
"description": "<string>",
"enabled": true,
"name": "<string>",
"uiMountPointTypeConfigs": {
"adminPanel": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"dataset": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"datasetFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"modelDetails": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolume": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolumeFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"projectSidebar": {
"enabled": true,
"allProjects": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"topBar": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
}
}
},
"manifestSchemaVersion": 123,
"project": {
"description": "<string>",
"name": "<string>",
"visibility": "Public"
}
},
"retryRequested": "clean",
"uninstallAttempts": 123,
"uninstallRequested": true,
"upgradedFromSnapshotId": "<string>"
},
"description": "<string>",
"id": "<string>",
"incompleteInstall": {
"extensionInstallId": "<string>",
"extensionReleaseTag": "<string>",
"extensionVersion": "<string>",
"id": "<string>",
"isComplete": true,
"manifestSchemaVersion": 123,
"startedAt": "2023-11-07T05:31:56Z",
"startedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"steps": [
{
"logs": [
{
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"name": "ManageProject",
"transitions": [
{
"changedAt": "2023-11-07T05:31:56Z",
"status": "Pending",
"error": "<string>",
"statusString": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z"
}
],
"cancelRequested": true,
"completedAt": "2023-11-07T05:31:56Z",
"managedDominoEntitiesV1": {
"manifestSchemaVersion": 123,
"appId": "<string>",
"appVersionId": "<string>",
"environmentId": "<string>",
"environmentRevisionId": "<string>",
"extensionId": "<string>",
"projectId": "<string>"
},
"manifestV1": {
"app": {
"appDescription": "<string>",
"appName": "<string>",
"appVersionDescription": "<string>",
"computeEnvironment": {
"type": "DCE",
"customEnvironment": {
"baseImage": "<string>",
"dockerfilePath": "<string>",
"autoCompatibleWithDomino": true,
"buildArgs": {},
"name": "<string>",
"visibility": "Global"
}
},
"entryPoint": "<string>",
"vanityUrl": "<string>",
"autoscalingSpec": {
"enabled": true,
"maxReplicas": 123,
"minReplicas": 123,
"scaleDownStabilizationWindowSeconds": 123,
"scaleUpStabilizationWindowSeconds": 123,
"targetCpuAvgUtilizationPct": 123,
"targetMemoryAvgUtilizationPct": 123,
"useSessionAffinity": true
},
"discoverable": true,
"enableDeepLinking": true,
"externalVolumeMounts": [
"<string>"
],
"hardwareTierIdSuggestion": "<string>",
"mountDatasets": true,
"visibility": "Authenticated"
},
"extension": {
"description": "<string>",
"enabled": true,
"name": "<string>",
"uiMountPointTypeConfigs": {
"adminPanel": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"dataset": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"datasetFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"modelDetails": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolume": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolumeFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"projectSidebar": {
"enabled": true,
"allProjects": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"topBar": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
}
}
},
"manifestSchemaVersion": 123,
"project": {
"description": "<string>",
"name": "<string>",
"visibility": "Public"
}
},
"retryRequested": "clean",
"uninstallAttempts": 123,
"uninstallRequested": true,
"upgradedFromSnapshotId": "<string>"
},
"installDisplayName": "<string>",
"versionsFetchFailedReason": "<string>"
}
],
"degradationReason": "<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>"
}Authorizations
DominoApiKeyBearerAuthentication
Query Parameters
The maximum number of results to return. Use 0 for no limit (default).
Required range:
x >= 0The number of results to skip before starting to collect the result set.
Required range:
x >= 0The field to sort by. By default, results are sorted by display name. The field to sort the official extension installs list by.
Available options:
installDisplayName The order to sort results in. By default, results are sorted in ascending order. The order that the list of Extensions is sorted in.
Available options:
asc, desc Response
Success
True when GitHub was unreachable. The list contains only extensions with existing install records and availableVersions will be empty.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Why the list is degraded. Only present when degraded is true.
Was this page helpful?
⌘I
List Domino Official Extension install options
curl --request GET \
--url https://mycluster.domino.tech/api/extensions/beta/official-install-menu \
--header 'X-Domino-Api-Key: <api-key>'import requests
url = "https://mycluster.domino.tech/api/extensions/beta/official-install-menu"
headers = {"X-Domino-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Domino-Api-Key': '<api-key>'}};
fetch('https://mycluster.domino.tech/api/extensions/beta/official-install-menu', 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/extensions/beta/official-install-menu",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/extensions/beta/official-install-menu"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mycluster.domino.tech/api/extensions/beta/official-install-menu")
.header("X-Domino-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/extensions/beta/official-install-menu")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"degraded": true,
"meta": {
"limit": 123,
"offset": 123,
"orderBy": "asc",
"sortBy": "installDisplayName",
"totalCount": 123
},
"officialExtensionInstalls": [
{
"availableVersions": [
{
"extensionVersion": "<string>",
"isCompatible": true,
"manifestSchemaVersion": 123,
"minDominoVersion": "<string>",
"releaseTag": "<string>",
"additionalInstallationInstructions": "<string>",
"description": "<string>",
"isProvisional": true,
"maxDominoVersion": "<string>",
"releaseLink": "<string>",
"testedWithDominoVersions": [
"<string>"
]
}
],
"remoteRepo": "<string>",
"versionsFetchFailed": true,
"currentInstall": {
"extensionInstallId": "<string>",
"extensionReleaseTag": "<string>",
"extensionVersion": "<string>",
"id": "<string>",
"isComplete": true,
"manifestSchemaVersion": 123,
"startedAt": "2023-11-07T05:31:56Z",
"startedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"steps": [
{
"logs": [
{
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"name": "ManageProject",
"transitions": [
{
"changedAt": "2023-11-07T05:31:56Z",
"status": "Pending",
"error": "<string>",
"statusString": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z"
}
],
"cancelRequested": true,
"completedAt": "2023-11-07T05:31:56Z",
"managedDominoEntitiesV1": {
"manifestSchemaVersion": 123,
"appId": "<string>",
"appVersionId": "<string>",
"environmentId": "<string>",
"environmentRevisionId": "<string>",
"extensionId": "<string>",
"projectId": "<string>"
},
"manifestV1": {
"app": {
"appDescription": "<string>",
"appName": "<string>",
"appVersionDescription": "<string>",
"computeEnvironment": {
"type": "DCE",
"customEnvironment": {
"baseImage": "<string>",
"dockerfilePath": "<string>",
"autoCompatibleWithDomino": true,
"buildArgs": {},
"name": "<string>",
"visibility": "Global"
}
},
"entryPoint": "<string>",
"vanityUrl": "<string>",
"autoscalingSpec": {
"enabled": true,
"maxReplicas": 123,
"minReplicas": 123,
"scaleDownStabilizationWindowSeconds": 123,
"scaleUpStabilizationWindowSeconds": 123,
"targetCpuAvgUtilizationPct": 123,
"targetMemoryAvgUtilizationPct": 123,
"useSessionAffinity": true
},
"discoverable": true,
"enableDeepLinking": true,
"externalVolumeMounts": [
"<string>"
],
"hardwareTierIdSuggestion": "<string>",
"mountDatasets": true,
"visibility": "Authenticated"
},
"extension": {
"description": "<string>",
"enabled": true,
"name": "<string>",
"uiMountPointTypeConfigs": {
"adminPanel": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"dataset": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"datasetFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"modelDetails": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolume": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolumeFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"projectSidebar": {
"enabled": true,
"allProjects": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"topBar": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
}
}
},
"manifestSchemaVersion": 123,
"project": {
"description": "<string>",
"name": "<string>",
"visibility": "Public"
}
},
"retryRequested": "clean",
"uninstallAttempts": 123,
"uninstallRequested": true,
"upgradedFromSnapshotId": "<string>"
},
"description": "<string>",
"id": "<string>",
"incompleteInstall": {
"extensionInstallId": "<string>",
"extensionReleaseTag": "<string>",
"extensionVersion": "<string>",
"id": "<string>",
"isComplete": true,
"manifestSchemaVersion": 123,
"startedAt": "2023-11-07T05:31:56Z",
"startedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"steps": [
{
"logs": [
{
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"name": "ManageProject",
"transitions": [
{
"changedAt": "2023-11-07T05:31:56Z",
"status": "Pending",
"error": "<string>",
"statusString": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z"
}
],
"cancelRequested": true,
"completedAt": "2023-11-07T05:31:56Z",
"managedDominoEntitiesV1": {
"manifestSchemaVersion": 123,
"appId": "<string>",
"appVersionId": "<string>",
"environmentId": "<string>",
"environmentRevisionId": "<string>",
"extensionId": "<string>",
"projectId": "<string>"
},
"manifestV1": {
"app": {
"appDescription": "<string>",
"appName": "<string>",
"appVersionDescription": "<string>",
"computeEnvironment": {
"type": "DCE",
"customEnvironment": {
"baseImage": "<string>",
"dockerfilePath": "<string>",
"autoCompatibleWithDomino": true,
"buildArgs": {},
"name": "<string>",
"visibility": "Global"
}
},
"entryPoint": "<string>",
"vanityUrl": "<string>",
"autoscalingSpec": {
"enabled": true,
"maxReplicas": 123,
"minReplicas": 123,
"scaleDownStabilizationWindowSeconds": 123,
"scaleUpStabilizationWindowSeconds": 123,
"targetCpuAvgUtilizationPct": 123,
"targetMemoryAvgUtilizationPct": 123,
"useSessionAffinity": true
},
"discoverable": true,
"enableDeepLinking": true,
"externalVolumeMounts": [
"<string>"
],
"hardwareTierIdSuggestion": "<string>",
"mountDatasets": true,
"visibility": "Authenticated"
},
"extension": {
"description": "<string>",
"enabled": true,
"name": "<string>",
"uiMountPointTypeConfigs": {
"adminPanel": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"dataset": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"datasetFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"modelDetails": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolume": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"netAppVolumeFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"projectSidebar": {
"enabled": true,
"allProjects": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
},
"topBar": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"<string>"
],
"route": "<string>"
}
}
}
},
"manifestSchemaVersion": 123,
"project": {
"description": "<string>",
"name": "<string>",
"visibility": "Public"
}
},
"retryRequested": "clean",
"uninstallAttempts": 123,
"uninstallRequested": true,
"upgradedFromSnapshotId": "<string>"
},
"installDisplayName": "<string>",
"versionsFetchFailedReason": "<string>"
}
],
"degradationReason": "<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>"
}