Hanzo
OpenapiO11y

Creates a dashboard in the v2 format that follows the Perses spec and answers…

Creates a dashboard in the v2 format that follows the Perses spec and answers with the stored dashboard.

POST /v1/o11y/dashboards

Addresshttps://api.hanzo.ai/v1/o11y/dashboards
MethodPOST
OperationCreateDashboardV2
AuthAuthorization: Bearer $HANZO_API_KEY

Creates a dashboard in the v2 format that follows the Perses spec and answers with the stored dashboard.

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

Request

8 fields, body application/json (required).

FieldInTypeRequiredDescription
generateNamebodybooleanGenerateName derives a fresh unique name from spec.display.name instead of taking Name.
imagebodystringImage is an optional cover image reference.
namebodystringName is the dashboard's unique internal name (a DNS-1123 label).
schemaVersionbodystringSchemaVersion is the dashboard schema version; must be the current v6.
specbodyanySpec is the Perses dashboard spec (display, variables, panels, layouts, datasources).
tagsbodyo11y.O11yDashboardPostableTag[]Tags are the dashboard's tags; at most ten, and none may use a reserved DSL key.
tags[].keybodystringKey is the tag key.
tags[].valuebodystringValue is the tag value.

Response

StatusBodyMeaning
201o11y.O11yDashboardOutcreated

201 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 create

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page