Checkly Checks API
The Checks API from Checkly — 18 operation(s) for checks.
Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which checks are in my Checkly account, with the older flat project and logicalId fields?”
“Can I list only my browser checks carrying a particular tag in the v1 check listing?”
Tell an agent
List all checks in my account using the v1 endpoint.
Using the v1 check list, show checks tagged {tag} of type {checkType}.
Ask an LLM
“Is the generic create-a-check endpoint that takes either an API or browser type still usable?”
“What happens on the deprecated combined check create if I'm over my plan's check limit?”
Tell an agent
Create a check named {name} of type {checkType} with the deprecated generic create endpoint.
Using the old combined endpoint, add a {checkType} check called {name} that runs every {frequency} minutes.
Ask an LLM
“How do I set up a new API check that monitors an HTTP endpoint?”
“Can a new API check alert me when responses get slower than a set threshold?”
Tell an agent
Create an API check named {name} that requests {request}.
Add an API check {name} hitting {request} from {locations} every {frequency} minutes.
Ask an LLM
“Can I change the request or response time limits on an existing API check?”
“Is it possible to mute or deactivate an API check I already created?”
Tell an agent
Update API check {id} to request {request}.
Mute API check {id}.
Ask an LLM
“How can I monitor a web page with a Playwright script in Checkly?”
“What script does a new browser check need to run?”
Tell an agent
Create a browser check named {name} that runs this script: {script}.
Add browser check {name} running {script} every {frequency} minutes from {locations}.
Ask an LLM
“Can I replace the script of an existing browser check?”
“Which settings of a browser check can be edited after it is created?”
Tell an agent
Update browser check {id} to run the script {script}.
Deactivate browser check {id}.
Ask an LLM
“How do I monitor that a domain's DNS records resolve correctly?”
“Can a DNS monitor alert me when lookups take too long?”
Tell an agent
Create a DNS monitor named {name} for the lookup {request}.
Add DNS monitor {name} checking {request} every {frequency} minutes.
Ask an LLM
“Can I chain several API calls into a single scripted check?”
“What does a multi-step check need to be created?”
Tell an agent
Create a multi-step check named {name} with the script {script}.
Add multi-step check {name} running {script} from {locations}.
Ask an LLM
“Can I edit the script of a multi-step check I already have?”
“Is it possible to move an existing multi-step check into a check group?”
Tell an agent
Update multi-step check {id} to use the script {script}.
Move multi-step check {id} into group {groupId}.
Ask an LLM
“How can I monitor whether a TCP port on my server accepts connections?”
“Can a TCP check flag slow connections as degraded?”
Tell an agent
Create a TCP check named {name} for {request}.
Add TCP check {name} on {request} that fails after {maxResponseTime} ms.
Ask an LLM
“Can I change the host or port an existing TCP check connects to?”
“Is there a way to pause a TCP check without deleting it?”
Tell an agent
Update TCP check {id} to connect to {request}.
Deactivate TCP check {id}.
Ask an LLM
“How do I permanently remove a check from my account?”
“Does deleting a check also erase its status and results history?”
Tell an agent destructive · confirm first
Delete check {id}.
Permanently remove check {id} along with all its results.
Ask an LLM
“What are the full settings of one check, including the old flat project and logicalId fields?”
“Can the v1 check detail include the checks it depends on?”
Tell an agent
Show v1 details for check {id}.
Get check {id} from the v1 endpoint with its dependencies included.
Ask an LLM
“Does the deprecated generic update endpoint still modify API and browser checks?”
“Is there an older single endpoint that updates any check type by its ID?”
Tell an agent
Update check {id} through the deprecated generic update endpoint, renaming it to {name}.
Use the old combined update to set check {id} frequency to {frequency} minutes.
Ask an LLM
“Which projects manage each of my checks when one check belongs to several projects?”
“Can I filter the v2 check list by status or a search term?”
Tell an agent
List all checks with their project bindings from the v2 endpoint.
Search v2 checks for {search} with status {status}.
Ask an LLM
“Which projects is a specific check bound to?”
“Can I fetch one check without the legacy flat project field?”
Tell an agent
Show check {id} with every project binding using the v2 endpoint.
Get the v2 details of check {id} with group settings applied.
Ask an LLM
“Can I see the required outcomes and must-preserve constraints for all my checks?”
“What does the newest check list return for check intent?”
Tell an agent
List all checks with their intent constraints from the v3 endpoint.
List v3 checks of type {checkType} tagged {tag}, showing constraints.
Ask an LLM
“What REQUIRED_OUTCOME and MUST_PRESERVE constraints does a specific check have?”
“Where do I read one check's intent as typed constraints instead of legacy arrays?”
Tell an agent
Show the v3 details and constraints for check {id}.
Get check {id} from v3 including its dependencies.