Update dashboard
curl --request PATCH \
--url http://api.den.local/v1/dashboards/{dashboardId} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"elements": [
{
"serverName": "<string>",
"toolName": "<string>",
"projectedToolName": "<string>",
"resourceUri": "<string>",
"title": "<string>",
"connectionId": "<string>",
"launchArguments": {},
"requiresApproval": true,
"organizationAutoLaunch": true
}
]
}
'import requests
url = "http://api.den.local/v1/dashboards/{dashboardId}"
payload = {
"name": "<string>",
"elements": [
{
"serverName": "<string>",
"toolName": "<string>",
"projectedToolName": "<string>",
"resourceUri": "<string>",
"title": "<string>",
"connectionId": "<string>",
"launchArguments": {},
"requiresApproval": True,
"organizationAutoLaunch": True
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
elements: [
{
serverName: '<string>',
toolName: '<string>',
projectedToolName: '<string>',
resourceUri: '<string>',
title: '<string>',
connectionId: '<string>',
launchArguments: {},
requiresApproval: true,
organizationAutoLaunch: true
}
]
})
};
fetch('http://api.den.local/v1/dashboards/{dashboardId}', 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 => "http://api.den.local/v1/dashboards/{dashboardId}",
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([
'name' => '<string>',
'elements' => [
[
'serverName' => '<string>',
'toolName' => '<string>',
'projectedToolName' => '<string>',
'resourceUri' => '<string>',
'title' => '<string>',
'connectionId' => '<string>',
'launchArguments' => [
],
'requiresApproval' => true,
'organizationAutoLaunch' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://api.den.local/v1/dashboards/{dashboardId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"elements\": [\n {\n \"serverName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"projectedToolName\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"title\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"launchArguments\": {},\n \"requiresApproval\": true,\n \"organizationAutoLaunch\": true\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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("http://api.den.local/v1/dashboards/{dashboardId}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"elements\": [\n {\n \"serverName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"projectedToolName\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"title\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"launchArguments\": {},\n \"requiresApproval\": true,\n \"organizationAutoLaunch\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.den.local/v1/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"elements\": [\n {\n \"serverName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"projectedToolName\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"title\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"launchArguments\": {},\n \"requiresApproval\": true,\n \"organizationAutoLaunch\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"item": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"elements": [
{
"serverName": "<string>",
"toolName": "<string>",
"projectedToolName": "<string>",
"resourceUri": "<string>",
"title": "<string>",
"connectionId": "<string>",
"launchArguments": {},
"requiresApproval": true,
"organizationAutoLaunch": true
}
],
"createdByOrgMembershipId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Dashboards
Update dashboard
PATCH
/
v1
/
dashboards
/
{dashboardId}
Update dashboard
curl --request PATCH \
--url http://api.den.local/v1/dashboards/{dashboardId} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"elements": [
{
"serverName": "<string>",
"toolName": "<string>",
"projectedToolName": "<string>",
"resourceUri": "<string>",
"title": "<string>",
"connectionId": "<string>",
"launchArguments": {},
"requiresApproval": true,
"organizationAutoLaunch": true
}
]
}
'import requests
url = "http://api.den.local/v1/dashboards/{dashboardId}"
payload = {
"name": "<string>",
"elements": [
{
"serverName": "<string>",
"toolName": "<string>",
"projectedToolName": "<string>",
"resourceUri": "<string>",
"title": "<string>",
"connectionId": "<string>",
"launchArguments": {},
"requiresApproval": True,
"organizationAutoLaunch": True
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
elements: [
{
serverName: '<string>',
toolName: '<string>',
projectedToolName: '<string>',
resourceUri: '<string>',
title: '<string>',
connectionId: '<string>',
launchArguments: {},
requiresApproval: true,
organizationAutoLaunch: true
}
]
})
};
fetch('http://api.den.local/v1/dashboards/{dashboardId}', 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 => "http://api.den.local/v1/dashboards/{dashboardId}",
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([
'name' => '<string>',
'elements' => [
[
'serverName' => '<string>',
'toolName' => '<string>',
'projectedToolName' => '<string>',
'resourceUri' => '<string>',
'title' => '<string>',
'connectionId' => '<string>',
'launchArguments' => [
],
'requiresApproval' => true,
'organizationAutoLaunch' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://api.den.local/v1/dashboards/{dashboardId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"elements\": [\n {\n \"serverName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"projectedToolName\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"title\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"launchArguments\": {},\n \"requiresApproval\": true,\n \"organizationAutoLaunch\": true\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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("http://api.den.local/v1/dashboards/{dashboardId}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"elements\": [\n {\n \"serverName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"projectedToolName\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"title\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"launchArguments\": {},\n \"requiresApproval\": true,\n \"organizationAutoLaunch\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.den.local/v1/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"elements\": [\n {\n \"serverName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"projectedToolName\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"title\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"launchArguments\": {},\n \"requiresApproval\": true,\n \"organizationAutoLaunch\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"item": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"elements": [
{
"serverName": "<string>",
"toolName": "<string>",
"projectedToolName": "<string>",
"resourceUri": "<string>",
"title": "<string>",
"connectionId": "<string>",
"launchArguments": {},
"requiresApproval": true,
"organizationAutoLaunch": true
}
],
"createdByOrgMembershipId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Path Parameters
Den TypeID with 'dsb_' prefix and a 26-character base32 suffix.
Required string length:
30Body
application/json
Response
Dashboard updated successfully.
Show child attributes
Show child attributes
Was this page helpful?
⌘I