Create a customer dashboard.
curl --request POST \ --url https://stratum.example.com/v1/projects/example/observability/dashboards \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "displayName": "example", "description": "example", "body": {}, "tags": { "additionalProperty": "example" } }'Body is validated against the Stratum-shape JSON spec before insert.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Unique in the project; lowercase alphanumerics, ., _ and -, starting alphanumeric.
dashboard document, rendered by stratum-ui.
What the control plane enforces (ValidateDashboardBody; anything
not listed is stored verbatim and never inspected):
schemaVersion— required, must be exactly1.title— required, non-empty. Separate from the resource’s ownname/displayName: this one lives inside the document.widgets— required, at least one entry.widgets[].id— required and unique within the dashboard.widgets[].type— required, one ofline_chart,bar_chart,single_stat,gauge,table,log_stream,text_markdown,link. Anything else is rejected.widgets[].datasource+widgets[].query— required for the data-fetching types (everything excepttext_markdownandlink).datasourcemust bemetricsorlogs.
Everything else passes through unvalidated, including
description, tags, variables, layout and widgets[].position.
Placement is expressed per widget as position (x/y/w/h); a
top-level layout is accepted and stored but the control plane neither
validates nor interprets it.
A minimal body that is accepted — this exact shape is exercised by the
tf/e2e dashboard case, so it is known to work rather than merely
plausible:
{
"schemaVersion": 1,
"title": "Compute overview",
"widgets": [
{ "id": "cpu", "type": "line_chart", "title": "Instance CPU",
"datasource": "metrics", "query": "stratum_compute_instance_cpu_percent",
"position": { "x": 0, "y": 0, "w": 12, "h": 6 } },
{ "id": "notes", "type": "text_markdown", "title": "About" }
]
}Validation failures return 400 INVALID_INPUT naming the first problem
found, one per response.
object
AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no
leading/trailing whitespace) mapped to freeform UTF-8 values
(0-256 bytes). Max 50 tags per resource. Reserved prefixes
(stratum.dev/, stratum.platform_health., stratum:,
aws:) return 400 RESERVED_NAMESPACE on customer input.
PATCH replaces the whole map..
object
Example generated
{ "name": "example", "displayName": "example", "description": "example", "body": {}, "tags": { "additionalProperty": "example" }}Responses
Section titled “Responses”Created.
object
Empty for built-ins (cross-tenant).
dashboard document, rendered by stratum-ui, returned exactly as it was stored.
The control plane validates schemaVersion (must be 1), a top-level
title, at least one widget, unique widgets[].id, a known
widgets[].type, and datasource + query on data-fetching widgets.
Everything else — description, tags, variables, layout,
widgets[].position — is stored verbatim and not interpreted here. See
CreateDashboardRequest.body for the full contract and a working
example.
object
object
Example
{ "origin": "platform.builtin", "state": "active"}Bad request.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Conflicting state.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}