# Create dashboards

URL: https://docs.hanzo.ai/docs/openapi/o11y/createdashboardv2

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

`POST /v1/o11y/dashboards`

> [O11y →](https://docs.hanzo.ai/docs/openapi/o11y) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                           |
| ------------- | ----------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/o11y/dashboards` |
| **Method**    | `POST`                                    |
| **Operation** | `CreateDashboardV2`                       |
| **Auth**      | `Authorization: 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).

| Field           | In   | Type                             | Required | Description                                                                             |
| --------------- | ---- | -------------------------------- | -------- | --------------------------------------------------------------------------------------- |
| `generateName`  | body | boolean                          | —        | GenerateName derives a fresh unique name from spec.display.name instead of taking Name. |
| `image`         | body | string                           | —        | Image is an optional cover image reference.                                             |
| `name`          | body | string                           | —        | Name is the dashboard's unique internal name (a DNS-1123 label).                        |
| `schemaVersion` | body | string                           | —        | SchemaVersion is the dashboard schema version; must be the current v6.                  |
| `spec`          | body | any                              | —        | Spec is the Perses dashboard spec (display, variables, panels, layouts, datasources).   |
| `tags`          | body | o11y.O11yDashboardPostableTag\[] | —        | Tags are the dashboard's tags; at most ten, and none may use a reserved DSL key.        |
| `tags[].key`    | body | string                           | —        | Key is the tag key.                                                                     |
| `tags[].value`  | body | string                           | —        | Value is the tag value.                                                                 |

## Response

| Status    | Body                  | Meaning           |
| --------- | --------------------- | ----------------- |
| `201`     | o11y.O11yDashboardOut | created           |
| `202`     | Approval              | held for approval |
| `default` | problem-details       | refused           |

`201` 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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo o11y dashboards create
```

**SDK**

**.ts**

```ts
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.createDashboardV2({ generateName: false, image: "<image>" });
```

**.py**

```python
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).create_dashboard_v2(generate_name=False, image="<image>")
```

**.go**

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

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

**.rs**

```rust
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::create_dashboard_v2(&cfg, Default::default()).await?;
```

**.java**

```java
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).createDashboardV2();
```

**HTTP**

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

**MCP**

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

```bash
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": "CreateDashboardV2",
           "input": {
             "generateName": false,
             "image": "<image>"
           }
         }
       }
     }'
```

---

[O11y API](https://docs.hanzo.ai/docs/openapi/o11y) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
