layouts

Update dashboard information.

Update either the dashboard name or the dashboard cells

patch/dashboards/{id}

Request

Base URL
/chronograf/v1 (relative, and the document was published on a file host, not at the API’s origin)
URL
/chronograf/v1/dashboards/{id}
Auth
none declared

Path parameters

idinteger required

ID of a dashboard

Request body

idstring

the unique dashboard id

namestring

the user-facing name of the dashboard

Example request

{
  "id": "4",
  "cells": [
    {
      "x": 5,
      "y": 5,
      "w": 4,
      "h": 4,
      "name": "usage_user",
      "queries": [
        {
          "query": "SELECT mean(\"usage_user\") AS \"usage_user\" FROM \"cpu\"",
          "db": "telegraf",
          "label": "%"
        }
      ],
      "type": "line"
    },
    {
      "x": 0,
      "y": 0,
      "w": 4,
      "h": 4,
      "name": "usage_system",
      "queries": [
        {
          "query": "SELECT mean(\"usage_system\") AS \"usage_system\" FROM \"cpu\"",
          "db": "telegraf",
          "label": "%"
        }
      ],
      "type": "line"
    }
  ],
  "name": "lalalalala",
  "links": {
    "self": "/chronograf/v1/dashboards/4"
  }
}

Response

Dashboard has been updated and the new dashboard is returned.