PATCH /api/v1/dashboards/{pk}/
Partially update a dashboard definition
Request
- Base URLhttps://uptime.com (the document declares no server; this is the origin it was published from)
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
Include checks from this list
Include checks with one or more of the selected tags
Sidebar ordering for this dashboard
The displayed name for this dashboard
Whether this dashboard is pinned to the sidebar
Show/hide the Summary Metrics section at the top of this dashboard
Include metrics from all checks, not just the selected checks
Show/hide the check cards from this dashboard
Number of check cards to show in the Checks section
When true, checks must have all selected tags; when false, checks need only one
Include/exclude checks which are currently up
Include/exclude checks which are currently down
Include/exclude checks which are currently paused
Include/exclude checks which are manually marked for maintenance
The primary value for ordering the checks
The secondary value for ordering the checks, if the primary value is the same
Show the 24h uptime percentage on each check card
Show the response time graph or metric on each check card
Show/hide the Latest Alerts section from this dashboard
Show/hide alerts globally across all checks, rather than only for checks selected in the Checks tab
Include/exclude alerts marked as "ignored" in the alerts listing
Include/exclude alerts that are no longer down in the alerts listing
Number of alerts to show in the Latest Alerts section
Response
Include checks from this list
Include checks with one or more of the selected tags
Sidebar ordering for this dashboard
The displayed name for this dashboard
Whether this dashboard is pinned to the sidebar
Show/hide the Summary Metrics section at the top of this dashboard
Include metrics from all checks, not just the selected checks
Show/hide the check cards from this dashboard
Number of check cards to show in the Checks section
When true, checks must have all selected tags; when false, checks need only one
Include/exclude checks which are currently up
Include/exclude checks which are currently down
Include/exclude checks which are currently paused
Include/exclude checks which are manually marked for maintenance
The primary value for ordering the checks
The secondary value for ordering the checks, if the primary value is the same
Show the 24h uptime percentage on each check card
Show the response time graph or metric on each check card
Show/hide the Latest Alerts section from this dashboard
Show/hide alerts globally across all checks, rather than only for checks selected in the Checks tab
Include/exclude alerts marked as "ignored" in the alerts listing
Include/exclude alerts that are no longer down in the alerts listing
Number of alerts to show in the Latest Alerts section
Changes
No recorded changes to this operation across all 1 revision of this API.