Skip to content

Deprecate legacy Swagger spec in API docs #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thebiglabasky merged 1 commit into from
May 15, 2026
Merged

Deprecate legacy Swagger spec in API docs #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion api-reference/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: 'Using the Checkly API'
sidebarTitle: 'Overview'
description: 'Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.'
---

The Checkly API enables you to manage your monitoring infrastructure, retrieve account information, and export analytics using HTTP requests.
Expand All @@ -9,6 +10,14 @@ The Checkly API enables you to manage your monitoring infrastructure, retrieve a
For creating and updating resources, we recommend using the [Checkly CLI](/cli/overview) or another [Monitoring as Code](/learn/monitoring/monitoring-as-code/) option. Managing resources using the Checkly API is possible, but Monitoring as Code generally provides a better experience for this.
</Note>

## API specification

Use `https://api.checklyhq.com/openapi.json` for the current Checkly Public API specification.

<Warning>
The legacy `https://api.checklyhq.com/swagger.json` specification is deprecated and no longer receives updates. If you generate API clients, validate requests, or inspect the latest API contract, update your tooling to use `openapi.json`.
</Warning>

## Authentication

The Checkly Public API uses API keys to authenticate requests. You can get a API Key in your [user settings](https://app.checklyhq.com/settings/user/api-keys).
Expand All @@ -31,4 +40,4 @@ The Checkly Public API uses rate limits to help manage the sheer volume of reque

For most of our routes, that limit is **600 requests every 60 seconds**.

However, we also have **routes with custom rate limits**. If the endpoint you are using has a custom rate limit, you will find that information in the documentation of that route.
However, we also have **routes with custom rate limits**. If the endpoint you are using has a custom rate limit, you will find that information in the documentation of that route.