Create an Extension
Create an Extension given an App reference
curl --request POST \
--url https://mycluster.domino.tech/api/extensions/beta/extensions \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"appId": "<string>",
"appVersionId": "<string>",
"enabled": true,
"name": "<string>",
"uiMountPointTypeConfigs": {},
"description": "<string>"
}
'import requests
url = "https://mycluster.domino.tech/api/extensions/beta/extensions"
payload = {
"appId": "<string>",
"appVersionId": "<string>",
"enabled": True,
"name": "<string>",
"uiMountPointTypeConfigs": {},
"description": "<string>"
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
appId: '<string>',
appVersionId: '<string>',
enabled: true,
name: '<string>',
uiMountPointTypeConfigs: {},
description: '<string>'
})
};
fetch('https://mycluster.domino.tech/api/extensions/beta/extensions', 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/extensions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'appId' => '<string>',
'appVersionId' => '<string>',
'enabled' => true,
'name' => '<string>',
'uiMountPointTypeConfigs' => [
],
'description' => '<string>'
]),
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/extensions/beta/extensions"
payload := strings.NewReader("{\n \"appId\": \"<string>\",\n \"appVersionId\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"uiMountPointTypeConfigs\": {},\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://mycluster.domino.tech/api/extensions/beta/extensions")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"appId\": \"<string>\",\n \"appVersionId\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"uiMountPointTypeConfigs\": {},\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/extensions/beta/extensions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"appId\": \"<string>\",\n \"appVersionId\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"uiMountPointTypeConfigs\": {},\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"appId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"enabled": true,
"id": "<string>",
"kind": "DominoOfficial",
"name": "<string>",
"totalViews": 123,
"uiMountPointTypeConfigs": {
"adminPanel": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"dataset": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"datasetFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"mountPoints": [
{
"enabled": true,
"projectId": "<string>"
}
],
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"modelDetails": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"netAppVolume": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"netAppVolumeFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"mountPoints": [
{
"enabled": true,
"projectId": "<string>"
}
],
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"projectSidebar": {
"enabled": true,
"allProjects": true,
"mountPoints": [
{
"enabled": true,
"projectId": "<string>"
}
],
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"appVersionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"description": "<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
Body
Request to create an extension
The id of the App to associate the Extension with.
The version of the App to associate the Extension with.
Whether the Extension is globally enabled or disabled.
The name of the Extension.
The configuration for the UI mount points of the Extension. Each property corresponds to a different mount point in the Domino UI where the Extension can be mounted.
Show child attributes
Show child attributes
The description of the Extension.
Response
Success
The id of the App to associate the Extension with.
The date and time when the Extension was created.
Information about a Domino user including id and names.
Show child attributes
Show child attributes
Whether the Extension is globally enabled or disabled.
The id of the Extension.
The category of the Extension.
DominoOfficial, Uncategorized The name of the Extension.
The total number of views across all app versions.
The configuration for the UI mount points of the Extension. Each property corresponds to a different mount point in the Domino UI where the Extension can be mounted.
Show child attributes
Show child attributes
The date and time when the Extension was last updated.
Information about a Domino user including id and names.
Show child attributes
Show child attributes
The version of the App to associate the Extension with.
The date and time when the Extension was deleted. If null, the Extension has not been deleted.
Information about a Domino user including id and names.
Show child attributes
Show child attributes
The description of the Extension.
Related topics
Create and manage ExtensionsDomino Cloud release notesExtensionsInstall Domino Official ExtensionsWas this page helpful?
curl --request POST \
--url https://mycluster.domino.tech/api/extensions/beta/extensions \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"appId": "<string>",
"appVersionId": "<string>",
"enabled": true,
"name": "<string>",
"uiMountPointTypeConfigs": {},
"description": "<string>"
}
'import requests
url = "https://mycluster.domino.tech/api/extensions/beta/extensions"
payload = {
"appId": "<string>",
"appVersionId": "<string>",
"enabled": True,
"name": "<string>",
"uiMountPointTypeConfigs": {},
"description": "<string>"
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
appId: '<string>',
appVersionId: '<string>',
enabled: true,
name: '<string>',
uiMountPointTypeConfigs: {},
description: '<string>'
})
};
fetch('https://mycluster.domino.tech/api/extensions/beta/extensions', 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/extensions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'appId' => '<string>',
'appVersionId' => '<string>',
'enabled' => true,
'name' => '<string>',
'uiMountPointTypeConfigs' => [
],
'description' => '<string>'
]),
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/extensions/beta/extensions"
payload := strings.NewReader("{\n \"appId\": \"<string>\",\n \"appVersionId\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"uiMountPointTypeConfigs\": {},\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://mycluster.domino.tech/api/extensions/beta/extensions")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"appId\": \"<string>\",\n \"appVersionId\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"uiMountPointTypeConfigs\": {},\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/extensions/beta/extensions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"appId\": \"<string>\",\n \"appVersionId\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"uiMountPointTypeConfigs\": {},\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"appId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"enabled": true,
"id": "<string>",
"kind": "DominoOfficial",
"name": "<string>",
"totalViews": 123,
"uiMountPointTypeConfigs": {
"adminPanel": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"dataset": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"datasetFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"mountPoints": [
{
"enabled": true,
"projectId": "<string>"
}
],
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"modelDetails": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"netAppVolume": {
"enabled": true,
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"netAppVolumeFileContext": {
"enabled": true,
"allProjects": true,
"fileTypes": [
"<string>"
],
"mountPoints": [
{
"enabled": true,
"projectId": "<string>"
}
],
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
},
"projectSidebar": {
"enabled": true,
"allProjects": true,
"mountPoints": [
{
"enabled": true,
"projectId": "<string>"
}
],
"urlConfig": {
"contextualQueryParams": [
"projectId"
],
"route": "<string>"
}
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"appVersionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"firstName": "<string>",
"id": "<string>",
"lastName": "<string>",
"userName": "<string>"
},
"description": "<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>"
}