From d1081ac65d50ca82bd13fed075da9732dee9c2e4 Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Fri, 15 May 2026 23:08:51 +0200 Subject: [PATCH] Deprecate legacy Swagger spec in API docs --- api-reference/overview.mdx | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/api-reference/overview.mdx b/api-reference/overview.mdx index 3ac5b152..9a57017a 100644 --- a/api-reference/overview.mdx +++ b/api-reference/overview.mdx @@ -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. @@ -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. +## API specification + +Use `https://api.checklyhq.com/openapi.json` for the current Checkly Public API specification. + + + 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`. + + ## 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). @@ -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. \ No newline at end of file +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.