How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Checkly Dashboards API

The Dashboards API from Checkly — 5 operation(s) for dashboards.

Checkly Dashboards API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Dashboards API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — The Checkly Public API uses API keys to authenticate requests. You can get the API Key here . Your API key is like a password: keep it secure! Authentication t…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Dashboards 5
GET
/v1/dashboards
List all dashboards
getV1Dashboards 3 params → 200401403429
POST
/v1/dashboards
Create a dashboard
postV1Dashboards 1 param body → 201400401403409429
DELETE
/v1/dashboards/{dashboardId}
Delete a dashboard
deleteV1DashboardsDashboardid 2 params → 204401403429
GET
/v1/dashboards/{dashboardId}
Retrieve a dashboard
getV1DashboardsDashboardid 2 params → 200401403404429
PUT
/v1/dashboards/{dashboardId}
Update a dashboard
putV1DashboardsDashboardid 2 params body → 200400401403404409429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are DashboardListItem (30 properties), Dashboard (29 properties), DashboardUpdate (26 properties), DashboardCreate (26 properties). Each schema is shown below with its type and property counts.

DashboardTagList
array
A list of one or more tags that filter which checks to display on the dashboard.
ProjectBindingV1
object
2 properties 2 required
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
ApiError
object
3 properties 3 required
DashboardCreate
object
26 properties 1 required
ProjectBindingDetailsV1
object
The resource's side of this binding.
2 properties 2 required
ProjectBindingsV1
object
The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
2 properties 2 required
ProjectBindingOwnerV1
objectnull
The project that owns this resource — the one whose deploy can delete it. Null when no project owns it, including when other projects merely reference it. In t…
2 properties 2 required
BindingProjectV1
object
The project this binding is to.
3 properties 3 required
Dashboard
object
29 properties 3 required
DashboardListItem
object
30 properties 3 required
DashboardsList
array
DashboardUpdate
object
26 properties
DashboardKey
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-dashboards-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly Accounts API
Checkly Alert Channels API
Checkly Analytics API
Checkly Check Alerts API
Checkly Check Groups API
Checkly Check Results API
Checkly Checks API
Checkly Heartbeats API
Checkly Incidents API
Checkly Maintenance Windows API
Checkly Private Locations API
Where this information came from

This is an independent, third-party profile of Checkly Dashboards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.