Update Dashboard
Update a specific dashboard
Request
URI
PUT
https://{api_host}/api/v2/dashboard/{id}
COPY
Path Parameters
string
id
Required
id
Request Body
Dashboard of type(s) application/json
Optional
{
"modifyAclAccess": false,
"hidden": false,
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"orphan": false,
"deleted": false,
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": false,
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": 0,
"charts": [
{
"base": 0,
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": false,
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": false,
"sourceColor": "string",
"secondaryAxis": false,
"scatterPlotSource": "string"
}
],
"noDefaultEvents": false,
"summarization": "string",
"includeObsoleteMetrics": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
]
}
]
}
],
"disableRefreshInLiveMode": false,
"hideChartWarning": false,
"displayDescription": false,
"displaySectionTableOfContents": false,
"displayQueryParameters": false,
"chartTitleScalar": 0,
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": 0,
"defaultEndTime": 0,
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": 0,
"viewsLastWeek": 0,
"viewsLastMonth": 0,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": false,
"creatorId": "string",
"updaterId": "string",
"numCharts": 0,
"numFavorites": 0,
"favorite": false
}boolean
modifyAclAccess
Optional
Whether the user has modify ACL access to the dashboard.
boolean
hidden
Optional
hidden
object
parameters
Optional
Deprecated. An obsolete representation of dashboard parameters
string
name
Required
Name of the dashboard
string
id
Required
Unique identifier, also URL slug, of the dashboard
string
description
Optional
Human-readable description of the dashboard
integer As int64 As int64
createdEpochMillis
Optional
createdEpochMillis
integer As int64 As int64
updatedEpochMillis
Optional
updatedEpochMillis
boolean
systemOwned
Optional
Whether this dashboard is system-owned and not writeable
boolean
orphan
Optional
orphan
boolean
deleted
Optional
deleted
string
customer
Optional
id of the customer to which this dashboard belongs
string
url
Required
Unique identifier, also URL slug, of the dashboard
string
eventFilterType
Optional
How charts belonging to this dashboard should display events. BYCHART is default if unspecified
Possible values are : BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, BYCHARTANDDASHBOARD,
boolean
forceV2UI
Optional
Whether to force this dashboard to use the V2 UI
object
parameterDetails
Optional
The current (as of Wavefront 4.0) JSON representation of dashboard parameters. This is a map from a parameter name to its representation
boolean
disableRefreshInLiveMode
Optional
Refresh variables in Live Mode
boolean
hideChartWarning
Optional
Hide chart warning
boolean
displayDescription
Optional
Whether the dashboard description section is opened by default when the dashboard is shown
boolean
displaySectionTableOfContents
Optional
Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown
boolean
displayQueryParameters
Optional
Whether the dashboard parameters section is opened by default when the dashboard is shown
integer As int32 As int32
chartTitleScalar
Optional
Scale (normally 100) of chart title text size
string
eventQuery
Optional
Event query to run on dashboard charts
string
defaultTimeWindow
Optional
Default time window to query charts
integer As int64 As int64
defaultStartTime
Optional
Default start time in milliseconds to query charts
integer As int64 As int64
defaultEndTime
Optional
Default end time in milliseconds to query charts
string
chartTitleColor
Optional
Text color of the chart title text are, in rgba(rvalue,gvalue,bvalue,avalue)
string
chartTitleBgColor
Optional
Background color of the chart title text area, in rgba(rvalue,gvalue,bvalue,avalue)
integer As int32 As int32
viewsLastDay
Optional
viewsLastDay
integer As int32 As int32
viewsLastWeek
Optional
viewsLastWeek
integer As int32 As int32
viewsLastMonth
Optional
viewsLastMonth
boolean
includeObsoleteMetrics
Optional
Whether to include the obsolete metrics
string
creatorId
Optional
creatorId
string
updaterId
Optional
updaterId
integer As int32 As int32
numCharts
Optional
numCharts
integer As int32 As int32
numFavorites
Optional
numFavorites
boolean
favorite
Optional
favorite
Responses
200
successful operation
Returns ResponseContainerDashboard of type(s) application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"modifyAclAccess": false,
"hidden": false,
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"orphan": false,
"deleted": false,
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": false,
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": 0,
"charts": [
{
"base": 0,
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": false,
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": false,
"sourceColor": "string",
"secondaryAxis": false,
"scatterPlotSource": "string"
}
],
"noDefaultEvents": false,
"summarization": "string",
"includeObsoleteMetrics": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
]
}
]
}
],
"disableRefreshInLiveMode": false,
"hideChartWarning": false,
"displayDescription": false,
"displaySectionTableOfContents": false,
"displayQueryParameters": false,
"chartTitleScalar": 0,
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": 0,
"defaultEndTime": 0,
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": 0,
"viewsLastWeek": 0,
"viewsLastMonth": 0,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": false,
"creatorId": "string",
"updaterId": "string",
"numCharts": 0,
"numFavorites": 0,
"favorite": false
}
}
On This Page
Dashboard Operations
POST
Add Dashboard Access
PUT
Add Dashboard Tag
POST
Create Dashboard
DELETE
Delete Dashboard
POST
Favorite Dashboard
GET
Get All Dashboard
GET
Get Dashboard
GET
Get Dashboard Access Control List
GET
Get Dashboard History
GET
Get Dashboard Tags
GET
Get Dashboard Version
POST
Remove Dashboard Access
DELETE
Remove Dashboard Tag
PUT
Set Dashboard Acl
POST
Set Dashboard Tags
POST
Undelete Dashboard
POST
Unfavorite Dashboard
PUT
Update Dashboard