Endpoint Groups

Dashboards

Dashboard and widget authoring plus resolved dashboard views.

List dashboardsGET

/dashboards

Operation IDlistDashboards

Query Parameters

Name	Type	Required	Description
`max_results`	`integer`	`false`	-
`owner`	`string`	`false`	-
`page_token`	`string`	`false`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`429`	Client error
`500`	Server error

Create dashboardPOST

/dashboards

Operation IDcreateDashboard

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Get dashboardGET

/dashboards/{dashboardId}

Operation IDgetDashboard

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

Update dashboardPATCH

/dashboards/{dashboardId}

Operation IDupdateDashboard

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Delete dashboardDELETE

/dashboards/{dashboardId}

Operation IDdeleteDashboard

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Get resolved dashboardGET

/dashboards/{dashboardId}/resolved

Operation IDgetResolvedDashboard

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

Create dashboard widgetPOST

/dashboards/{dashboardId}/widgets

Operation IDcreateDashboardWidget

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Update dashboard widgetPATCH

/dashboards/{dashboardId}/widgets/{widgetId}

Operation IDupdateDashboardWidget

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-
`widgetId`	`string`	`true`	-

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Delete dashboard widgetDELETE

/dashboards/{dashboardId}/widgets/{widgetId}

Operation IDdeleteDashboardWidget

Path Parameters

Name	Type	Required	Description
`dashboardId`	`string`	`true`	-
`widgetId`	`string`	`true`	-

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

← Compute Governance →