Replace dashboards

Updates a v2-shape dashboard's metadata, spec and tag set.

PUT /v1/o11y/dashboards/{id}

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/dashboards/{id}`
Method	`PUT`
Operation	`UpdateDashboardV2`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Updates a v2-shape dashboard's metadata, spec and tag set. The name is immutable and locked dashboards are rejected.

Callers need the editor role; the runtime's own gate enforces it.

Request

9 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the dashboard id from the path.
`id`	body	string	—	ID is the dashboard id from the path.
`image`	body	string	—
`name`	body	string	—
`schemaVersion`	body	string	—
`spec`	body	any	—
`tags`	body	o11y.O11yDashboardPostableTag[]	—
`tags[].key`	body	string	—	Key is the tag key.
`tags[].value`	body	string	—	Value is the tag value.

Response

Status	Body	Meaning
`200`	o11y.O11yDashboardOut	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 17 fields.

Field	In	Type	Always	Description
`data`	body	o11y.O11yDashboard	—
`data.createdAt`	body	string (date-time)	—	CreatedAt is when the dashboard was created.
`data.createdBy`	body	string	—	CreatedBy is who created it.
`data.id`	body	string	—	ID is the dashboard's id.
`data.image`	body	string	—	Image is an optional cover image reference.
`data.locked`	body	boolean	—	Locked reports whether the dashboard is locked against edits.
`data.name`	body	string	—	Name is the dashboard's unique internal name.
`data.orgId`	body	string	—	OrgID is the org the dashboard belongs to.
`data.schemaVersion`	body	string	—	SchemaVersion is the dashboard schema version.
`data.source`	body	string	—	Source is where the dashboard came from: user, system or integration.
`data.spec`	body	any	—	Spec is the Perses dashboard spec, carried verbatim as open JSON.
`data.tags`	body	o11y.O11yDashboardTag[]	—	Tags are the dashboard's tags.
`data.tags[].key`	body	string	—	Key is the tag key.
`data.tags[].value`	body	string	—	Value is the tag value.
`data.updatedAt`	body	string (date-time)	—	UpdatedAt is when it last changed.
`data.updatedBy`	body	string	—	UpdatedBy is who last changed it.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y dashboards set <id>

.ts

.py

.go

.rs

.java

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.updateDashboardV2({ id: 'id', id: "<id>", image: "<image>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).update_dashboard_v2(id='id', id="<id>", image="<image>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.UpdateDashboardV2(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::update_dashboard_v2(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).updateDashboardV2();

curl -X PUT https://api.hanzo.ai/v1/o11y/dashboards/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "image": "<image>"
     }'

Tool o11y, op UpdateDashboardV2 — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "UpdateDashboardV2",
           "input": {
             "id": "<id>",
             "image": "<image>"
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousReplace channels NextReplace dashboard views