Returns the user's dashboard configuration. If no configuration exists, returns an empty object `{}`
GET /api/user/dashboards
GET
/api/user/dashboards
Auto-generated from server.go. Handler: s.getUserDashboards.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”Successful response
Returns the user’s dashboard configuration. If no configuration exists, returns an empty object {}.
Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/user/dashboards against the demo. Required fields are conservative — server returned all of them in the seed; relax to optional if some states legitimately omit.
object
dashboards
required
object
alarms-actions
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
client-behavior
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
dhcpv6
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
firewall
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
enabled
required
boolean
thresholds
required
object
critical
required
integer
warning
required
integer
kioskMode
required
boolean
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
refreshInterval
required
integer
timeRange
required
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
firewall-advanced
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
network-health
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
noc
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
system-stats
required
object
createdAt
required
string format: date-time
description
required
string
id
required
string
isDefault
required
boolean
layouts
required
object
lg
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
md
required
array
sm
required
array
xl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
xs
required
array
xxl
required
Array<object>
object
h
required
integer
i
required
string
maxH
required
integer
maxW
required
integer
minH
required
integer
minW
required
integer
w
required
integer
x
required
integer
y
required
integer
moved
boolean
static
boolean
name
required
string
nocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
settings
required
object
gridCols
required
integer
refreshInterval
required
integer
theme
required
string
timeRange
required
object
end
required
string
start
required
string
protocol
string
updatedAt
required
string format: date-time
version
required
integer
widgets
required
Array<object>
object
displayOptions
required
object
showLegend
required
boolean
showTitle
required
boolean
instanceId
required
string
position
required
object
h
required
integer
w
required
integer
x
required
integer
y
required
integer
settings
required
object
refreshInterval
required
integer
refreshMode
required
string
title
required
string
widgetId
required
string
activeDashboardId
required
string
dashboardOrder
required
Array<string>
globalNocSettings
required
object
alertEscalation
required
object
colorOnly
required
boolean
enabled
required
boolean
thresholds
required
object
critical
required
integer
elevated
required
integer
warning
required
integer
kioskMode
required
boolean
rotationDashboards
required
array
rotationEnabled
required
boolean
rotationInterval
required
integer
Authentication is required or the supplied token is invalid.
Standardised error envelope per RFC 7807. Many existing endpoints still
return an older shape (e.g. {"error": "..."}). This schema documents the
target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the
spec describes current behaviour without enforcing the migration here.
object
type
A URI reference that identifies the problem type.
string format: uri-reference
title
A short human-readable summary of the problem.
string
status
The HTTP status code generated by the origin server.
integer format: int32
detail
A human-readable explanation specific to this occurrence.
string
instance
A URI reference that identifies the specific occurrence.
string format: uri-reference
error
Legacy error message field. Will be removed once handlers are migrated.
string
details
Legacy per-field error details. Will be removed once handlers are migrated.
object
key
additional properties
string
requestId
The request id middleware-assigned identifier for tracing.
string
Internal server error
Standardised error envelope per RFC 7807. Many existing endpoints still
return an older shape (e.g. {"error": "..."}). This schema documents the
target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the
spec describes current behaviour without enforcing the migration here.
object
type
A URI reference that identifies the problem type.
string format: uri-reference
title
A short human-readable summary of the problem.
string
status
The HTTP status code generated by the origin server.
integer format: int32
detail
A human-readable explanation specific to this occurrence.
string
instance
A URI reference that identifies the specific occurrence.
string format: uri-reference
error
Legacy error message field. Will be removed once handlers are migrated.
string
details
Legacy per-field error details. Will be removed once handlers are migrated.
object
key
additional properties
string
requestId
The request id middleware-assigned identifier for tracing.
string