Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
dashboardManagement

Update a dashboard.

Update a dashboard by the given identifier.

put/v2/dashboards/{id}

Path parameters

idstring required

Identifier of the dashboard to update.

Request body

titlestring required

Title of the dashboard.

descriptionstring

Description of the dashboard.

folderIdstring

The identifier of the folder to save the dashboard in. By default it is saved in your personal folder.

domainstring

If set denotes that the dashboard concerns a given domain (e.g. aws, k8s, app).

hierarchiesstring[]

If set to non-empty array denotes that the dashboard concerns given hierarchies.

refreshIntervalinteger

Interval of time (in seconds) to automatically refresh the dashboard. A value of 0 means we never automatically refresh the dashboard. Allowed values are 0, 30, 60, 120, 300, 900, 1800, 3600, 7200, 86400.

themestring

Theme for the dashboard. Either Light or Dark.

isPublicboolean

Is the dashboard public

highlightViolationsboolean

Whether to highlight threshold violations.

Example request

{
  "title": "Kubernetes Dashboard",
  "description": "A view of pods, namespaces and nodes of your cluster.",
  "folderId": "000000000C1C17C6",
  "topologyLabelMap": {
    "data": {
      "service": [
        "kube-scheduler",
        "kube-dns"
      ]
    }
  },
  "domain": "aws",
  "hierarchies": [
    "Kubernetes Node View"
  ],
  "refreshInterval": 30,
  "timeRange": {
    "type": "BeginBoundedTimeRange",
    "from": {
      "type": "RelativeTimeRangeBoundary",
      "relativeTime": "-15m"
    }
  },
  "panels": [
    {
      "id": "2F7D449E3D511066",
      "key": "panelca6280e4a75fca45",
      "title": "This panel shows memory usage for your kubernetes pod.",
      "visualSettings": "{\\\"general\\\":{\\\"type\\\":\\\"column\\\"}",
      "panelType": "SumoSearchPanel"
    }
  ],
  "layout": {
    "layoutType": "Grid",
    "layoutStructures": [
      {
        "key": "panelPANE-3DC454FD977E2A46",
        "structure": "{\\\"height\\\":5,\\\"width\\\":9,\\\"x\\\":0,\\\"y\\\":0}"
      }
    ]
  },
  "variables": [
    {
      "name": "_sourceHost",
      "displayName": "Source Host",
      "defaultValue": "default_value",
      "sourceDefinition": {
        "variableSourceType": "MetadataVariableSourceDefinition"
      },
      "includeAllOption": true,
      "valueType": "Any"
    }
  ],
  "theme": "light",
  "organizations": {
    "defaultOrgIds": [
      "us2-00000000FF42A0C3"
    ]
  }
}

Response

The dashboard was successfully modified.

titlestring required

Title of the dashboard.

descriptionstring

Description of the dashboard.

folderIdstring

The identifier of the folder to save the dashboard in. By default it is saved in your personal folder.

domainstring

If set denotes that the dashboard concerns a given domain (e.g. aws, k8s, app).

hierarchiesstring[]

If set to non-empty array denotes that the dashboard concerns given hierarchies.

refreshIntervalinteger

Interval of time (in seconds) to automatically refresh the dashboard. A value of 0 means we never automatically refresh the dashboard. Allowed values are 0, 30, 60, 120, 300, 900, 1800, 3600, 7200, 86400.

themestring

Theme for the dashboard. Either Light or Dark.

isPublicboolean

Is the dashboard public

highlightViolationsboolean

Whether to highlight threshold violations.

idstring

Unique identifier for the dashboard. This id is used to get detailed information about the dashboard, such as panels, variables and the layout.

contentIdstring

Content identifier for the dashboard. This id is used to connect to the Sumo Content Library and get general metadata about the dashboard. Use this id if you want to search for dashboards in Sumo folders.

scheduleIdstring

Scheduled report identifier for the dashboard. Only most recently modified report schedule is rerun per dashboard. This id is used to manage the schedule details through the scheduled report API.

scheduleCountinteger

Count of report schedules for the dashboard.

Example response

{
  "title": "Kubernetes Dashboard",
  "description": "A view of pods, namespaces and nodes of your cluster.",
  "folderId": "000000000C1C17C6",
  "topologyLabelMap": {
    "data": {
      "service": [
        "kube-scheduler",
        "kube-dns"
      ]
    }
  },
  "domain": "aws",
  "hierarchies": [
    "Kubernetes Node View"
  ],
  "refreshInterval": 30,
  "timeRange": {
    "type": "BeginBoundedTimeRange",
    "from": {
      "type": "RelativeTimeRangeBoundary",
      "relativeTime": "-15m"
    }
  },
  "panels": [
    {
      "id": "2F7D449E3D511066",
      "key": "panelca6280e4a75fca45",
      "title": "This panel shows memory usage for your kubernetes pod.",
      "visualSettings": "{\\\"general\\\":{\\\"type\\\":\\\"column\\\"}",
      "panelType": "SumoSearchPanel"
    }
  ],
  "layout": {
    "layoutType": "Grid",
    "layoutStructures": [
      {
        "key": "panelPANE-3DC454FD977E2A46",
        "structure": "{\\\"height\\\":5,\\\"width\\\":9,\\\"x\\\":0,\\\"y\\\":0}"
      }
    ]
  },
  "variables": [
    {
      "name": "_sourceHost",
      "displayName": "Source Host",
      "defaultValue": "default_value",
      "sourceDefinition": {
        "variableSourceType": "MetadataVariableSourceDefinition"
      },
      "includeAllOption": true,
      "valueType": "Any"
    }
  ],
  "theme": "light",
  "organizations": {
    "defaultOrgIds": [
      "us2-00000000FF42A0C3"
    ]
  },
  "id": "B23OjNs5ZCyn5VdMwOBoLo3PjgRnJSAlNTKEDAcpuDG2CIgRe9KFXMofm2H2",
  "contentId": "1",
  "scheduleId": "RdQHYPh2jxoS90DXtKfA7nAJV2rsQ9BncpfY7IkjNzQWi52ug85W7r6Rrmtd",
  "scheduleCount": 10
}