Update a dashboard

put

https://api.checklyhq.com/v1/dashboards/{dashboardId}

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

Path Params

dashboardId

string

required

Body Params

customDomain

string

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

customUrl

string

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

logo

string

A URL pointing to an image file.

favicon

string

A URL pointing to an image file used as dashboard favicon.

link

string

A URL link to redirect when dashboard logo is clicked on.

description

string

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

width

string

enum

Defaults to FULL

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

Allowed:

refreshRate

number

enum

Defaults to 60

How often to refresh the dashboard in seconds.

Allowed:

paginate

boolean

Defaults to true

Determines of pagination is on or off.

paginationRate

number

enum

Defaults to 60

How often to trigger pagination in seconds.

Allowed:

checksPerPage

number

1 to 20

Defaults to 15

Number of checks displayed per page.

useTagsAndOperator

boolean

Defaults to false

When to use AND operator for tags lookup.

hideTags

boolean

Defaults to false

Show or hide the tags on the dashboard.

enableIncidents

boolean

Defaults to false

Enable or disable incidents on the dashboard.

expandChecks

boolean

Defaults to false

Expand or collapse checks on the dashboard.

200Successful

401Unauthorized

403Forbidden

404Not Found

409Conflict

429Too Many Requests