Skip to content
PATCH/api/v1/custom-dashboards/{id}

Update a dashboard

Updates dashboard metadata. Body requires `projectId` (the update is scoped `id` + `project_id`) plus at least one of `name` (trimmed, truncated to 200 chars), `description` (truncated to 2000), `tags` (strings only, first 20), `layout`, `filters` — 400 if none are present. Only these keys are copied into the update (mass-assignment whitelist, ADR-0017); unknown body keys are ignored. Requires `evals:update` (editor and above). 404 if the dashboard is not in that project.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Parameters

id in pathrequired
string

Response

200 example

{
  "success": true
}

All status codes

200Updated.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
404(no description)
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

# {id} is shown with an EXAMPLE value — replace it with real values.
curl -X PATCH \
  https://evalguard.ai/api/v1/custom-dashboards/00000000-0000-0000-0000-000000000000 \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:
// {id} is shown with an EXAMPLE value — replace it with real values.

const res = await fetch("https://evalguard.ai/api/v1/custom-dashboards/00000000-0000-0000-0000-000000000000", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:
# {id} is shown with an EXAMPLE value — replace it with real values.

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("PATCH", "https://evalguard.ai/api/v1/custom-dashboards/00000000-0000-0000-0000-000000000000", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

// {id} is shown with an EXAMPLE value — replace it with real values.
func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/custom-dashboards/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404409429500

Other Monitoring endpoints