Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Checkly Accounts API

The Accounts API from Checkly — 2 operation(s) for accounts.

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

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

This API exposes 2 operations across 2 paths, 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.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://api.checklyhq.com
Authentication
HTTP Bearer, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Checkly Accounts 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-keys
  • accountId — Your Checkly account ID. You can find it at https://app.checklyhq.com/settings/account/general

Paths & Operations 2

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

Accounts 2
GET
/v1/accounts
List Accounts
listAccounts 2 params → 200
GET
/v1/accounts/{accountId}
Get Account
getAccount 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Account (7 properties), PaginationMeta (4 properties), AccountList (2 properties). Each schema is shown below with its type and property counts.

Account
object
7 properties
PaginationMeta
object
4 properties
AccountList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-accounts-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly Alert Channels API
Checkly Analytics API
Checkly Check Alerts API
Checkly Check Groups API
Checkly Check Results API
Checkly Check Statuses API
Checkly Checks API
Checkly Dashboards API
Checkly Heartbeats API
Checkly Incidents API
Checkly Locations API