Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks15

Client certificates4

Dashboards5

Deployment Triggers2

Elements2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors14

Private locations8

Reporting1

Rocky AI3

Runtimes2

Secret scans1

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Status Pages V37

Status Pages V3 Automation Rules5

Status Pages V3 Components5

Status Pages V3 Incidents11

Status Pages V3 Subscribers3

Test Session Error Groups4

Test sessions7

Triggers6

Usage8

Dashboards

Update a dashboard

Changed on Oct 31, 2026

Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.

put/v1/dashboards/{dashboardId}

Request

Base URL
https://api.checklyhq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v1/dashboards/:dashboardId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

dashboardIdstring required

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Request body

customUrlstring nullable

A subdomain name under "checklyhq.com". Needs to be unique across all users.

customDomainstring nullable

A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.

headerstring

A piece of text displayed at the top of your dashboard.

descriptionstring nullable

A piece of text displayed below the header or title of your dashboard.

width'FULL' | '960PX'

Determines whether to use the full screen or focus in the center.

refreshRatenumber

How often to refresh the dashboard in seconds.

paginateboolean

Determines of pagination is on or off.

paginationRatenumber

How often to trigger pagination in seconds.

sortByStatusboolean

Sort checks by status with failing checks first.

checksPerPagenumber nullable

Number of checks displayed per page.

useTagsAndOperatorboolean nullable

When to use AND operator for tags lookup.

hideTagsboolean

Show or hide the tags on the dashboard.

enableIncidentsboolean

Enable or disable incidents on the dashboard.

expandChecksboolean

Expand or collapse checks on the dashboard.

tagsstring[]

A list of one or more tags that filter which checks to display on the dashboard.

showHeaderboolean

Show or hide header and description on the dashboard.

showCheckRunLinksboolean

Show or hide check run links on the dashboard.

showGroupNamesboolean

Show or hide group names on the dashboard.

customCSSstring nullable

Custom CSS to be applied to the dashboard.

isPrivateboolean

Determines if the dashboard is public or private.

showP95boolean

Show or hide the P95 stats on the dashboard.

showP99boolean

Show or hide the P99 stats on the dashboard.

Response

Successful

customUrlstring nullable

A subdomain name under "checklyhq.com". Needs to be unique across all users.

customDomainstring nullable

A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.

headerstring

A piece of text displayed at the top of your dashboard.

descriptionstring nullable

A piece of text displayed below the header or title of your dashboard.

width'FULL' | '960PX'

Determines whether to use the full screen or focus in the center.

refreshRatenumber

How often to refresh the dashboard in seconds.

paginateboolean

Determines of pagination is on or off.

paginationRatenumber

How often to trigger pagination in seconds.

sortByStatusboolean

Sort checks by status with failing checks first.

checksPerPagenumber nullable

Number of checks displayed per page.

useTagsAndOperatorboolean nullable

When to use AND operator for tags lookup.

hideTagsboolean

Show or hide the tags on the dashboard.

enableIncidentsboolean

Enable or disable incidents on the dashboard.

expandChecksboolean

Expand or collapse checks on the dashboard.

tagsstring[]

A list of one or more tags that filter which checks to display on the dashboard.

showHeaderboolean

Show or hide header and description on the dashboard.

showCheckRunLinksboolean

Show or hide check run links on the dashboard.

showGroupNamesboolean

Show or hide group names on the dashboard.

customCSSstring nullable

Custom CSS to be applied to the dashboard.

isPrivateboolean

Determines if the dashboard is public or private.

showP95boolean

Show or hide the P95 stats on the dashboard.

showP99boolean

Show or hide the P99 stats on the dashboard.

idnumber required

dashboardIdstring required

The dashboard ID.

created_atstring date-time required

Changes

Oct 31, 2026bc90d1bfa738 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Jul 13, 2026a4fea1ad9b9a Revision changes
- breaking
  request body became required
- breaking
  for the header request parameter x-checkly-account, the format changed from no format to uuid
- breaking
  the request property became not nullable
- breaking
  the request property became not nullable
- breaking
  the request property became not nullable
- breaking
  removed the enum value 30.00 of the request property
- breaking
  removed the enum value 300.00 of the request property
- breaking
  removed the enum value 300.00 of the request property
- breaking
  removed the enum value 60.00 of the request property
- breaking
  removed the enum value 60.00 of the request property
- breaking
  removed the enum value 600.00 of the request property
- breaking
  the request property type changed from string to no type
- breaking
  the // request property format changed from no format to uuid
- breaking
  the request property type changed from string to no type
- breaking
  the request property type changed from string to no type
- breaking
  the response property became nullable for the status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the // response's property format changed from date to date-time for status
- breaking
  the // response's property format changed from date to date-time for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the new optional request property
- info
  added subschema #1 subschema #2 subschema #3 to the request property anyOf list
- info
  added subschema #1 subschema #2 subschema #3 to the request property anyOf list
- info
  added subschema #1 subschema #2 subschema #3 to the request property anyOf list
- info
  the request property became nullable
- info
  the request property default value was added
- info
  the request property default value was added
- info
  the // request property format was generalized from date to date-time
- info
  the // request property format was generalized from date to date-time
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added subschema #1 subschema #2 subschema #3 to the response property anyOf list for the response status
- info
  added subschema #1 subschema #2 subschema #3 to the response property anyOf list for the response status
- info
  added subschema #1 subschema #2 subschema #3 to the response property anyOf list for the response status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response's property default value was added for the status
- info
  the response's property default value was added for the status
- info
  removed the 30.00 enum value from the response property for the response status
- info
  removed the 300.00 enum value from the response property for the response status
- info
  removed the 300.00 enum value from the response property for the response status
- info
  removed the 401.00 enum value from the response property for the response status
- info
  removed the 403.00 enum value from the response property for the response status
- info
  removed the 404.00 enum value from the response property for the response status
- info
  removed the 409.00 enum value from the response property for the response status
- info
  removed the 429.00 enum value from the response property for the response status
- info
  removed the 60.00 enum value from the response property for the response status
- info
  removed the 60.00 enum value from the response property for the response status
- info
  removed the 600.00 enum value from the response property for the response status
- info
  removed the Conflict enum value from the response property for the response status
- info
  removed the Forbidden enum value from the response property for the response status
- info
  removed the Not Found enum value from the response property for the response status
- info
  removed the Too Many Requests enum value from the response property for the response status
- info
  removed the Unauthorized enum value from the response property for the response status

Operation history