Hanzo
OpenapiO11y

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

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

PUT /v1/o11y/dashboards/{id}

Addresshttps://api.hanzo.ai/v1/o11y/dashboards/{id}
MethodPUT
OperationUpdateDashboardV2
AuthAuthorization: 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).

FieldInTypeRequiredDescription
idpathstringyesID is the dashboard id from the path.
idbodystringID is the dashboard id from the path.
imagebodystring
namebodystring
schemaVersionbodystring
specbodyany
tagsbodyo11y.O11yDashboardPostableTag[]
tags[].keybodystringKey is the tag key.
tags[].valuebodystringValue is the tag value.

Response

StatusBodyMeaning
200o11y.O11yDashboardOutok

200 body — 17 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yDashboard
data.createdAtbodystring (date-time)CreatedAt is when the dashboard was created.
data.createdBybodystringCreatedBy is who created it.
data.idbodystringID is the dashboard's id.
data.imagebodystringImage is an optional cover image reference.
data.lockedbodybooleanLocked reports whether the dashboard is locked against edits.
data.namebodystringName is the dashboard's unique internal name.
data.orgIdbodystringOrgID is the org the dashboard belongs to.
data.schemaVersionbodystringSchemaVersion is the dashboard schema version.
data.sourcebodystringSource is where the dashboard came from: user, system or integration.
data.specbodyanySpec is the Perses dashboard spec, carried verbatim as open JSON.
data.tagsbodyo11y.O11yDashboardTag[]Tags are the dashboard's tags.
data.tags[].keybodystringKey is the tag key.
data.tags[].valuebodystringValue is the tag value.
data.updatedAtbodystring (date-time)UpdatedAt is when it last changed.
data.updatedBybodystringUpdatedBy is who last changed it.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y dashboards set <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page