--- title: "Update a dashboard." method: PUT path: "/v2/dashboards/{id}" tags: ["dashboardManagement"] --- # Update a dashboard. `PUT /v2/dashboards/{id}` Update a dashboard by the given identifier. ## Path parameters - `id` string, required ## Request body - DashboardRequest - `title` string, required — Title of the dashboard. - `description` string — Description of the dashboard. - `folderId` string — The identifier of the folder to save the dashboard in. By default it is saved in your personal folder. - `topologyLabelMap` TopologyLabelMap — Map of the topology labels. Each label has a key and a list of values. If a value is `*`, it means the label will match content for all values of its key. - `data` object, required — Map from topology labels to `TopologyLabelValuesList`. - `domain` string — If set denotes that the dashboard concerns a given domain (e.g. `aws`, `k8s`, `app`). - `hierarchies` string[] — If set to non-empty array denotes that the dashboard concerns given hierarchies. - `refreshInterval` integer — 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`. - `timeRange` ResolvableTimeRange, required - `type` string, required — Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`. - `panels` Panel[] — Panels in the dashboard. - `id` string — Unique identifier for the panel. - `key` string, required — Key for the panel. Used to create searches for the queries in the panel and configure the layout of the panel in the dashboard. - `title` string — Title of the panel. - `visualSettings` string — Visual settings of the panel. - `keepVisualSettingsConsistentWithParent` boolean — Keeps the visual settings, like series colors, consistent with the settings of the parent panel. - `panelType` string, required — Type of panel. - `layout` Layout - `layoutType` string, required — The type of panel layout on the Dashboard. For example, Grid, Tabs, or Hierarchical. Currently supports `Grid` only. - `layoutStructures` LayoutStructure[], required — Layout structures for the panel childen. - `key` string, required — The identifier of the panel that this structure applies to. - `structure` string, required — The structure of a panel. - `variables` Variable[] — Variables to apply to the panels. - `id` string — Unique identifier for the variable. - `name` string, required — Name of the variable. The variable name is case-insensitive. - `displayName` string — Display name of the variable shown in the UI. If this field is empty, the name field will be used. The display name is case-insensitive. Only numbers, and underscores are allowed in the variable name. This field is not yet supported by the UI. - `defaultValue` string — Default value of the variable. - `sourceDefinition` VariableSourceDefinition, required - `variableSourceType` string, required — Source type of the variable values. - `allowMultiSelect` boolean — Allow multiple selections in the values dropdown. - `includeAllOption` boolean — Include an "All" option at the top of the variable's values dropdown. - `hideFromUI` boolean — Hide the variable in the dashboard UI. - `valueType` string — The type of value of the variable. Allowed values are `String`, Any` and `Numeric`. - `String` considers as a single phrase and will wrap in double-quotes. - `Any` is all characters. - `Numeric` consists of a numeric value for variables, it will be displayed differently in the UI. - `Integer` is a variable with an `Int` value. - `Long` is a variable with a `Long` value. - `Double` is a variable with a `Double` value. - `Boolean` is a variable with a `Boolean` value. - `theme` string — Theme for the dashboard. Either `Light` or `Dark`. - `isPublic` boolean — Is the dashboard public - `highlightViolations` boolean — Whether to highlight threshold violations. - `organizations` Organizations — The organization details to run the dashboard by - `defaultOrgIds` OrgId[] — The default list of organization IDs to run the dashboard by ## Response `200` The dashboard was successfully modified. - Dashboard - `title` string, required — Title of the dashboard. - `description` string — Description of the dashboard. - `folderId` string — The identifier of the folder to save the dashboard in. By default it is saved in your personal folder. - `topologyLabelMap` TopologyLabelMap — Map of the topology labels. Each label has a key and a list of values. If a value is `*`, it means the label will match content for all values of its key. - `data` object, required — Map from topology labels to `TopologyLabelValuesList`. - `domain` string — If set denotes that the dashboard concerns a given domain (e.g. `aws`, `k8s`, `app`). - `hierarchies` string[] — If set to non-empty array denotes that the dashboard concerns given hierarchies. - `refreshInterval` integer — 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`. - `timeRange` ResolvableTimeRange, required - `type` string, required — Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`. - `panels` Panel[] — Panels in the dashboard. - `id` string — Unique identifier for the panel. - `key` string, required — Key for the panel. Used to create searches for the queries in the panel and configure the layout of the panel in the dashboard. - `title` string — Title of the panel. - `visualSettings` string — Visual settings of the panel. - `keepVisualSettingsConsistentWithParent` boolean — Keeps the visual settings, like series colors, consistent with the settings of the parent panel. - `panelType` string, required — Type of panel. - `layout` Layout - `layoutType` string, required — The type of panel layout on the Dashboard. For example, Grid, Tabs, or Hierarchical. Currently supports `Grid` only. - `layoutStructures` LayoutStructure[], required — Layout structures for the panel childen. - `key` string, required — The identifier of the panel that this structure applies to. - `structure` string, required — The structure of a panel. - `variables` Variable[] — Variables to apply to the panels. - `id` string — Unique identifier for the variable. - `name` string, required — Name of the variable. The variable name is case-insensitive. - `displayName` string — Display name of the variable shown in the UI. If this field is empty, the name field will be used. The display name is case-insensitive. Only numbers, and underscores are allowed in the variable name. This field is not yet supported by the UI. - `defaultValue` string — Default value of the variable. - `sourceDefinition` VariableSourceDefinition, required - `variableSourceType` string, required — Source type of the variable values. - `allowMultiSelect` boolean — Allow multiple selections in the values dropdown. - `includeAllOption` boolean — Include an "All" option at the top of the variable's values dropdown. - `hideFromUI` boolean — Hide the variable in the dashboard UI. - `valueType` string — The type of value of the variable. Allowed values are `String`, Any` and `Numeric`. - `String` considers as a single phrase and will wrap in double-quotes. - `Any` is all characters. - `Numeric` consists of a numeric value for variables, it will be displayed differently in the UI. - `Integer` is a variable with an `Int` value. - `Long` is a variable with a `Long` value. - `Double` is a variable with a `Double` value. - `Boolean` is a variable with a `Boolean` value. - `theme` string — Theme for the dashboard. Either `Light` or `Dark`. - `isPublic` boolean — Is the dashboard public - `highlightViolations` boolean — Whether to highlight threshold violations. - `organizations` Organizations — The organization details to run the dashboard by - `defaultOrgIds` OrgId[] — The default list of organization IDs to run the dashboard by - `id` string — Unique identifier for the dashboard. This id is used to get detailed information about the dashboard, such as panels, variables and the layout. - `contentId` string — 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. - `scheduleId` string — 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. - `scheduleCount` integer — Count of report schedules for the dashboard. ## Other responses - `default` — Operation failed with an error. --- [API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/versions/18a824df1e78/schema)