Dashboards API
Update Dashboard
Update a dashboard’s name, description, variables, or tabs. Partial: an omitted field is left alone, so sending one field moves nothing else — omit tabs and renaming a dashboard does not mean resending its grid. variables and tabs are wrapper objects rather than bare lists precisely so omitted and empty stay distinct. variables: omit it and the stored variables are untouched, send and they reset to the default time range, send a list and it replaces them wholesale. tabs: omit it and the grid is untouched, send it and the tabs it carries replace the grid wholesale, so a caller reads the dashboard, edits its tabs, and sends them all back. A tab or widget entry that is omitted is removed. Removing a widget from a tab does NOT delete it: the row stays alive and unplaced, so no tabs edit can destroy a widget. An entry need not name a widget that is live on this dashboard: one whose widget has been deleted stays on the tab and renders as an empty placeholder, matching the dashboard UI. A widget is placed exactly once across the whole dashboard. Excluded from the generated MCP tools: Catalyst changes dashboards through staged, human-published change sets, and an auto-generated tool would be an unstaged second path to the same rows.
PUT
/
v2
/
dashboards
/
{id}
Update Dashboard
curl --request PUT \
--url https://public.api.serval.com/v2/dashboards/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"variables": {
"variables": [
{
"name": "<string>",
"timeRange": {
"defaultFrom": "<string>",
"defaultTo": "<string>"
}
}
]
},
"tabs": {
"tabs": [
{
"key": "<string>",
"name": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"x": 1,
"y": 1,
"w": 6,
"h": 64
}
]
}
]
}
}
'import requests
url = "https://public.api.serval.com/v2/dashboards/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"variables": { "variables": [
{
"name": "<string>",
"timeRange": {
"defaultFrom": "<string>",
"defaultTo": "<string>"
}
}
] },
"tabs": { "tabs": [
{
"key": "<string>",
"name": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"x": 1,
"y": 1,
"w": 6,
"h": 64
}
]
}
] }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
variables: {
variables: [
{name: '<string>', timeRange: {defaultFrom: '<string>', defaultTo: '<string>'}}
]
},
tabs: {
tabs: [
{
key: '<string>',
name: '<string>',
widgets: [{widgetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', x: 1, y: 1, w: 6, h: 64}]
}
]
}
})
};
fetch('https://public.api.serval.com/v2/dashboards/{id}', 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://public.api.serval.com/v2/dashboards/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'variables' => [
'variables' => [
[
'name' => '<string>',
'timeRange' => [
'defaultFrom' => '<string>',
'defaultTo' => '<string>'
]
]
]
],
'tabs' => [
'tabs' => [
[
'key' => '<string>',
'name' => '<string>',
'widgets' => [
[
'widgetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'x' => 1,
'y' => 1,
'w' => 6,
'h' => 64
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://public.api.serval.com/v2/dashboards/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"variables\": {\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"timeRange\": {\n \"defaultFrom\": \"<string>\",\n \"defaultTo\": \"<string>\"\n }\n }\n ]\n },\n \"tabs\": {\n \"tabs\": [\n {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"widgets\": [\n {\n \"widgetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"x\": 1,\n \"y\": 1,\n \"w\": 6,\n \"h\": 64\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://public.api.serval.com/v2/dashboards/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"variables\": {\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"timeRange\": {\n \"defaultFrom\": \"<string>\",\n \"defaultTo\": \"<string>\"\n }\n }\n ]\n },\n \"tabs\": {\n \"tabs\": [\n {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"widgets\": [\n {\n \"widgetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"x\": 1,\n \"y\": 1,\n \"w\": 6,\n \"h\": 64\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/dashboards/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"variables\": {\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"timeRange\": {\n \"defaultFrom\": \"<string>\",\n \"defaultTo\": \"<string>\"\n }\n }\n ]\n },\n \"tabs\": {\n \"tabs\": [\n {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"widgets\": [\n {\n \"widgetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"x\": 1,\n \"y\": 1,\n \"w\": 6,\n \"h\": 64\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"scopedId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"tabs": [
{
"key": "<string>",
"name": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"x": 1,
"y": 1,
"w": 6,
"h": 64
}
]
}
],
"variables": [
{
"name": "<string>",
"type": "VARIABLE_TYPE_UNSPECIFIED",
"timeRange": {
"defaultFrom": "<string>",
"defaultTo": "<string>"
}
}
],
"createdAt": "2025-01-15T01:30:15.000Z",
"updatedAt": "2025-01-15T01:30:15.000Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
200 - application/json
Success
A dashboard owns its tabs and names each widget by id; widgets are their own resource. No list endpoint, no concurrency version.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update Dashboard
curl --request PUT \
--url https://public.api.serval.com/v2/dashboards/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"variables": {
"variables": [
{
"name": "<string>",
"timeRange": {
"defaultFrom": "<string>",
"defaultTo": "<string>"
}
}
]
},
"tabs": {
"tabs": [
{
"key": "<string>",
"name": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"x": 1,
"y": 1,
"w": 6,
"h": 64
}
]
}
]
}
}
'import requests
url = "https://public.api.serval.com/v2/dashboards/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"variables": { "variables": [
{
"name": "<string>",
"timeRange": {
"defaultFrom": "<string>",
"defaultTo": "<string>"
}
}
] },
"tabs": { "tabs": [
{
"key": "<string>",
"name": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"x": 1,
"y": 1,
"w": 6,
"h": 64
}
]
}
] }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
variables: {
variables: [
{name: '<string>', timeRange: {defaultFrom: '<string>', defaultTo: '<string>'}}
]
},
tabs: {
tabs: [
{
key: '<string>',
name: '<string>',
widgets: [{widgetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', x: 1, y: 1, w: 6, h: 64}]
}
]
}
})
};
fetch('https://public.api.serval.com/v2/dashboards/{id}', 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://public.api.serval.com/v2/dashboards/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'variables' => [
'variables' => [
[
'name' => '<string>',
'timeRange' => [
'defaultFrom' => '<string>',
'defaultTo' => '<string>'
]
]
]
],
'tabs' => [
'tabs' => [
[
'key' => '<string>',
'name' => '<string>',
'widgets' => [
[
'widgetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'x' => 1,
'y' => 1,
'w' => 6,
'h' => 64
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://public.api.serval.com/v2/dashboards/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"variables\": {\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"timeRange\": {\n \"defaultFrom\": \"<string>\",\n \"defaultTo\": \"<string>\"\n }\n }\n ]\n },\n \"tabs\": {\n \"tabs\": [\n {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"widgets\": [\n {\n \"widgetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"x\": 1,\n \"y\": 1,\n \"w\": 6,\n \"h\": 64\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://public.api.serval.com/v2/dashboards/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"variables\": {\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"timeRange\": {\n \"defaultFrom\": \"<string>\",\n \"defaultTo\": \"<string>\"\n }\n }\n ]\n },\n \"tabs\": {\n \"tabs\": [\n {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"widgets\": [\n {\n \"widgetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"x\": 1,\n \"y\": 1,\n \"w\": 6,\n \"h\": 64\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/dashboards/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"variables\": {\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"timeRange\": {\n \"defaultFrom\": \"<string>\",\n \"defaultTo\": \"<string>\"\n }\n }\n ]\n },\n \"tabs\": {\n \"tabs\": [\n {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"widgets\": [\n {\n \"widgetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"x\": 1,\n \"y\": 1,\n \"w\": 6,\n \"h\": 64\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"scopedId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"tabs": [
{
"key": "<string>",
"name": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"x": 1,
"y": 1,
"w": 6,
"h": 64
}
]
}
],
"variables": [
{
"name": "<string>",
"type": "VARIABLE_TYPE_UNSPECIFIED",
"timeRange": {
"defaultFrom": "<string>",
"defaultTo": "<string>"
}
}
],
"createdAt": "2025-01-15T01:30:15.000Z",
"updatedAt": "2025-01-15T01:30:15.000Z"
}
}