Create dashboards
POST /api/v1/dashboards: request fields and declared response contract.
POST/api/v1/dashboards
| Permission | dashboard.create |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| name | string | required | non-null | — |
| description | string | optional | non-null | — |
| system | boolean | optional | non-null | false |
Response
201
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.success | boolean | required | non-null | — |
| data.dashboard | object | required | non-null | — |
| data.dashboard.id | string | required | non-null | — |
| data.dashboard.name | string | required | non-null | — |
| data.message | string | required | non-null | — |
Declared failures
| FORBIDDEN | 403 — not retryable |
|---|---|
| NOT_FOUND | 404 — not retryable |
| VALIDATION_ERROR | 400 — not retryable |
Readback
Read the result back with:
- dashboards.get
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
POST /api/v1/dashboards HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"name": "<name>"
}