# Update dashboards

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

> Applies an RFC 6902 JSON Patch to a v2-shape dashboard.

`PATCH /v1/o11y/dashboards/{id}`

> [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/{id}` |
| **Method**    | `PATCH`                                        |
| **Operation** | `PatchDashboardV2`                             |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`         |

Applies an RFC 6902 JSON Patch to a v2-shape dashboard. The
patch is applied against the postable view (metadata, spec, tags), so individual
panels, queries, variables, layouts or tags can be updated without re-sending the
rest. Apply is lenient — remove on a missing path is a no-op and add creates any
missing parent objects — and the result is still validated. Locked dashboards are
rejected. The request body is the bare JSON Patch operations array.

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

## Request

7 fields, body `application/json` (required).

| Field         | In   | Type                         | Required | Description                                                                                               |
| ------------- | ---- | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `id`          | path | string                       | yes      | ID is the dashboard id from the path.                                                                     |
| `id`          | body | string                       | —        | ID is the dashboard id from the path.                                                                     |
| `ops`         | body | o11y.O11yDashboardPatchOp\[] | —        | Ops are the JSON Patch operations, applied in order.                                                      |
| `ops[].from`  | body | string                       | —        | From is the source JSON Pointer for move and copy; ignored otherwise.                                     |
| `ops[].op`    | body | string                       | —        | Op is the verb: add, remove, replace, move, copy or test.                                                 |
| `ops[].path`  | body | string                       | —        | Path is a JSON Pointer into the postable dashboard, e.g. /spec/display/name, /spec/panels/\<id>, /tags/-. |
| `ops[].value` | body | any                          | —        | Value is the value to add/replace/test; its type depends on Path.                                         |

## Response

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

`200` 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 update <id>
```

**SDK**

**.ts**

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

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchDashboardV2({ id: 'id', id: "<id>", ops: [{"from":"<from>","op":"<op>","path":"<path>","value":"<value>"}] });
```

**.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).patch_dashboard_v2(id='id', id="<id>", ops=[{"from":"<from>","op":"<op>","path":"<path>","value":"<value>"}])
```

**.go**

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

resp, _, err := client.O11yAPI.PatchDashboardV2(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::patch_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).patchDashboardV2();
```

**HTTP**

```bash
curl -X PATCH https://api.hanzo.ai/v1/o11y/dashboards/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "ops": [
         {
           "from": "<from>",
           "op": "<op>",
           "path": "<path>",
           "value": "<value>"
         }
       ]
     }'
```

**MCP**

Tool `o11y`, op `PatchDashboardV2` — 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": "PatchDashboardV2",
           "input": {
             "id": "<id>",
             "ops": [
               {
                 "from": "<from>",
                 "op": "<op>",
                 "path": "<path>",
                 "value": "<value>"
               }
             ]
           }
         }
       }
     }'
```

---

[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)
