v2
latestOpenAPI 3.0.02026-07-261859071.2 MBCreate a dashboard
Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.
Headers
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Request body
A subdomain name under "checklyhq.com". Needs to be unique across all users.
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
A piece of text displayed at the top of your dashboard.
A piece of text displayed below the header or title of your dashboard.
Determines whether to use the full screen or focus in the center.
How often to refresh the dashboard in seconds.
Determines of pagination is on or off.
How often to trigger pagination in seconds.
Sort checks by status with failing checks first.
Number of checks displayed per page.
When to use AND operator for tags lookup.
Show or hide the tags on the dashboard.
Enable or disable incidents on the dashboard.
Expand or collapse checks on the dashboard.
A list of one or more tags that filter which checks to display on the dashboard.
Show or hide header and description on the dashboard.
Show or hide check run links on the dashboard.
Show or hide group names on the dashboard.
Custom CSS to be applied to the dashboard.
Determines if the dashboard is public or private.
Show or hide the P95 stats on the dashboard.
Show or hide the P99 stats on the dashboard.
Response
Created
A subdomain name under "checklyhq.com". Needs to be unique across all users.
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
A piece of text displayed at the top of your dashboard.
A piece of text displayed below the header or title of your dashboard.
Determines whether to use the full screen or focus in the center.
How often to refresh the dashboard in seconds.
Determines of pagination is on or off.
How often to trigger pagination in seconds.
Sort checks by status with failing checks first.
Number of checks displayed per page.
When to use AND operator for tags lookup.
Show or hide the tags on the dashboard.
Enable or disable incidents on the dashboard.
Expand or collapse checks on the dashboard.
A list of one or more tags that filter which checks to display on the dashboard.
Show or hide header and description on the dashboard.
Show or hide check run links on the dashboard.
Show or hide group names on the dashboard.
Custom CSS to be applied to the dashboard.
Determines if the dashboard is public or private.
Show or hide the P95 stats on the dashboard.
Show or hide the P99 stats on the dashboard.
The dashboard ID.