---
title: "PUT /api/v1/config/dashboards/{slug}"
method: PUT
path: "/api/v1/config/dashboards/{slug}"
tags: ["Dashboard"]
---

# PUT /api/v1/config/dashboards/{slug}

`PUT /api/v1/config/dashboards/{slug}`

## Path parameters

- `slug` string, required

## Request body

- ConfigV1UpdateDashboardBody
  - `dashboard` Configv1Dashboard
    - `slug` string — Unique identifier of the Dashboard. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the Dashboard is created.
    - `name` string — Required. Name of the Dashboard. You can modify this value after the Dashboard is created.
    - `created_at` string, date-time — Timestamp of when the Dashboard was created. Cannot be set by clients.
    - `updated_at` string, date-time — Timestamp of when the Dashboard was last updated. Cannot be set by clients.
    - `collection_slug` string — Optional. Slug of the collection the dashboard belongs to.
    - `collection` Configv1CollectionReference
      - `type` 'SIMPLE' | 'SERVICE' — Type values must match entitiespb.Collection.CollectionType.
      - `slug` string
    - `dashboard_json` string — Raw JSON representation that defines the structure of the dashboard.
    - `labels` object — Optional. Defines tags that add metadata about the dashboard.
  - `create_if_missing` boolean — If true, the Dashboard will be created if it does not already exist, identified by slug. If false, an error will be returned if the Dashboard does not already exist.
  - `dry_run` boolean — If true, the Dashboard isn't created or updated, and no response Dashboard will be returned. The response will return an error if the given Dashboard is invalid.

## Response `200`

A successful response containing the updated Dashboard.

- Configv1UpdateDashboardResponse
  - `dashboard` Configv1Dashboard
    - `slug` string — Unique identifier of the Dashboard. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the Dashboard is created.
    - `name` string — Required. Name of the Dashboard. You can modify this value after the Dashboard is created.
    - `created_at` string, date-time — Timestamp of when the Dashboard was created. Cannot be set by clients.
    - `updated_at` string, date-time — Timestamp of when the Dashboard was last updated. Cannot be set by clients.
    - `collection_slug` string — Optional. Slug of the collection the dashboard belongs to.
    - `collection` Configv1CollectionReference
      - `type` 'SIMPLE' | 'SERVICE' — Type values must match entitiespb.Collection.CollectionType.
      - `slug` string
    - `dashboard_json` string — Raw JSON representation that defines the structure of the dashboard.
    - `labels` object — Optional. Defines tags that add metadata about the dashboard.

## Other responses

- `400` — Cannot update the Dashboard because the request is invalid.
- `404` — Cannot update the Dashboard because the slug does not exist.
- `409` — Cannot update the Dashboard because there is a conflict with an existing Dashboard.
- `500` — An unexpected error response.
- `default` — An undefined error response.

---

[API](https://skmtc.net/chronosphere/apis/config-v1-api.md) · [All operations](https://skmtc.net/chronosphere/apis/config-v1-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chronosphere/config-v1-api/versions/530951bd2ccf/schema)