Checkly Dashboards API
The Dashboards API from Checkly — 1 operation(s) for dashboards.
Checkly Dashboards API is one of 17 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 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://api.checklyhq.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Checkly Dashboards API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
An API key is passed in the header as X-Checkly-Account (accountId).
By default, every request must be authenticated.
bearerAuth— API Key authentication for Checkly API. You can get your API key at https://app.checklyhq.com/settings/user/api-keysaccountId— Your Checkly account ID. You can find it at https://app.checklyhq.com/settings/account/general
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Dashboard (4 properties), PaginationMeta (4 properties), DashboardList (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Checkly 12
Other APIs Checkly publishes across the network.