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.
For creating and updating resources, we recommend using the Checkly CLI or another Monitoring as Code option. Managing resources using the Checkly API is possible, but Monitoring as Code generally provides a better experience for this.
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.
The Checkly Public API uses API keys to authenticate requests. You can get a API Key in your user settings.Your API key is like a password: keep it secure!Authentication to the API is performed using the Bearer auth method in the Authorization header and using the Account ID.For example, set the Authorization and X-Checkly-Account headers when using cURL:
The Checkly Public API uses rate limits to help manage the sheer volume of requests we receive. The rate limit is characterized by allowing a maximum number of requests within a time interval.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.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Checkly Docs","colors":{"primary":"#0075FF","light":"#2B8AFF","dark":"#031834"},"logo":{"light":"https://mintcdn.com/checkly-422f444a/KiRymP194lYB6fu_/logo/light.svg?fit=max\u0026auto=format\u0026n=KiRymP194lYB6fu_\u0026q=85\u0026s=c4c50c3b55e375fe5d06b52fad5c8032","dark":"https://mintcdn.com/checkly-422f444a/KiRymP194lYB6fu_/logo/dark.svg?fit=max\u0026auto=format\u0026n=KiRymP194lYB6fu_\u0026q=85\u0026s=4bb854d62eeba1ed323838710a533a2f"},"favicon":"https://mintcdn.com/checkly-422f444a/9iwkS8Mlm4KfOHnA/racoon_favicon.png?fit=max\u0026auto=format\u0026n=9iwkS8Mlm4KfOHnA\u0026q=85\u0026s=005761353168b62a923dddddc298da2c","navbar":{"links":[{"href":"https://www.checklyhq.com","label":"Home"},{"href":"https://www.checklyhq.com/docs/changelog/changelog/","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.checklyhq.com"}},"footer":{"socials":{"x":"https://x.com/checklyhq","github":"https://github.com/checkly","linkedin":"https://linkedin.com/company/checkly"}},"seo":{"metatags":{"canonical":"https://www.checklyhq.com/docs"}},"integrations":{"segment":{"key":"Bjlk6vx065LS2B25zVBzcfsjTaGrrpAM"},"telemetry":{"enabled":true}},"errors":{"404":{"redirect":false,"title":"Looks like this page has moved!","description":"Please try searching for the new page you're looking for in the search bar or sidebar."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"checkly-422f444a","hasAudioNarration":false,"actualSubdomain":"checkly-422f444a","customDomains":["www.checklyhq.com"],"gitSource":{"type":"github","owner":"checkly","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae11a32a75bb72526f6df1e","collectionId":"671839c3-fcf1-4494-99ba-ac88474f0962","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae11a32a75bb72526f6df1e"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae142ecd92c11e4b3697fe9","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API Reference","count":467},{"language":"default","tag":"Docs","count":209},{"language":"default","tag":"Learn","count":101},{"language":"default","tag":"Detect","count":67},{"language":"default","tag":"Getting Started","count":65},{"language":"default","tag":"Playwright","count":49},{"language":"default","tag":"Integrations","count":46},{"language":"default","tag":"Constructs","count":41},{"language":"default","tag":"Synthetic Monitoring","count":35},{"language":"default","tag":"Checks and Monitors","count":34}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@checklyhq.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.sidebar-group-header{letter-spacing:.04em}.eyebrow,.sidebar-group-header{text-transform:uppercase}li .group{margin-bottom:0!important;padding-bottom:.25rem!important}th{text-align:left}tr{border-bottom:1px solid var(--border-color, rgba(128, 128, 128, 0.15))}.field .font-semibold.text-primary[data-component-part=field-name]{line-height:normal;font-weight:700;font-size:1.15rem}.dark kbd{background-color:rgba(255,255,255,.08);border-color:rgba(255,255,255,.2);color:#e6e6e6}.sign-up-cta{position:relative;border-radius:.5rem;padding:1.5rem;margin:1rem 0;background:linear-gradient(to bottom,#0c449a,#062047);color:#fff}.sign-up-cta-title{font-size:1.25rem;line-height:1.75rem;font-weight:700;text-wrap:balance;margin-bottom:.25rem}.sign-up-cta-title img{display:inline-block;width:2rem;height:2rem;vertical-align:middle;margin-top:-.25rem}.sign-up-cta-body{color:#e2e8f0}.sign-up-cta a{color:inherit}.sign-up-cta a::before{content:\"\";position:absolute;inset:0}header button[aria-label=\"More actions\"],header button[aria-label=\"Open search\"],header button[aria-label=\"Toggle assistant panel\"],header button[aria-label=\"Toggle dark mode\"]{position:relative}header button[aria-label=\"More actions\"]::after,header button[aria-label=\"Open search\"]::after,header button[aria-label=\"Toggle assistant panel\"]::after,header button[aria-label=\"Toggle dark mode\"]::after{content:\"\";position:absolute;top:50%;left:50%;width:44px;height:44px;transform:translate(-50%,-50%)}"}],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"Using the Checkly API","sidebarTitle":"Overview","description":"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.","canonical":"https://www.checklyhq.com/docs/api-reference/overview/","href":"/api-reference/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Checkly API enables you to manage your monitoring infrastructure, retrieve account information, and export analytics using HTTP requests.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`For creating and updating resources, we recommend using the `,_jsx(_components.a,{href:`/cli/overview`,children:`Checkly CLI`}),` or another `,_jsx(_components.a,{href:`/learn/monitoring/monitoring-as-code/`,children:`Monitoring as Code`}),` option. Managing resources using the Checkly API is possible, but Monitoring as Code generally provides a better experience for this.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`api-specification`,children:`API specification`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`https://api.checklyhq.com/openapi.json`}),` for the current Checkly Public API specification.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The legacy `,_jsx(_components.code,{children:`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 `,_jsx(_components.code,{children:`openapi.json`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`The Checkly Public API uses API keys to authenticate requests. You can get a API Key in your `,_jsx(_components.a,{href:`https://app.checklyhq.com/settings/user/api-keys`,children:`user settings`}),`.`]}),`\n`,_jsx(_components.p,{children:`Your API key is like a password: keep it secure!`}),`\n`,_jsx(_components.p,{children:`Authentication to the API is performed using the Bearer auth method in the Authorization header and using the Account ID.`}),`\n`,_jsxs(_components.p,{children:[`For example, set the `,_jsx(_components.code,{children:`Authorization`}),` and `,_jsx(_components.code,{children:`X-Checkly-Account`}),` headers when using cURL:`]}),`\n`,_jsx(CodeBlock,{filename:`Bash`,icon:`square-terminal`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer [apiKey]\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Checkly-Account: [accountId]\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/admin/creating-api-key`,children:`More information about managing API keys`}),`, including service API keys.`]}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate Limits`}),`\n`,_jsx(_components.p,{children:`The Checkly Public API uses rate limits to help manage the sheer volume of requests we receive. The rate limit is characterized by allowing a maximum number of requests within a time interval.`}),`\n`,_jsxs(_components.p,{children:[`For most of our routes, that limit is `,_jsx(_components.strong,{children:`600 requests every 60 seconds`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`However, we also have `,_jsx(_components.strong,{children:`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.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Using the Checkly API","sidebarTitle":"Overview","description":"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.","canonical":"https://www.checklyhq.com/docs/api-reference/overview/","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API specification","slug":"api-specification","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Rate Limits","slug":"rate-limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/checkly-422f444a/03c384ca110f8f33/images/samples/playwright/basic-browser-navigation.spec.js","/docs/_mintlify/custom/checkly-422f444a/3aedfaacb903efb7/images/samples/playwright/basic-browser-waiting.spec.js","/docs/_mintlify/custom/checkly-422f444a/874b25dff0c8db30/images/samples/playwright/basic-click-type.js","/docs/_mintlify/custom/checkly-422f444a/6a8eb0ac39f63ee8/images/samples/playwright/basic-get-data-json.js","/docs/_mintlify/custom/checkly-422f444a/a2ebc6c75510001e/images/samples/playwright/basic-get-href-handle.js","/docs/_mintlify/custom/checkly-422f444a/15f066bd5b356d03/images/samples/playwright/basic-get-href-value.js","/docs/_mintlify/custom/checkly-422f444a/c34e7d70a10be360/images/samples/playwright/basic-get-image.js","/docs/_mintlify/custom/checkly-422f444a/ecb008fc4d6bd86f/images/samples/playwright/basic-get-text-values.js","/docs/_mintlify/custom/checkly-422f444a/d647a299d043619a/images/samples/playwright/basic-navigation.spec.js","/docs/_mintlify/custom/checkly-422f444a/3671a0e2a5999855/images/samples/playwright/basic-performance-emulation.spec.js","/docs/_mintlify/custom/checkly-422f444a/b0d6c22bafecc861/images/samples/playwright/basic-performance-largest-contentful-paint.spec.js","/docs/_mintlify/custom/checkly-422f444a/98b1ba33ad12cb07/images/samples/playwright/basic-performance-layout-shift.spec.js","/docs/_mintlify/custom/checkly-422f444a/0dd46b8945a78003/images/samples/playwright/basic-performance-lighthouse.js","/docs/_mintlify/custom/checkly-422f444a/0a3aa21abf0c8070/images/samples/playwright/basic-performance-long-task.spec.js","/docs/_mintlify/custom/checkly-422f444a/2ec6209a1a440365/images/samples/playwright/basic-performance-navigation.spec.js","/docs/_mintlify/custom/checkly-422f444a/ab77d83825565172/images/samples/playwright/basic-performance-paint-timing.spec.js","/docs/_mintlify/custom/checkly-422f444a/fbae4713652bd234/images/samples/playwright/basic-performance-resource.spec.js","/docs/_mintlify/custom/checkly-422f444a/81e31bbf78f6e3a2/images/samples/playwright/basic-screenshot-clipped.spec.js","/docs/_mintlify/custom/checkly-422f444a/f73b16a94ed05395/images/samples/playwright/basic-screenshot.spec.js","/docs/_mintlify/custom/checkly-422f444a/245bb36534ba24ea/images/samples/playwright/checkout.spec.js","/docs/_mintlify/custom/checkly-422f444a/7b806bb35db3ccab/images/samples/playwright/cookies-reading.js","/docs/_mintlify/custom/checkly-422f444a/db4765669699af42/images/samples/playwright/cookies-writing.js","/docs/_mintlify/custom/checkly-422f444a/052ab23b9ab8c2a1/images/samples/playwright/coupon.js","/docs/_mintlify/custom/checkly-422f444a/8d4904f554cb22bb/images/samples/playwright/file-download-alt.spec.js","/docs/_mintlify/custom/checkly-422f444a/31dd7e3cca357943/images/samples/playwright/file-download.spec.js","/docs/_mintlify/custom/checkly-422f444a/3b5117b1976058b9/images/samples/playwright/file-upload.js","/docs/_mintlify/custom/checkly-422f444a/b4db6d82e65eb0ad/images/samples/playwright/google-login.spec.js","/docs/_mintlify/custom/checkly-422f444a/47d276d44d696a56/images/samples/playwright/iframe-access.spec.js","/docs/_mintlify/custom/checkly-422f444a/f8cd479ea960e73c/images/samples/playwright/localstorage-reading.js","/docs/_mintlify/custom/checkly-422f444a/f39e0fa80c269ccb/images/samples/playwright/localstorage-writing.js","/docs/_mintlify/custom/checkly-422f444a/2a42ac7e43086a6e/images/samples/playwright/login.spec.js","/docs/_mintlify/custom/checkly-422f444a/cb756847d7c45e46/images/samples/playwright/ms-account-login.spec.js","/docs/_mintlify/custom/checkly-422f444a/a4bd2cbf8ccc08b7/images/samples/playwright/multitab-flows.spec.js","/docs/_mintlify/custom/checkly-422f444a/789d483268e58c9b/images/samples/playwright/multitab-open.spec.js","/docs/_mintlify/custom/checkly-422f444a/841bea174d7837b6/images/samples/playwright/pdf-hd.spec.js","/docs/_mintlify/custom/checkly-422f444a/c222a25d592ac29f/images/samples/playwright/pdf-minimal.spec.js","/docs/_mintlify/custom/checkly-422f444a/596612f85edc81f0/images/samples/playwright/request-interception-block.spec.js","/docs/_mintlify/custom/checkly-422f444a/cc4170c02406ef67/images/samples/playwright/request-interception-read.spec.js","/docs/_mintlify/custom/checkly-422f444a/64d6ff6c52e59fc7/images/samples/playwright/response-interception.spec.js","/docs/_mintlify/custom/checkly-422f444a/86959fa870e616bc/images/samples/playwright/scraping-example-purchases.js","/docs/_mintlify/custom/checkly-422f444a/f4c465fe0e0579a8/images/samples/playwright/search.spec.js","/docs/_mintlify/custom/checkly-422f444a/43d9ebdbb9e789bd/images/samples/playwright/signup.spec.js","/docs/_mintlify/custom/checkly-422f444a/ced4500672007463/images/samples/puppeteer/basic-browser-navigation.js","/docs/_mintlify/custom/checkly-422f444a/0d8c084f1c6b4a68/images/samples/puppeteer/basic-browser-waiting.js","/docs/_mintlify/custom/checkly-422f444a/cc2fc01468d5adaf/images/samples/puppeteer/basic-click-type.js","/docs/_mintlify/custom/checkly-422f444a/717b767ee1fc167c/images/samples/puppeteer/basic-get-data-json.js","/docs/_mintlify/custom/checkly-422f444a/7aebdbf0fc24a6be/images/samples/puppeteer/basic-get-href-handle.js","/docs/_mintlify/custom/checkly-422f444a/fab751a41b9ffa1c/images/samples/puppeteer/basic-get-href-value.js","/docs/_mintlify/custom/checkly-422f444a/a3c8a180ddaa4db3/images/samples/puppeteer/basic-get-image.js","/docs/_mintlify/custom/checkly-422f444a/6627f27beba0d141/images/samples/puppeteer/basic-get-text-values.js","/docs/_mintlify/custom/checkly-422f444a/ecbbee6547f251df/images/samples/puppeteer/basic-navigation.js","/docs/_mintlify/custom/checkly-422f444a/3cc62c5f464626ee/images/samples/puppeteer/basic-performance-emulation.js","/docs/_mintlify/custom/checkly-422f444a/74dafc7e9d9a567d/images/samples/puppeteer/basic-performance-largest-contentful-paint.js","/docs/_mintlify/custom/checkly-422f444a/a9b94abbb057573e/images/samples/puppeteer/basic-performance-layout-shift.js","/docs/_mintlify/custom/checkly-422f444a/fb5358fd6c904ca5/images/samples/puppeteer/basic-performance-lighthouse.js","/docs/_mintlify/custom/checkly-422f444a/9a9696af1b1ad745/images/samples/puppeteer/basic-performance-long-task.js","/docs/_mintlify/custom/checkly-422f444a/6aed3717ed2443ce/images/samples/puppeteer/basic-performance-navigation.js","/docs/_mintlify/custom/checkly-422f444a/fc0598314e12fd4d/images/samples/puppeteer/basic-performance-paint-timing.js","/docs/_mintlify/custom/checkly-422f444a/52a139684fad5029/images/samples/puppeteer/basic-performance-resource.js","/docs/_mintlify/custom/checkly-422f444a/747faaa770a0147b/images/samples/puppeteer/basic-screenshot-clipped.js","/docs/_mintlify/custom/checkly-422f444a/ede54ec16e6fc86c/images/samples/puppeteer/basic-screenshot.js","/docs/_mintlify/custom/checkly-422f444a/4d661c5ab39c9d19/images/samples/puppeteer/checkout.js","/docs/_mintlify/custom/checkly-422f444a/fdc1241b48d32423/images/samples/puppeteer/cookies-reading.js","/docs/_mintlify/custom/checkly-422f444a/7b67437206228c45/images/samples/puppeteer/cookies-writing.js","/docs/_mintlify/custom/checkly-422f444a/493ae0bb75ea98e1/images/samples/puppeteer/coupon.js","/docs/_mintlify/custom/checkly-422f444a/49aab7fa197846b5/images/samples/puppeteer/file-download.js","/docs/_mintlify/custom/checkly-422f444a/fcb24ca49ff45807/images/samples/puppeteer/file-upload.js","/docs/_mintlify/custom/checkly-422f444a/749e3ad6a119dae9/images/samples/puppeteer/google-login.js","/docs/_mintlify/custom/checkly-422f444a/faae761a8db6cf1a/images/samples/puppeteer/iframe-access.js","/docs/_mintlify/custom/checkly-422f444a/71baa284af06ddfb/images/samples/puppeteer/localstorage-reading.js","/docs/_mintlify/custom/checkly-422f444a/77f2f4c65ba4ccd1/images/samples/puppeteer/localstorage-writing.js","/docs/_mintlify/custom/checkly-422f444a/deb690b7266ab621/images/samples/puppeteer/login.js","/docs/_mintlify/custom/checkly-422f444a/242099cef882d1fc/images/samples/puppeteer/mslive-login.js","/docs/_mintlify/custom/checkly-422f444a/4161637435a7a861/images/samples/puppeteer/multitab-flows.js","/docs/_mintlify/custom/checkly-422f444a/c17991c9cbbc19d0/images/samples/puppeteer/multitab-headful.js","/docs/_mintlify/custom/checkly-422f444a/918479017b543441/images/samples/puppeteer/multitab-open.js","/docs/_mintlify/custom/checkly-422f444a/2cee6a268dfaedb4/images/samples/puppeteer/pdf-hd.js","/docs/_mintlify/custom/checkly-422f444a/13d2bd77c306a8a0/images/samples/puppeteer/pdf-minimal.js","/docs/_mintlify/custom/checkly-422f444a/d5934590c55a23dd/images/samples/puppeteer/request-interception-block.js","/docs/_mintlify/custom/checkly-422f444a/de0e07656a6e07a6/images/samples/puppeteer/request-interception-read.js","/docs/_mintlify/custom/checkly-422f444a/b57d5481a5bee079/images/samples/puppeteer/response-interception.js","/docs/_mintlify/custom/checkly-422f444a/5cddd8a400391d05/images/samples/puppeteer/scraping-example-purchases.js","/docs/_mintlify/custom/checkly-422f444a/82209fef12b81221/images/samples/puppeteer/search.js","/docs/_mintlify/custom/checkly-422f444a/38d7a86c6ae16b4f/images/samples/puppeteer/signup.js","/docs/_mintlify/custom/checkly-422f444a/aad71fb35d0772c0/block-headless.js","/docs/_mintlify/custom/checkly-422f444a/3f79a661eed0dd6f/unify-tracking.js","/docs/_mintlify/custom/checkly-422f444a/b003b8f3946ae09a/vercel-analytics.js"],"subdomain":"checkly-422f444a","siteName":"Checkly Docs","title":"Using the Checkly API - Checkly Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-15T21:22:52.776Z","originalFileLocation":"api-reference/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Checkly Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Using the Checkly API - Checkly Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Checkly Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.checklyhq.com/docs/api-reference/overview/\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://checkly-422f444a.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Using+the+Checkly+API\u0026amp;description=Use+the+Checkly+Public+API+to+manage+monitoring+resources%2C+retrieve+account+information%2C+and+export+analytics.\u0026amp;theme=177ebac03dbdb024a546ac51\u0026amp;signature=98e7c611fdbd8cf985c7c26ff228e8efc0f0e3365c98a8bbcc36d15b83937dd5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Using the Checkly API - Checkly Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://checkly-422f444a.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Using+the+Checkly+API\u0026amp;description=Use+the+Checkly+Public+API+to+manage+monitoring+resources%2C+retrieve+account+information%2C+and+export+analytics.\u0026amp;theme=177ebac03dbdb024a546ac51\u0026amp;signature=98e7c611fdbd8cf985c7c26ff228e8efc0f0e3365c98a8bbcc36d15b83937dd5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/checkly-422f444a/2kkgPuwuI9OgTLg8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Checkly Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0075FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.checklyhq.com/docs/api-reference/overview/\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.checklyhq.com/#organization\",\"name\":\"Checkly Docs\",\"url\":\"https://www.checklyhq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/checkly-422f444a/KiRymP194lYB6fu_/logo/light.svg?fit=max\u0026auto=format\u0026n=KiRymP194lYB6fu_\u0026q=85\u0026s=c4c50c3b55e375fe5d06b52fad5c8032\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.checklyhq.com/docs#website\",\"name\":\"Checkly Docs\",\"url\":\"https://www.checklyhq.com/docs\",\"publisher\":{\"@id\":\"https://www.checklyhq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.checklyhq.com/docs/api-reference/overview/#webpage\",\"url\":\"https://www.checklyhq.com/docs/api-reference/overview/\",\"name\":\"Using the Checkly API\",\"description\":\"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.\",\"dateModified\":\"2026-05-15T21:22:52.776Z\",\"isPartOf\":{\"@id\":\"https://www.checklyhq.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.checklyhq.com/docs/api-reference/overview/#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.checklyhq.com/docs/api-reference/overview/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkly Docs\",\"item\":\"https://www.checklyhq.com/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Using the Checkly API\",\"item\":\"https://www.checklyhq.com/docs/api-reference/overview/\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.checklyhq.com/docs/api-reference/overview/#article\",\"headline\":\"Using the Checkly API\",\"name\":\"Using the Checkly API\",\"description\":\"Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics.\",\"url\":\"https://www.checklyhq.com/docs/api-reference/overview/\",\"mainEntityOfPage\":{\"@id\":\"https://www.checklyhq.com/docs/api-reference/overview/#webpage\"},\"dateModified\":\"2026-05-15T21:22:52.776Z\",\"publisher\":{\"@id\":\"https://www.checklyhq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.checklyhq.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Checkly Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Checkly Docs","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/what-is-checkly"}]},{"tab":"Constructs","pages":[{"title":"Constructs","href":"/constructs/overview"}]},{"tab":"CLI Reference","pages":[{"title":"CLI Reference","href":"/cli/overview"}]},{"tab":"API Reference","pages":[{"group":"Getting Started","pages":[{"title":"Using the Checkly API","sidebarTitle":"Overview","href":"/api-reference/overview"}]},{"group":"API Reference","pages":[{"group":"Accounts","pages":[{"openapi":"get /v1/accounts","title":"Get details for all accounts","description":"List account details based on supplied API key.","href":"/api-reference/accounts/fetch-user-accounts"},{"openapi":"get /v1/accounts/me","title":"Get details for the current account","href":"/api-reference/accounts/fetch-current-account-details"},{"openapi":"get /v1/accounts/{accountId}","title":"Get details for a specific account","href":"/api-reference/accounts/fetch-a-given-account-details"},{"openapi":"get /v1/accounts/me/entitlements","title":"Fetch current account entitlements","href":"/api-reference/accounts/fetch-current-account-entitlements"},{"openapi":"get /v1/accounts/{accountId}/entitlements","title":"Fetch account entitlements","href":"/api-reference/accounts/fetch-account-entitlements"},{"openapi":"get /v1/accounts/me/members","title":"List current account members and pending invites","href":"/api-reference/accounts/list-current-account-members-and-pending-invites"},{"openapi":"get /v1/accounts/{accountId}/members","title":"List account members and pending invites","href":"/api-reference/accounts/list-account-members-and-pending-invites"},{"openapi":"delete /v1/accounts/me/members/{userId}","title":"Remove a current account member","href":"/api-reference/accounts/remove-a-current-account-member"},{"openapi":"patch /v1/accounts/me/members/{userId}","title":"Update a current account member role","href":"/api-reference/accounts/update-a-current-account-member-role"},{"openapi":"delete /v1/accounts/{accountId}/members/{userId}","title":"Remove an account member","href":"/api-reference/accounts/remove-an-account-member"},{"openapi":"patch /v1/accounts/{accountId}/members/{userId}","title":"Update an account member role","href":"/api-reference/accounts/update-an-account-member-role"}]},{"group":"Alert Channels","pages":[{"openapi":"get /v1/alert-channels","title":"List all alert channels","href":"/api-reference/alert-channels/list-all-alert-channels"},{"openapi":"post /v1/alert-channels","title":"Create an alert channel","href":"/api-reference/alert-channels/create-an-alert-channel"},{"openapi":"get /v1/alert-channels/{id}","title":"Retrieve an alert channel","href":"/api-reference/alert-channels/retrieve-an-alert-channel"},{"openapi":"put /v1/alert-channels/{id}","title":"Update an alert channel","href":"/api-reference/alert-channels/update-an-alert-channel"},{"openapi":"delete /v1/alert-channels/{id}","title":"Delete an alert channel","href":"/api-reference/alert-channels/delete-an-alert-channel"},{"openapi":"put /v1/alert-channels/{id}/subscriptions","title":"Update the subscriptions of an alert channel","href":"/api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel"}]},{"group":"Alert Notifications","pages":[{"openapi":"get /v1/alert-notifications","title":"Lists all alert notifications","href":"/api-reference/alert-notifications/lists-all-alert-notifications"}]},{"group":"Analytics","pages":[{"openapi":"get /v1/analytics/api-checks/{id}","title":"API checks","href":"/api-reference/analytics/api-checks"},{"openapi":"get /v1/analytics/browser-checks/{id}","title":"Browser checks","href":"/api-reference/analytics/browser-checks"},{"openapi":"get /v1/analytics/multistep-checks/{id}","title":"Multistep checks","href":"/api-reference/analytics/multistep-checks"},{"openapi":"get /v1/analytics/playwright-checks/{id}","title":"Playwright checks","href":"/api-reference/analytics/playwright-checks"},{"openapi":"get /v1/analytics/dns/{id}","title":"DNS monitors","href":"/api-reference/analytics/dns-monitors"},{"openapi":"get /v1/analytics/heartbeat-checks/{id}","title":"Heartbeat monitors","href":"/api-reference/analytics/heartbeat-checks"},{"openapi":"get /v1/analytics/tcp-checks/{id}","title":"TCP monitors","href":"/api-reference/analytics/tcp-checks"},{"openapi":"get /v1/analytics/url-monitors/{id}","title":"URL monitors","href":"/api-reference/analytics/url-monitors"},{"openapi":"get /v1/analytics/metrics","title":"List all available reporting metrics.","href":"/api-reference/analytics/list-all-available-reporting-metrics"},{"openapi":"get /v1/analytics/icmp/{id}","title":"ICMP monitors","href":"/api-reference/analytics/icmp-monitors"},{"openapi":"post /v1/analytics/checks","title":"Get analytics summary for multiple checks","href":"/api-reference/analytics/get-analytics-summary-for-multiple-checks"},{"openapi":"get /v1/analytics/ssl/{id}","title":"SSL monitors","href":"/api-reference/analytics/ssl-monitors"}]},{"group":"Badges","pages":[{"openapi":"get /v1/badges/checks/{checkId}","title":"Get badge for a check","href":"/api-reference/badges/get-v1badgeschecks"},{"openapi":"get /v1/badges/groups/{groupId}","title":"Get badge for a group","href":"/api-reference/badges/get-v1badgesgroups"}]},{"group":"Checks and Monitors","pages":[{"openapi":"get /v1/checks","title":"List all checks","href":"/api-reference/checks/list-all-checks"},{"openapi":"get /v3/checks","title":"List all checks (v3)","href":"/api-reference/checks/list-all-checks-v3"},{"openapi":"get /v2/checks","title":"List all checks (v2)","href":"/api-reference/checks/list-all-checks-v2"},{"openapi":"get /v1/checks/{id}","title":"Retrieve a check","href":"/api-reference/checks/retrieve-a-check"},{"openapi":"get /v3/checks/{id}","title":"Retrieve a check (v3)","href":"/api-reference/checks/retrieve-a-check-v3"},{"openapi":"get /v2/checks/{id}","title":"Retrieve a check (v2)","href":"/api-reference/checks/retrieve-a-check-v2"},{"openapi":"delete /v1/checks/{id}","title":"Delete a check","href":"/api-reference/checks/delete-a-check"},{"openapi":"post /v1/checks","deprecated":true,"title":"Create a check","href":"/api-reference/checks/create-a-check"},{"openapi":"put /v1/checks/{id}","deprecated":true,"title":"Update a check","href":"/api-reference/checks/update-a-check"},{"group":"API Check","pages":[{"openapi":"post /v1/checks/api","title":"Create an API check","href":"/api-reference/checks/create-an-api-check"},{"openapi":"put /v1/checks/api/{id}","title":"Update an API check","href":"/api-reference/checks/update-an-api-check"}]},{"group":"Browser Check","pages":[{"openapi":"post /v1/checks/browser","title":"Create a browser check","href":"/api-reference/checks/create-a-browser-check"},{"openapi":"put /v1/checks/browser/{id}","title":"Update a browser check","href":"/api-reference/checks/update-a-browser-check"}]},{"group":"Multistep Check ","pages":[{"openapi":"post /v1/checks/multistep","title":"Create a multi-step check","href":"/api-reference/checks/create-a-multi-step-check"},{"openapi":"put /v1/checks/multistep/{id}","title":"Update a multi-step check","href":"/api-reference/checks/update-a-multi-step-check"}]},{"group":"DNS Monitor","pages":[{"openapi":"post /v1/checks/dns","title":"Create an DNS monitor","href":"/api-reference/monitors/create-a-dns-monitor"},{"openapi":"put /v1/checks/dns/{id}","title":"Update an DNS Monitor","href":"/api-reference/monitors/update-a-dns-monitor"}]},{"group":"Heartbeat Monitor","pages":[{"openapi":"post /v1/checks/heartbeat","title":"Create a heartbeat monitor","href":"/api-reference/heartbeats/create-a-heartbeat-check"},{"openapi":"put /v1/checks/heartbeat/{id}","title":"Update a heartbeat monitor","href":"/api-reference/heartbeats/update-a-heartbeat-check"},{"openapi":"get /v1/checks/heartbeats/{checkId}/availability","title":"Get heartbeat monitor availability","href":"/api-reference/heartbeats/get-heartbeat-availability"},{"openapi":"get /v1/checks/heartbeats/{checkId}/events","title":"List all events for a heartbeat monitor","href":"/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat"},{"openapi":"get /v1/checks/heartbeats/{checkId}/events/{id}","title":"List a specific event for a heartbeat monitor","href":"/api-reference/heartbeats/get-a-specific-heartbeat-event"}]},{"group":"TCP Monitor","pages":[{"openapi":"post /v1/checks/tcp","title":"Create a TCP monitor","href":"/api-reference/checks/create-a-tcp-check"},{"openapi":"put /v1/checks/tcp/{id}","title":"Update a TCP monitor","href":"/api-reference/checks/update-an-tcp-check"}]},{"group":"URL Monitor","pages":[{"openapi":"post /v1/checks/url","title":"Create a URL monitor","href":"/api-reference/monitors/create-a-url-monitor"},{"openapi":"put /v1/checks/url/{id}","title":"Update a URL monitor","href":"/api-reference/monitors/update-an-url-monitor"}]},{"group":"ICMP Monitor","pages":[{"openapi":"post /v1/checks/icmp","title":"Create an ICMP monitor","href":"/api-reference/monitors/create-an-icmp-monitor"},{"openapi":"put /v1/checks/icmp/{id}","title":"Update an ICMP Monitor","href":"/api-reference/monitors/update-an-icmp-monitor"}]},{"group":"SSL Monitor","pages":[{"openapi":"post /v1/checks/ssl","title":"Create an SSL monitor","href":"/api-reference/monitors/create-an-ssl-monitor"},{"openapi":"put /v1/checks/ssl/{id}","title":"Update an SSL Monitor","href":"/api-reference/monitors/update-an-ssl-monitor"}]},{"group":"Traceroute Monitor","pages":[{"openapi":"post /v1/checks/traceroute","title":"Create a Traceroute monitor","href":"/api-reference/monitors/create-a-traceroute-monitor"},{"openapi":"put /v1/checks/traceroute/{id}","title":"Update a Traceroute Monitor","href":"/api-reference/monitors/update-a-traceroute-monitor"}]},{"group":"gRPC Monitor","pages":[{"openapi":"post /v1/checks/grpc","title":"Create a gRPC monitor","href":"/api-reference/monitors/create-a-grpc-monitor"},{"openapi":"put /v1/checks/grpc/{id}","title":"Update a gRPC Monitor","href":"/api-reference/monitors/update-a-grpc-monitor"}]}]},{"group":"Check Alerts","pages":[{"openapi":"get /v1/check-alerts","title":"List all alerts for your account","href":"/api-reference/check-alerts/list-all-alerts-for-your-account"},{"openapi":"get /v1/check-alerts/{checkId}","title":"List alerts for a specific check","href":"/api-reference/check-alerts/list-alerts-for-a-specific-check"}]},{"group":"Check Groups","pages":[{"openapi":"get /v1/check-groups","title":"List all check groups","href":"/api-reference/check-groups/list-all-check-groups"},{"openapi":"get /v1/check-groups/{id}","title":"Retrieve a check group","href":"/api-reference/check-groups/retrieve-a-check-group"},{"openapi":"delete /v1/check-groups/{id}","title":"Delete a check group.","href":"/api-reference/check-groups/delete-a-check-group"},{"openapi":"get /v1/check-groups/{groupId}/checks/{checkId}","title":"Retrieve one check in a specific group with group settings applied","href":"/api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied"},{"openapi":"get /v2/check-groups/{groupId}/checks/{checkId}","title":"Retrieve one check in a specific group with group settings applied (V2)","href":"/api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied-v2"},{"openapi":"get /v1/check-groups/{id}/checks","title":"Retrieve all checks in a specific group with group settings applied","href":"/api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied"},{"openapi":"get /v2/check-groups/{id}/checks","title":"Retrieve all checks in a specific group with group settings applied (V2)","href":"/api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied-v2"},{"openapi":"post /v1/check-groups","deprecated":true,"title":"Create a check group","href":"/api-reference/check-groups/create-a-check-group"},{"openapi":"post /v2/check-groups","title":"Create a check group (V2)","href":"/api-reference/check-groups/create-a-check-group-v2"},{"openapi":"put /v1/check-groups/{id}","deprecated":true,"title":"Update a check group","href":"/api-reference/check-groups/update-a-check-group"},{"openapi":"put /v2/check-groups/{id}","title":"Update a check group (V2)","href":"/api-reference/check-groups/update-a-check-group-v2"}]},{"group":"Check Results","pages":[{"openapi":"get /v1/check-results/{checkId}","deprecated":true,"title":"Lists all check results","href":"/api-reference/check-results/lists-all-check-results"},{"openapi":"get /v1/check-results/{checkId}/{checkResultId}","title":"Retrieve a check result","href":"/api-reference/check-results/retrieve-a-check-result"},{"openapi":"get /v2/check-results/{checkId}","title":"Lists all check results","href":"/api-reference/check-results/lists-all-check-results-1"},{"openapi":"get /v1/check-results/{checkId}/{checkResultId}/assets","title":"Retrieve a normalized asset manifest for a check result","href":"/api-reference/check-results/retrieve-a-normalized-asset-manifest-for-a-check-result"}]},{"group":"Check Sessions","pages":[{"openapi":"post /v1/check-sessions/trigger","deprecated":true,"title":"Trigger a new check session","href":"/api-reference/check-sessions/trigger-a-new-check-session"},{"openapi":"post /v2/check-sessions/trigger","title":"Trigger a new check session (v2)","href":"/api-reference/check-sessions/trigger-a-new-check-session-v2"},{"openapi":"get /v1/check-sessions/{checkSessionId}","deprecated":true,"title":"Retrieve a check session","href":"/api-reference/check-sessions/retrieve-a-check-session"},{"openapi":"get /v2/check-sessions/{checkSessionId}","title":"Retrieve a check session (v2)","href":"/api-reference/check-sessions/retrieve-a-check-session-v2"},{"openapi":"get /v1/check-sessions/{checkSessionId}/completion","deprecated":true,"title":"Await the completion of a check session","href":"/api-reference/check-sessions/await-the-completion-of-a-check-session"},{"openapi":"get /v2/check-sessions/{checkSessionId}/completion","title":"Await the completion of a check session (v2)","href":"/api-reference/check-sessions/await-the-completion-of-a-check-session-v2"},{"openapi":"post /v1/check-sessions/{checkSessionId}/cancel","title":"Cancel a check session","sidebarTitle":"Cancel a check session","href":"/api-reference/check-sessions/cancel-a-check-session"}]},{"group":"Check Status","pages":[{"openapi":"get /v1/check-statuses","title":"List all check statuses","href":"/api-reference/check-status/list-all-check-statuses"},{"openapi":"get /v1/check-statuses/{checkId}","title":"Retrieve check status details","href":"/api-reference/check-status/retrieve-check-status-details"}]},{"group":"Check Triggers","pages":[{"openapi":"get /v1/triggers/check-groups/{groupId}","deprecated":true,"title":"Get the check group trigger","href":"/api-reference/triggers/get-the-check-group-trigger"},{"openapi":"post /v1/triggers/check-groups/{groupId}","deprecated":true,"title":"Create the check group trigger","href":"/api-reference/triggers/create-the-check-group-trigger"},{"openapi":"delete /v1/triggers/check-groups/{groupId}","deprecated":true,"title":"Delete the check group trigger","href":"/api-reference/triggers/delete-the-check-group-trigger"},{"openapi":"get /v1/triggers/checks/{checkId}","deprecated":true,"title":"Get the check trigger","href":"/api-reference/triggers/get-the-check-trigger"},{"openapi":"post /v1/triggers/checks/{checkId}","deprecated":true,"title":"Create the check trigger","href":"/api-reference/triggers/create-the-check-trigger"},{"openapi":"delete /v1/triggers/checks/{checkId}","deprecated":true,"title":"Delete the check trigger","href":"/api-reference/triggers/delete-the-check-trigger"}]},{"group":"Client Certificates","pages":[{"openapi":"get /v1/client-certificates","title":"List all client certificates","href":"/api-reference/client-certificates/lists-all-client-certificates"},{"openapi":"post /v1/client-certificates","title":"Create a client certificate","href":"/api-reference/client-certificates/creates-a-new-client-certificate"},{"openapi":"get /v1/client-certificates/{id}","title":"Retrieve a client certificate","href":"/api-reference/client-certificates/shows-one-client-certificate"},{"openapi":"delete /v1/client-certificates/{id}","title":"Delete a client certificate","href":"/api-reference/client-certificates/deletes-a-client-certificate"}]},{"group":"Dashboards","pages":[{"openapi":"get /v1/dashboards","title":"List all dashboards","href":"/api-reference/dashboards/list-all-dashboards"},{"openapi":"post /v1/dashboards","title":"Create a dashboard","href":"/api-reference/dashboards/create-a-dashboard"},{"openapi":"get /v1/dashboards/{dashboardId}","title":"Retrieve a dashboard","href":"/api-reference/dashboards/retrieve-a-dashboard"},{"openapi":"put /v1/dashboards/{dashboardId}","title":"Update a dashboard","href":"/api-reference/dashboards/update-a-dashboard"},{"openapi":"delete /v1/dashboards/{dashboardId}","title":"Delete a dashboard","href":"/api-reference/dashboards/delete-a-dashboard"}]},{"group":"Dashboard Incidents","pages":[{"openapi":"post /v1/incidents","title":"Create an incident","href":"/api-reference/incidents/create-an-incident"},{"openapi":"get /v1/incidents/{id}","title":"Retrieve an incident","href":"/api-reference/incidents/retrieve-an-incident"},{"openapi":"put /v1/incidents/{id}","title":"Update an incident","href":"/api-reference/incidents/update-an-incident"},{"openapi":"delete /v1/incidents/{id}","title":"Delete an incident","href":"/api-reference/incidents/delete-an-incident"}]},{"group":"Dashboard Incident Updates","pages":[{"openapi":"post /v1/incidents/{incidentId}/updates","title":"Create an incident update","href":"/api-reference/incident-updates/create-an-incident-update"},{"openapi":"put /v1/incidents/{incidentId}/updates/{id}","title":"Update an incident update","href":"/api-reference/incident-updates/update-an-incident-update"},{"openapi":"delete /v1/incidents/{incidentId}/updates/{id}","title":"Delete an incident update","href":"/api-reference/incident-updates/delete-an-incident-update"}]},{"group":"Error Groups","pages":[{"openapi":"get /v1/error-groups","title":"List all error groups in your account.","href":"/api-reference/error-groups/list-all-error-groups"},{"openapi":"get /v1/error-groups/checks/{checkId}","title":"List all error groups for a specific check.","href":"/api-reference/error-groups/list-all-error-groups-for-a-specific-check"},{"openapi":"get /v1/error-groups/{id}","title":"Retrieve one error group.","href":"/api-reference/error-groups/retrieve-an-error-group"},{"openapi":"patch /v1/error-groups/{id}","title":"Update an error group","href":"/api-reference/error-groups/update-an-error-group"}]},{"group":"Environment Variables","pages":[{"openapi":"get /v1/variables","title":"List all environment variables","href":"/api-reference/environment-variables/list-all-environment-variables"},{"openapi":"post /v1/variables","title":"Create an environment variable","href":"/api-reference/environment-variables/create-an-environment-variable"},{"openapi":"get /v1/variables/{key}","title":"Retrieve an environment variable","href":"/api-reference/environment-variables/retrieve-an-environment-variable"},{"openapi":"put /v1/variables/{key}","title":"Update an environment variable","href":"/api-reference/environment-variables/update-an-environment-variable"},{"openapi":"delete /v1/variables/{key}","title":"Delete an environment variable","href":"/api-reference/environment-variables/delete-an-environment-variable"}]},{"group":"Locations","pages":[{"openapi":"get /v1/locations","title":"Lists all supported locations","href":"/api-reference/location/lists-all-supported-locations"}]},{"group":"Maintenance Windows","pages":[{"openapi":"get /v1/maintenance-windows","title":"List all maintenance windows","href":"/api-reference/maintenance-windows/list-all-maintenance-windows"},{"openapi":"post /v1/maintenance-windows","title":"Create a maintenance window","href":"/api-reference/maintenance-windows/create-a-maintenance-window"},{"openapi":"get /v1/maintenance-windows/{id}","title":"Retrieve a maintenance window","href":"/api-reference/maintenance-windows/retrieve-a-maintenance-window"},{"openapi":"put /v1/maintenance-windows/{id}","title":"Update a maintenance window","href":"/api-reference/maintenance-windows/update-a-maintenance-window"},{"openapi":"delete /v1/maintenance-windows/{id}","title":"Delete a maintenance window","href":"/api-reference/maintenance-windows/delete-a-maintenance-window"},{"openapi":"get /v1/maintenance-windows/{id}/maintenances","title":"List maintenances for a maintenance window","href":"/api-reference/maintenance-windows/list-maintenances-for-a-maintenance-window"},{"openapi":"delete /v1/maintenance-windows/{id}/maintenances/{maintenanceId}","title":"Delete a maintenance","href":"/api-reference/maintenance-windows/delete-a-maintenance"},{"openapi":"get /v1/maintenance-windows/{id}/maintenances/{maintenanceId}","title":"Retrieve a maintenance","href":"/api-reference/maintenance-windows/retrieve-a-maintenance"},{"openapi":"patch /v1/maintenance-windows/{id}/maintenances/{maintenanceId}","title":"Update maintenance dates","href":"/api-reference/maintenance-windows/update-maintenance-dates"},{"openapi":"post /v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates","title":"Create a maintenance window status update","href":"/api-reference/maintenance-windows/create-a-maintenance-window-status-update"},{"openapi":"delete /v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}","title":"Delete a maintenance window status update","href":"/api-reference/maintenance-windows/delete-a-maintenance-window-status-update"},{"openapi":"put /v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}","title":"Update a maintenance window status update","href":"/api-reference/maintenance-windows/update-a-maintenance-window-status-update"}]},{"group":"Private Locations","pages":[{"openapi":"get /v1/private-locations","title":"List all private locations","href":"/api-reference/private-locations/list-all-private-locations"},{"openapi":"post /v1/private-locations","title":"Create a private location","href":"/api-reference/private-locations/create-a-private-location"},{"openapi":"get /v1/private-locations/{id}","title":"Retrieve a private location","href":"/api-reference/private-locations/retrieve-a-private-location"},{"openapi":"put /v1/private-locations/{id}","title":"Update a private location","href":"/api-reference/private-locations/update-a-private-location"},{"openapi":"delete /v1/private-locations/{id}","title":"Remove a private location","href":"/api-reference/private-locations/remove-a-private-location"},{"openapi":"post /v1/private-locations/{id}/keys","title":"Generate a new API Key for a private location","href":"/api-reference/private-locations/generate-a-new-api-key-for-a-private-location"},{"openapi":"delete /v1/private-locations/{id}/keys/{keyId}","title":"Remove an existing API key for a private location","href":"/api-reference/private-locations/remove-an-existing-api-key-for-a-private-location"},{"openapi":"get /v1/private-locations/{id}/metrics","title":"Get private location health metrics from a window of time.","href":"/api-reference/private-locations/get-private-location-health-metrics-from-a-window-of-time"}]},{"group":"Reporting","pages":[{"openapi":"get /v1/reporting","title":"Generate report","sidebarTitle":"Generate report","href":"/api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups"}]},{"group":"Rocky AI","pages":[{"openapi":"get /v1/root-cause-analyses/{id}","title":"Retrieve a Root Cause Analysis","href":"/api-reference/rocky-ai/retrieve-one-root-cause-analysis"},{"openapi":"post /v1/root-cause-analyses/error-groups/{errorGroupId}","title":"Generate a Root Cause Analysis for a check error group","href":"/api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group"},{"openapi":"post /v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}","title":"Generate a Root Cause Analysis for a test session error group","href":"/api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group"}]},{"group":"Runtimes","pages":[{"openapi":"get /v1/runtimes","title":"List all supported runtimes","href":"/api-reference/runtimes/lists-all-supported-runtimes"},{"openapi":"get /v1/runtimes/{id}","title":"List details for a runtime","href":"/api-reference/runtimes/shows-details-for-one-specific-runtime"}]},{"group":"Usage","pages":[{"title":"Usage API","sidebarTitle":"Overview","href":"/api-reference/usage/overview"},{"title":"Get usage terms v2","deprecated":null,"version":null,"sidebarTitle":"Get usage terms v2","tag":"Beta","openapi":"/api-reference/openapi.json get /v2/usage/terms","href":"/api-reference/usage/get-usage-terms-and-accounts-for-the-current-organization"},{"title":"Get usage series v2","deprecated":null,"version":null,"sidebarTitle":"Get usage series v2","tag":"Beta","openapi":"/api-reference/openapi.json get /v2/usage/series","href":"/api-reference/usage/get-paginated-consumption-across-usage-terms-group-by-account-usage-term-pricing-rule-and-check-type"},{"title":"Get usage summary v2","deprecated":null,"version":null,"sidebarTitle":"Get usage summary v2","tag":"Beta","openapi":"/api-reference/openapi.json get /v2/usage/summary","href":"/api-reference/usage/get-consumption-across-usage-terms-with-a-calculation-breakdown-for-each-pricing-rule"},{"title":"Get usage term v2","deprecated":null,"version":null,"sidebarTitle":"Get usage term v2","tag":"Beta","openapi":"/api-reference/openapi.json get /v2/usage/terms/{id}","href":"/api-reference/usage/get-a-usage-term-with-its-budget-accounts-and-applied-pricing-rules"},{"title":"Get usage projections v2","deprecated":null,"version":null,"sidebarTitle":"Get usage projections v2","tag":"Beta","openapi":"/api-reference/openapi.json get /v2/usage/terms/{id}/projections","href":"/api-reference/usage/project-whole-term-credit-consumption-from-completed-utc-days-using-v2-pricing-rules"},{"openapi":"get /v1/usage/terms","title":"Get usage terms v1","sidebarTitle":"Get usage terms v1","href":"/api-reference/usage/get-usage-terms"},{"openapi":"get /v1/usage/summary","title":"Get usage summary v1","sidebarTitle":"Get usage summary v1","href":"/api-reference/usage/get-usage-summary"},{"openapi":"get /v1/usage/series","title":"Get usage series v1","sidebarTitle":"Get usage series v1","href":"/api-reference/usage/get-usage-series"}]},{"group":"Static IPs","pages":[{"openapi":"get /v1/static-ips","title":"List IPs for check runs","href":"/api-reference/static-ips/lists-all-source-ips-for-check-runs"},{"openapi":"get /v1/static-ips-by-region","title":"List IPs for check runs by region","href":"/api-reference/static-ips/lists-all-source-ips-for-check-runs-1"},{"openapi":"get /v1/static-ips.txt","title":"List IPs for check runs as a TXT file","href":"/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file"},{"openapi":"get /v1/static-ipv6s","title":"List IPv6s for check runs","href":"/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs"},{"openapi":"get /v1/static-ipv6s-by-region","title":"List IPv6s for check runs by region","href":"/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1"},{"openapi":"get /v1/static-ipv6s.txt","title":"List IPv6s for check runs as a TXT file","href":"/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file"}]},{"group":"Status Pages","pages":[{"openapi":"get /v3/status-pages","title":"List v3 status pages.","href":"/api-reference/status-pages-v3/list-v3-status-pages"},{"openapi":"post /v3/status-pages","title":"Create a new v3 status page.","href":"/api-reference/status-pages-v3/create-a-new-v3-status-page"},{"openapi":"get /v3/status-pages/{statusPageId}","title":"Retrieve a single v3 status page by id.","href":"/api-reference/status-pages-v3/retrieve-a-single-v3-status-page-by-id"},{"openapi":"put /v3/status-pages/{statusPageId}","title":"Update an existing v3 status page.","href":"/api-reference/status-pages-v3/update-an-existing-v3-status-page"},{"openapi":"delete /v3/status-pages/{statusPageId}","title":"Delete a v3 status page.","href":"/api-reference/status-pages-v3/delete-a-v3-status-page"},{"openapi":"get /v3/status-pages/{statusPageId}/custom-domain-verifications","title":"Retrieve custom domain verification details for a v3 status page.","href":"/api-reference/status-pages-v3/retrieve-custom-domain-verification-details-for-a-v3-status-page"},{"openapi":"post /v3/status-pages/{statusPageId}/custom-domain-verifications/recheck","title":"Re-check the custom domain verification of a v3 status page.","href":"/api-reference/status-pages-v3/re-check-the-custom-domain-verification-of-a-v3-status-page"}]},{"group":"Status Page Components","pages":[{"openapi":"get /v3/status-pages/{statusPageId}/components","title":"List the components of a v3 status page.","href":"/api-reference/status-pages-v3/list-the-components-of-a-v3-status-page"},{"openapi":"post /v3/status-pages/{statusPageId}/components","title":"Create a component on a v3 status page.","href":"/api-reference/status-pages-v3/create-a-component-on-a-v3-status-page"},{"openapi":"get /v3/status-pages/{statusPageId}/components/{componentId}","title":"Retrieve a single component of a v3 status page.","href":"/api-reference/status-pages-v3/retrieve-a-single-component-of-a-v3-status-page"},{"openapi":"put /v3/status-pages/{statusPageId}/components/{componentId}","title":"Update a component of a v3 status page.","href":"/api-reference/status-pages-v3/update-a-component-of-a-v3-status-page"},{"openapi":"delete /v3/status-pages/{statusPageId}/components/{componentId}","title":"Delete a component of a v3 status page.","href":"/api-reference/status-pages-v3/delete-a-component-of-a-v3-status-page"}]},{"group":"Status Page Automation Rules","pages":[{"openapi":"get /v3/status-pages/{statusPageId}/automation-rules","title":"List the automation rules of a v3 status page.","href":"/api-reference/status-pages-v3/list-the-automation-rules-of-a-v3-status-page"},{"openapi":"post /v3/status-pages/{statusPageId}/automation-rules","title":"Create an automation rule on a v3 status page.","href":"/api-reference/status-pages-v3/create-an-automation-rule-on-a-v3-status-page"},{"openapi":"get /v3/status-pages/{statusPageId}/automation-rules/{ruleId}","title":"Retrieve a single automation rule of a v3 status page.","href":"/api-reference/status-pages-v3/retrieve-a-single-automation-rule-of-a-v3-status-page"},{"openapi":"put /v3/status-pages/{statusPageId}/automation-rules/{ruleId}","title":"Update an automation rule of a v3 status page.","href":"/api-reference/status-pages-v3/update-an-automation-rule-of-a-v3-status-page"},{"openapi":"delete /v3/status-pages/{statusPageId}/automation-rules/{ruleId}","title":"Delete an automation rule of a v3 status page.","href":"/api-reference/status-pages-v3/delete-an-automation-rule-of-a-v3-status-page"}]},{"group":"Status Page Incidents","pages":[{"openapi":"get /v3/status-pages/{statusPageId}/incidents","title":"List the incidents of a v3 status page.","href":"/api-reference/status-pages-v3/list-the-incidents-of-a-v3-status-page"},{"openapi":"post /v3/status-pages/{statusPageId}/incidents","title":"Open an incident on a v3 status page.","href":"/api-reference/status-pages-v3/open-an-incident-on-a-v3-status-page"},{"openapi":"get /v3/status-pages/{statusPageId}/incidents/{incidentId}","title":"Retrieve an incident of a v3 status page.","href":"/api-reference/status-pages-v3/retrieve-an-incident-of-a-v3-status-page"},{"openapi":"put /v3/status-pages/{statusPageId}/incidents/{incidentId}","title":"Update an incident of a v3 status page.","href":"/api-reference/status-pages-v3/update-an-incident-of-a-v3-status-page"},{"openapi":"delete /v3/status-pages/{statusPageId}/incidents/{incidentId}","title":"Delete an incident of a v3 status page.","href":"/api-reference/status-pages-v3/delete-an-incident-of-a-v3-status-page"},{"openapi":"put /v3/status-pages/{statusPageId}/incidents/{incidentId}/component-impacts","title":"Replace an incident's component impact timeline.","href":"/api-reference/status-pages-v3/replace-an-incidents-component-impact-timeline"}]},{"group":"Status Page Incident Updates","pages":[{"openapi":"get /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates","title":"List the updates of an incident.","href":"/api-reference/status-pages-v3/list-the-updates-of-an-incident"},{"openapi":"post /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates","title":"Post an update to an incident.","href":"/api-reference/status-pages-v3/post-an-update-to-an-incident"},{"openapi":"get /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}","title":"Retrieve an incident update.","href":"/api-reference/status-pages-v3/retrieve-an-incident-update"},{"openapi":"put /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}","title":"Edit an incident update.","href":"/api-reference/status-pages-v3/edit-an-incident-update"},{"openapi":"delete /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}","title":"Delete an incident update.","href":"/api-reference/status-pages-v3/delete-an-incident-update"}]},{"group":"Status Page Subscribers","pages":[{"openapi":"get /v3/status-pages/{statusPageId}/subscribers","title":"List the subscribers of a v3 status page.","href":"/api-reference/status-pages-v3/list-the-subscribers-of-a-v3-status-page"},{"openapi":"post /v3/status-pages/{statusPageId}/subscribers/bulk","title":"Subscribe multiple email addresses to a v3 status page.","href":"/api-reference/status-pages-v3/subscribe-multiple-email-addresses-to-a-v3-status-page"},{"openapi":"delete /v3/status-pages/{statusPageId}/subscribers/{subscriberId}","title":"Delete a subscriber of a v3 status page.","href":"/api-reference/status-pages-v3/delete-a-subscriber-of-a-v3-status-page"}]},{"group":"Status Pages v1","tag":"Deprecated","pages":[{"title":"Retrieve all status pages.","deprecated":true,"version":null,"sidebarTitle":"Retrieve all status pages","openapi":"/api-reference/openapi.json get /v1/status-pages","href":"/api-reference/status-pages/retrieve-all-status-pages"},{"title":"Create a new status page.","deprecated":true,"version":null,"sidebarTitle":"Create a new status page","openapi":"/api-reference/openapi.json post /v1/status-pages","href":"/api-reference/status-pages/create-a-new-status-page"},{"title":"Retrieve a single status page by id.","deprecated":true,"version":null,"sidebarTitle":"Retrieve a single status page by id","openapi":"/api-reference/openapi.json get /v1/status-pages/{statusPageId}","href":"/api-reference/status-pages/retrieve-a-single-status-page-by-id"},{"title":"Update an existing status page.","deprecated":true,"version":null,"sidebarTitle":"Update an existing status page","openapi":"/api-reference/openapi.json put /v1/status-pages/{statusPageId}","href":"/api-reference/status-pages/update-an-existing-status-page"},{"title":"Delete a status page.","deprecated":true,"version":null,"sidebarTitle":"Delete a status page","openapi":"/api-reference/openapi.json delete /v1/status-pages/{statusPageId}","href":"/api-reference/status-pages/delete-a-status-page"}]},{"group":"Status Page Incidents v1","tag":"Deprecated","pages":[{"title":"Retrieve the latest incidents with pagination.","deprecated":true,"version":null,"sidebarTitle":"Retrieve the latest incidents with pagination","openapi":"/api-reference/openapi.json get /v1/status-pages/incidents","href":"/api-reference/status-page-incidents/retrieve-the-latest-incidents-with-pagination"},{"title":"Create a new incident.","deprecated":true,"version":null,"sidebarTitle":"Create a new incident","openapi":"/api-reference/openapi.json post /v1/status-pages/incidents","href":"/api-reference/status-page-incidents/create-a-new-incident"},{"title":"Retrieve an incident by id.","deprecated":true,"version":null,"sidebarTitle":"Retrieve an incident by id","openapi":"/api-reference/openapi.json get /v1/status-pages/incidents/{incidentId}","href":"/api-reference/status-page-incidents/retrieve-an-incident-by-id"},{"title":"Update an existing incident.","deprecated":true,"version":null,"sidebarTitle":"Update an existing incident","openapi":"/api-reference/openapi.json put /v1/status-pages/incidents/{incidentId}","href":"/api-reference/status-page-incidents/update-an-existing-incident"},{"title":"Delete an incident.","deprecated":true,"version":null,"sidebarTitle":"Delete an incident","openapi":"/api-reference/openapi.json delete /v1/status-pages/incidents/{incidentId}","href":"/api-reference/status-page-incidents/delete-an-incident"}]},{"group":"Status Page Incident Updates v1","tag":"Deprecated","pages":[{"title":"Retrieve the 100 latest incident updates of a specific incident.","deprecated":true,"version":null,"sidebarTitle":"Retrieve the 100 latest incident updates of a specific incident","openapi":"/api-reference/openapi.json get /v1/status-pages/incidents/{incidentId}/incident-updates","href":"/api-reference/status-page-incidents/retrieve-the-100-latest-incident-updates-of-a-specific-incident"},{"title":"Add a new incident update to a specific incident.","deprecated":true,"version":null,"sidebarTitle":"Add a new incident update to a specific incident","openapi":"/api-reference/openapi.json post /v1/status-pages/incidents/{incidentId}/incident-updates","href":"/api-reference/status-page-incidents/add-a-new-incident-update-to-a-specific-incident"},{"title":"Retrieve an incident update by id.","deprecated":true,"version":null,"sidebarTitle":"Retrieve an incident update by id","openapi":"/api-reference/openapi.json get /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}","href":"/api-reference/status-page-incidents/retrieve-an-incident-update-by-id"},{"title":"Update an existing incident update.","deprecated":true,"version":null,"sidebarTitle":"Update an existing incident update","openapi":"/api-reference/openapi.json put /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}","href":"/api-reference/status-page-incidents/update-an-existing-incident-update"},{"title":"Delete an incident update.","deprecated":true,"version":null,"sidebarTitle":"Delete an incident update","openapi":"/api-reference/openapi.json delete /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}","href":"/api-reference/status-page-incidents/delete-an-incident-update"}]},{"group":"Status Page Services v1","tag":"Deprecated","pages":[{"title":"Get all services","deprecated":true,"version":null,"sidebarTitle":"Get all services","openapi":"/api-reference/openapi.json get /v1/status-pages/services","href":"/api-reference/status-page-services/get-all-services"},{"title":"Create a service","deprecated":true,"version":null,"sidebarTitle":"Create a service","openapi":"/api-reference/openapi.json post /v1/status-pages/services","href":"/api-reference/status-page-services/create-a-service"},{"title":"Get a single service","deprecated":true,"version":null,"sidebarTitle":"Get a single service","openapi":"/api-reference/openapi.json get /v1/status-pages/services/{serviceId}","href":"/api-reference/status-page-services/get-a-single-service"},{"title":"Update a service","deprecated":true,"version":null,"sidebarTitle":"Update a service","openapi":"/api-reference/openapi.json put /v1/status-pages/services/{serviceId}","href":"/api-reference/status-page-services/update-a-service"},{"title":"Delete a service","deprecated":true,"version":null,"sidebarTitle":"Delete a service","openapi":"/api-reference/openapi.json delete /v1/status-pages/services/{serviceId}","href":"/api-reference/status-page-services/delete-a-service"}]},{"group":"Status Page Subscribers v1","tag":"Deprecated","pages":[{"title":"Get all subscriptions for a specific status page","deprecated":true,"version":null,"sidebarTitle":"Get all subscriptions for a specific status page","openapi":"/api-reference/openapi.json get /v1/status-pages/{statusPageId}/subscriptions","href":"/api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page"},{"title":"Bulk create subscriptions for a specific status page","deprecated":true,"version":null,"sidebarTitle":"Bulk create subscriptions for a specific status page","openapi":"/api-reference/openapi.json post /v1/status-pages/{statusPageId}/subscriptions/bulk","href":"/api-reference/status-pages/bulk-create-subscriptions-for-a-specific-status-page"},{"title":"Delete a subscription belonging to a specific status page","deprecated":true,"version":null,"sidebarTitle":"Delete a subscription belonging to a specific status page","openapi":"/api-reference/openapi.json delete /v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}","href":"/api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page"}]},{"group":"Test Sessions","pages":[{"openapi":"get /v1/test-sessions","title":"List test sessions","href":"/api-reference/test-sessions/list-test-sessions"},{"openapi":"post /v1/test-sessions/trigger","title":"Trigger a new test session","href":"/api-reference/test-sessions/trigger-a-new-test-session"},{"openapi":"get /v1/test-sessions/{testSessionId}","title":"Retrieve a test session","href":"/api-reference/test-sessions/retrieve-a-test-session"},{"openapi":"get /v1/test-sessions/{testSessionId}/completion","title":"Await the completion of a test session","href":"/api-reference/test-sessions/await-the-completion-of-a-test-session"},{"openapi":"post /v1/test-sessions/{testSessionId}/cancel","title":"Cancel a test session","sidebarTitle":"Cancel a test session","href":"/api-reference/test-sessions/cancel-a-test-session"},{"openapi":"get /v1/test-sessions/{testSessionId}/results/{testSessionResultId}","title":"Retrieve a test session result","href":"/api-reference/test-sessions/retrieve-a-test-session-result"},{"openapi":"get /v1/test-sessions/{testSessionId}/results/{testSessionResultId}/assets","title":"Retrieve a normalized asset manifest for a test-session result","href":"/api-reference/test-sessions/retrieve-a-normalized-asset-manifest-for-a-test-session-result"}]},{"group":"Test Session Error Groups","pages":[{"openapi":"get /v1/test-session-error-groups/","title":null,"href":"/api-reference/test-session-error-groups/list-all-test-session-error-groups"},{"openapi":"get /v1/test-session-error-groups/projects/{projectId}","title":"List all test session error groups for a specific project.","href":"/api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project"},{"openapi":"get /v1/test-session-error-groups/{id}","title":"Retrieve one test session error group.","href":"/api-reference/test-session-error-groups/retrieve-a-test-session-error-group"},{"openapi":"patch /v1/test-session-error-groups/{id}","title":"Update an error group","href":"/api-reference/test-session-error-groups/update-a-test-session-error-group"}]},{"group":"Deployment Triggers","pages":[{"openapi":"get /v1/deployment-triggers","title":"List deployment triggers","sidebarTitle":"List triggers","href":"/api-reference/deployment-triggers/list-all-deployment-triggers"},{"openapi":"post /v1/deployment-triggers","title":"Create a deployment trigger","sidebarTitle":"Create a trigger","href":"/api-reference/deployment-triggers/create-a-deployment-trigger"}]},{"group":"Secret scans","pages":[{"openapi":"get /v1/secret-scans","title":"Lists readable configuration values that look like inline credentials.","href":"/api-reference/secret-scans/lists-readable-configuration-values-that-look-like-inline-credentials"}]}]}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/overview"}]},{"tab":"Learn","dropdowns":[{"dropdown":"Playwright","icon":"masks-theater","pages":[{"title":"Learn How to Test, Monitor, and Automate with Playwright","sidebarTitle":"Overview","href":"/learn/playwright/overview"},{"group":"Getting Started","pages":[{"title":"Beginner’s Guide to Playwright Automation","sidebarTitle":"What is Playwright?","href":"/learn/playwright/what-is-playwright"},{"title":"How to Set Up Playwright Locally","sidebarTitle":"Setting up Playwright","href":"/learn/playwright/how-to-set-up-locally"},{"title":"The Layers of the Testing Pyramid","href":"/learn/playwright/testing-pyramid"}]},{"group":"Interaction","pages":[{"title":"Playwright Assertions - Types \u0026 Best Practices","sidebarTitle":"Assertions","href":"/learn/playwright/assertions"},{"title":"How to Click, Type, and Hover with Playwright","sidebarTitle":"Clicking and typing","href":"/learn/playwright/clicking-typing-hovering"},{"title":"How to Handle iFrames in Playwright","sidebarTitle":"Interacting with iframes","href":"/learn/playwright/iframe-interaction"},{"title":"How to Use Playwright to Navigate and Interact with Web Pages","sidebarTitle":"Navigation","href":"/learn/playwright/navigation"},{"title":"How to Work with Selectors in Playwright","sidebarTitle":"UI selectors","href":"/learn/playwright/selectors"},{"title":"Dealing with waits and timeouts in Playwright","sidebarTitle":"Waits and timeouts","href":"/learn/playwright/waits-and-timeouts"}]},{"group":"Basics","pages":[{"title":"How to Manage Authentication in Playwright","sidebarTitle":"Authentication","href":"/learn/playwright/authentication"},{"title":"Record Automation Scripts Using Playwright Codegen","sidebarTitle":"Codegen","href":"/learn/playwright/codegen"},{"title":"How to emulate mobile devices with Playwright","sidebarTitle":"Emulating mobile devices","href":"/learn/playwright/emulating-mobile-devices"},{"title":"How to Generate PDFs with Playwright","sidebarTitle":"Generating PDFs","href":"/learn/playwright/generating-pdfs"},{"title":"How to detect broken links using Playwright","sidebarTitle":"Detecting broken links","href":"/learn/playwright/how-to-detect-broken-links"},{"title":"How to Intercept Requests in Playwright","sidebarTitle":"Intercepting requests","href":"/learn/playwright/intercept-requests"},{"title":"Test Dynamic Content by Mocking API Responses","sidebarTitle":"Mocking API Responses","href":"/learn/playwright/mock-api"},{"title":"Handling Multiple Tabs with Playwright","sidebarTitle":"Multiple tabs","href":"/learn/playwright/multitab-flows"},{"title":"Playwright Screenshots - How to Take and Automate Screenshots","sidebarTitle":"Taking screenshots","href":"/learn/playwright/taking-screenshots"},{"title":"How to run Playwright tests in parallel","sidebarTitle":"Parallel testing","href":"/learn/playwright/testing-in-parallel"}]},{"group":"Best Practices","pages":[{"title":"How to Handle Challenging Automation Flows in Playwright","sidebarTitle":"Complex workflows","href":"/learn/playwright/challenging-flows"},{"title":"How to Handle Test Data with Playwright","sidebarTitle":"Test data","href":"/learn/playwright/handling-test-data"},{"title":"Parameterizing your Playwright projects","sidebarTitle":"Parameterizing Projects","href":"/learn/playwright/how-to-parameterize-playwright-projects"},{"title":"Measuring Page Performance Using Playwright - Best Practices","sidebarTitle":"Performance","href":"/learn/playwright/performance"},{"title":"How to Scrape Data Behind a Login with Playwright","sidebarTitle":"Scraping behind a login","href":"/learn/playwright/scraping-behind-login"},{"title":"Using Script Recorders with Playwright","sidebarTitle":"Script recorders","href":"/learn/playwright/script-recorders"},{"title":"Self-documenting tests - add automatic Playwright steps with Typescript Decorators","sidebarTitle":"Automatic Steps","href":"/learn/playwright/steps-decorators"},{"title":"Reuse code with custom test fixtures in Playwright","sidebarTitle":"Test Fixtures","href":"/learn/playwright/test-fixtures"},{"title":"Testing APIs with Playwright","sidebarTitle":"Testing APIs","href":"/learn/playwright/testing-apis"},{"title":"Playwright Web Scraping - How to Extract Data from Websites","sidebarTitle":"Scraping","href":"/learn/playwright/web-scraping"},{"title":"Best Practices for Writing Tests in Playwright","sidebarTitle":"Testing","href":"/learn/playwright/writing-tests"}]},{"group":"E2E Examples","pages":[{"title":"How to Bypass Time-Based 2FA Login Flows With Playwright","sidebarTitle":"TOTP Authentication","href":"/learn/playwright/bypass-totp"},{"title":"Mastering E2E Checkout Testing Using Playwright","sidebarTitle":"Checkout","href":"/learn/playwright/checkout-testing-guide"},{"title":"How to Download Files with Playwright","sidebarTitle":"Downloading files","href":"/learn/playwright/file-download"},{"title":"How to Automate Google Login with Playwright","sidebarTitle":"Google Auth","href":"/learn/playwright/google-login-automation"},{"title":"How to search with Playwright","sidebarTitle":"Search","href":"/learn/playwright/how-to-search"},{"title":"How to Automate Login with Playwright","sidebarTitle":"Standard authentication","href":"/learn/playwright/login-automation"},{"title":"How to Automate Microsoft Live Login with Playwright","sidebarTitle":"Microsoft Live Auth","href":"/learn/playwright/microsoft-login-automation"},{"title":"How to Test Coupons and Discounts with Playwright","sidebarTitle":"Discounts \u0026 coupons","href":"/learn/playwright/testing-coupons"},{"title":"How to Test File Uploads with Playwright","sidebarTitle":"File uploads","href":"/learn/playwright/testing-file-uploads"},{"title":"Automating User Signup with Playwright","sidebarTitle":"User signup","href":"/learn/playwright/user-signup-automation"}]},{"group":"Debugging","pages":[{"title":"Playwright Debugging Errors - Common Issues and Solutions","sidebarTitle":"Common issues","href":"/learn/playwright/debugging-errors"},{"title":"Playwright Debugging - Techniques for Script Troubleshooting","sidebarTitle":"Debugging scripts","href":"/learn/playwright/debugging"},{"title":"How to Fix the \"Click Not Executed\" Error in Playwright","sidebarTitle":"Click not executed","href":"/learn/playwright/error-click-not-executed"},{"title":"How to Fix 'Element Not Found' Errors in Playwright","sidebarTitle":"Element not found","href":"/learn/playwright/error-element-not-found"},{"title":"How to Fix \"Element Not Visible\" Error in Playwright","sidebarTitle":"Element not visible","href":"/learn/playwright/error-element-not-visible"},{"title":"How to Fix \"Target Closed\" Error in Playwright","sidebarTitle":"Target closed","href":"/learn/playwright/error-target-closed"},{"title":"How to Fix \"Wait Not Respected\" Error in Playwright","sidebarTitle":"Wait not respected","href":"/learn/playwright/error-wait-not-respected"}]},{"group":"AI \u0026 Coding Agents","pages":[{"title":"Debugging Playwright Tests with AI Agents","sidebarTitle":"Debugging with AI agents","href":"/learn/playwright/debugging-with-ai-agents"}]}]},{"dropdown":"Incidents","icon":"triangle-exclamation","pages":[{"title":"Incident Response - Improve Recovery \u0026 Avoid Downtime","sidebarTitle":"Overview","href":"/learn/incidents/overview"},{"group":"Detection","pages":[{"title":"Best Practices for Detecting Downtime | Incident Response","sidebarTitle":"Detecting Downtime","href":"/learn/incidents/detection-best-practices"},{"title":"Incident Management Challenges | Checkly Guide","sidebarTitle":"Incident Management Challenges","href":"/learn/incidents/incident-management-challenges"},{"title":"Reduce Mean Time to Detection MTTD - Best Practices Guide","sidebarTitle":"MTTD Best Practices","href":"/learn/incidents/reduce-mttd"},{"title":"SLA vs SLO vs SLI - What’s the Difference? Comparison with examples","sidebarTitle":"SLA vs SLO vs SLI","href":"/learn/incidents/slo-sla-sli"},{"title":"What is Incident Response? Fundamentals and best practices","sidebarTitle":"What is Incident Response?","href":"/learn/incidents/what-is-incident-response"}]},{"group":"Classification","pages":[{"title":"Incident Response Automation - From Alerts to Action","sidebarTitle":"Playbooks \u0026 Automation","href":"/learn/incidents/automation-incident-response"},{"title":"Incident Assessment \u0026 Severity | Checkly Guide","sidebarTitle":"Incident Assessment \u0026 Severity Guide","href":"/learn/incidents/incident-assessment-severity"},{"title":"How to Set an On‑Call Schedule | Checkly Incident Response","sidebarTitle":"On-Call Schedules - How to","href":"/learn/incidents/on-call-schedule"},{"title":"Incident Response Playbooks - Culture \u0026 Compliance | Checkly","sidebarTitle":"Incident Response Playbooks","href":"/learn/incidents/playbooks"}]},{"group":"Investigation","pages":[{"title":"Modern Root Cause Analysis | Checkly Guide","sidebarTitle":"Modern Root Cause Analysis","href":"/learn/incidents/modern-root-cause-analysis"},{"title":"Root Cause with Traces - Faster RCA | Checkly","sidebarTitle":"Tracing for Root Cause Analysis","href":"/learn/incidents/root-cause-with-traces"}]},{"group":"Repair","pages":[{"title":"Defining MTTR - what mean time to repair means for your team","sidebarTitle":"What is MTTR?","href":"/learn/incidents/defining-mttr"},{"title":"How to Use DORA Metrics the Right Way | Checkly","sidebarTitle":"DORA Metrics for Performance Evaluation","href":"/learn/incidents/dora-metrics"},{"title":"MTTR Challenges \u0026 Solutions | Checkly","sidebarTitle":"Reducing Time to Repair","href":"/learn/incidents/mttr-challenges"}]},{"group":"Communication","pages":[{"title":"Anatomy of a Status Page | Checkly Guide","sidebarTitle":"Anatomy of a Status Page","href":"/learn/incidents/anatomy-of-a-status-page"},{"title":"Best Practices for Communicating During Outages and Incidents","sidebarTitle":"Incident Communication","href":"/learn/incidents/incident-communication"},{"title":"Postmortems That Drive Real Improvements (+ Template) | Checkly Guide","sidebarTitle":"Postmortems That Drive Real Improvement (+ Template)","href":"/learn/incidents/postmortems"}]}]},{"dropdown":"Kubernetes","icon":"dharmachakra","pages":[{"title":"Learn How to Observe and Monitor your Kubernetes","sidebarTitle":"Overview","href":"/learn/kubernetes/overview"},{"title":"Centralized logging in Kubernetes with OpenTelemetry - guide with examples","sidebarTitle":"Centralized Logging","href":"/learn/kubernetes/centralized-logging"},{"title":"Kubernetes Events - A Native Resource for State Insight","sidebarTitle":"Events","href":"/learn/kubernetes/events"},{"title":"Introducing klog - The Kubernetes Logging Library","sidebarTitle":"klog","href":"/learn/kubernetes/klog"},{"title":"Logging in Kubernetes - Best Practices","sidebarTitle":"Best Practices","href":"/learn/kubernetes/logging-best-practices"},{"title":"Learn How to Observe and Monitor your Kubernetes Environment with Open Source Tools","sidebarTitle":"Monitoring Kubernetes","href":"/learn/kubernetes/monitoring-challenges"},{"title":"Introduction to Node Problem Detector for Kubernetes","sidebarTitle":"Node Problem Detector","href":"/learn/kubernetes/node-problem-detector"},{"title":"Introduction to Kubernetes Operators - scraping metrics with Prometheus","sidebarTitle":"Operators","href":"/learn/kubernetes/operators-metrics"},{"title":"Structured Logging in Kubernetes - Why it matters and how to get started","sidebarTitle":"Structured Logging","href":"/learn/kubernetes/structured-logging"}]},{"dropdown":"Monitoring","icon":"chart-line","pages":[{"title":"Monitoring Resources - Tools, Metrics \u0026 Best Practices","sidebarTitle":"Monitoring","href":"/learn/monitoring/overview"},{"group":"SDLC Basics","pages":[{"title":"Understanding the Software Development Life Cycle (SDLC) for Engineers","sidebarTitle":"Understanding the SDLC","href":"/learn/monitoring/intro-to-sdlc"},{"title":"Observability Basics - Metrics that every team needs","sidebarTitle":"Metrics Every Team Needs","href":"/learn/monitoring/metrics-every-team-needs"}]},{"group":"Monitoring Concepts","pages":[{"title":"What is API Monitoring? - Tools, techniques, and examples","sidebarTitle":"API Monitoring","href":"/learn/monitoring/api-monitoring"},{"title":"What is End to End Monitoring? An Overview with Examples","sidebarTitle":"What is End-to-End Monitoring?","href":"/learn/monitoring/end-to-end-monitoring"},{"title":"Frontend Monitoring - Benefits, Challenges, and Top Tools","sidebarTitle":"Frontend Monitoring","href":"/learn/monitoring/frontend-monitoring"},{"title":"Monitoring as Code - A Practical Guide from Checkly","sidebarTitle":"Monitoring as Code","href":"/learn/monitoring/monitoring-as-code"},{"title":"Real User Monitoring (RUM) - Benefits, Challenges, and Alternatives","sidebarTitle":"Real User Monitoring","href":"/learn/monitoring/real-user-monitoring"},{"title":"Synthetic Monitoring - Concepts, Benefits \u0026 Challenges","sidebarTitle":"Synthetic Monitoring","href":"/learn/monitoring/synthetic-monitoring"},{"title":"Transaction Monitoring - Components, Benefits \u0026 Challenges","sidebarTitle":"Transaction Monitoring","href":"/learn/monitoring/transaction-monitoring"},{"title":"Web Application Monitoring - Types, Benefits \u0026 Top 10 Tools","sidebarTitle":"Web Application Monitoring","href":"/learn/monitoring/web-application-monitoring"}]},{"group":"Protocols","pages":[{"title":"HTTPS Fundamentals - Beginner's Guide for App Developers","sidebarTitle":"Intro to HTTPS","href":"/learn/monitoring/https-for-app-developers"},{"title":"TCP and SSL - What an application developer needs to know","sidebarTitle":"TCP and SSL","href":"/learn/monitoring/tcp-and-ssl"},{"title":"What is TCP? - how it works and why it matters to application developers","sidebarTitle":"What is TCP?","href":"/learn/monitoring/what-is-tcp"}]}]},{"dropdown":"OpenTelemetry","icon":"satellite-dish","pages":[{"title":"Learn How to Observe and Monitor your Software with OpenTelemetry","sidebarTitle":"Overview","href":"/learn/opentelemetry/overview"},{"group":"OpenTelemetry Basics","pages":[{"title":"Getting Started with Observability","sidebarTitle":"What is Observability?","href":"/learn/opentelemetry/getting-started-with-observability"},{"title":"How to instrument your application with OpenTelemetry","sidebarTitle":"Instrumentation","href":"/learn/opentelemetry/how-to-instrument"},{"title":"Introduction to the OpenTelemetry Collector","sidebarTitle":"The OTel Collector","href":"/learn/opentelemetry/what-is-the-otel-collector"}]},{"group":"Key Signals","pages":[{"title":"Logging in OpenTelemetry, an Engineer’s Guide","sidebarTitle":"Logging","href":"/learn/opentelemetry/logs"},{"title":"What are OpenTelemetry Metrics?","sidebarTitle":"Metrics","href":"/learn/opentelemetry/metrics"},{"title":"What are OpenTelemetry Traces? - key concepts and examples","sidebarTitle":"Traces","href":"/learn/opentelemetry/traces"}]},{"group":"Best Practices","pages":[{"title":"Fundamentals of Context Propagation in OpenTelemetry","sidebarTitle":"Context Propagation","href":"/learn/opentelemetry/context-propagation"},{"title":"OpenTelemetry Agent Management Protocol","sidebarTitle":"OpAMP","href":"/learn/opentelemetry/otel-agent-management-protocol"},{"title":"Advanced Data Filtering with the OpenTelemetry Collector","sidebarTitle":"Filtering","href":"/learn/opentelemetry/otel-filtering"},{"title":"A guide to the OpenTelemetry Trace API","sidebarTitle":"Trace API","href":"/learn/opentelemetry/trace-api"}]}]}]},{"tab":"Comparisons","pages":[{"title":"Comparisons","href":"/comparisons/frameworks/playwright-vs-cypress"}]}]},"title":"Using the Checkly API - Checkly Docs","buildId":"dpl_3rfzHPCtRhDFBbetXZ3oLkN5tjmA","deploymentId":"dpl_3rfzHPCtRhDFBbetXZ3oLkN5tjmA","dynamics":[],"chunks":[]}