How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Checkly

Checkly Check Groups API

The Check Groups API from Checkly — 11 operation(s) for check groups.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 8 paths, and defines 87 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

11 operations 8 paths 87 schemas 1 DELETE6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Check Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — The Checkly Public API uses API keys to authenticate requests. You can get the API Key here . Your API key is like a password: keep it secure! Authentication t…

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Check groups 11
GET
/v1/check-groups
List all check groups
getV1Checkgroups 5 params → 200401403429
POST
/v1/check-groupsdeprecated
Create a check group
postV1Checkgroups 2 params body → 201401402403429
GET
/v1/check-groups/{groupId}/checks/{checkId}
Retrieve one check in a specific group with group settings applied
getV1CheckgroupsGroupidChecksCheckid 3 params → 200401403404429
DELETE
/v1/check-groups/{id}
Delete a check group.
deleteV1CheckgroupsId 2 params → 204401403409429
GET
/v1/check-groups/{id}
Retrieve a check group
getV1CheckgroupsId 2 params → 200401403404429
PUT
/v1/check-groups/{id}deprecated
Update a check group
putV1CheckgroupsId 3 params body → 200401403404429
GET
/v1/check-groups/{id}/checks
Retrieve all checks in a specific group with group settings applied
getV1CheckgroupsIdChecks 4 params → 200401403404429
POST
/v2/check-groups
Create a check group (V2)
postV2Checkgroups 2 params body → 201401402403429
GET
/v2/check-groups/{groupId}/checks/{checkId}
Retrieve one check in a specific group with group settings applied (V2)
getV2CheckgroupsGroupidChecksCheckid 3 params → 200401403404429
PUT
/v2/check-groups/{id}
Update a check group (V2)
putV2CheckgroupsId 3 params body → 200401403404429
GET
/v2/check-groups/{id}/checks
Retrieve all checks in a specific group with group settings applied (V2)
getV2CheckgroupsIdChecks 4 params → 200401403404429

Schemas 87

The contract defines 87 schemas that model the data the API accepts and returns. The most detailed are CheckGroupRead (25 properties), CheckGroup (24 properties), CheckGroupCreate (21 properties), CheckGroupCreateOrUpdateV2 (21 properties). Each schema is shown below with its type and property counts.

attributes
object
Model2
string
Assertion
object
5 properties
PaymentRequiredError
object
4 properties 2 required
EnvironmentVariableGet
object
4 properties 2 required
Model22
array
ForbiddenError
object
3 properties 2 required
AssertionSource
string
AlertSettingsRunBasedEscalation
object
1 property
KeyValue
object
3 properties 2 required
Model3
string
AlertSettingsEscalationType
string
Determines what type of escalation to use
Model7
string
Model86
arraynull
An array of one or more private locations where to run the checks.
Model85
array
List of alert channel subscriptions.
runtimeId
stringnull
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
CheckGroupAlertSettings
object
Alert settings.
6 properties
AlertSettingsParallelRunFailureThreshold
object
2 properties
Model89
object
2 properties
AlertSettings
object
Alert settings.
6 properties
CheckGroupRead
object
25 properties 4 required
Model19
stringnull
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
UnauthorizedError
object
4 properties 2 required
Model12
array
List of alert channel subscriptions.
TooManyRequestsError
object
4 properties 2 required
CheckGroupCreateOrUpdateV2
object
21 properties 1 required
AlertChannelSubscriptionCreateList
array
List of alert channel subscriptions.
CheckGroupCheckV2
object
2 properties 1 required
CheckGroupAPICheckDefaults
object
5 properties
RetryOnlyOn
array
CheckGroup
object
24 properties 4 required
Model88
object
1 property
ProjectBindingV1
object
2 properties 2 required
Model14
string
HeaderList
array
QueryParameterList
array
checkType
string
The type of the check.
CheckGroupLocationList
array
An array of one or more data center locations where to run the checks.
AlertSettingsTimeBasedEscalation
object
1 property
escalationType
string
Determines what type of escalation to use.
CheckGroupCheckListV2
array
Model20
array
List of alert channel subscriptions.
privateLocations
arraynull
An array of one or more private locations where to run the check.
AssertionComparison
string
AlertSettingsSSLCertificates
object
[DEPRECATED] sslCertificates is deprecated and is not longer used. Please ignore it, will be removed in a future version.
2 properties
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
Model83
array
An array of one or more data center locations where to run the checks.
Model16
string
InternalAlertSettingsCreate
objectnull
5 properties
RetryStrategyType
string
Determines which type of retry strategy to use.
ConflictError
object
3 properties 2 required
Model11
stringnull
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
CheckGroupUpdate
object
21 properties
RetryStrategy
objectnull
The strategy to determine how failed checks are retried.
6 properties 1 required
ProjectBindingDetailsV1
object
The resource's side of this binding.
2 properties 2 required
Model87
object
1 property
BindingProjectV1
object
The project this binding is to.
3 properties 3 required
CheckGroupCreateAPICheckDefaults
object
5 properties
Model15
array
An array of one or more data center locations where to run the checks.
Model82
string
Model84
stringnull
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
Model4
string
Model9
string
Model10
array
An array of one or more data center locations where to run the checks.
Model1
string
ProjectBindingsV1
object
The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
2 properties 2 required
EnvironmentVariableUpdate
object
4 properties 1 required
CheckGroupCheck
object
2 properties 1 required
parallelRunFailureThreshold
object
2 properties
Model8
object
Alert channel subscription.
2 properties 2 required
CheckGroupTagList
array
Tags for organizing and filtering checks.
AlertSettingsReminders
object
2 properties
EnvironmentVariableList
arraynull
Model18
array
An array of one or more data center locations where to run the checks.
CheckGroupList
array
Model17
string
FallbackRetryStrategy
string
RetryOnlyOnValue
string
The HTTP request could not be completed due to a network error: no response status code was received
Model13
arraynull
An array of one or more private locations where to run the checks.
BasicAuth
objectnull
2 properties 2 required
ProjectBindingOwnerV1
objectnull
The project that owns this resource — the one whose deploy can delete it. Null when no project owns it, including when other projects merely reference it. In t…
2 properties 2 required
Model21
arraynull
An array of one or more private locations where to run the checks.
NotFoundError
object
3 properties 2 required
error
string
AssertionList
array
Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.
environmentVariables
arraynull
CheckGroupCreate
object
21 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-check-groups-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly
AE Profile APIs.io
Checkly Accounts API
AE Profile APIs.io
Checkly Alert Channels API
AE Profile APIs.io
Checkly Analytics API
AE Profile APIs.io
Checkly Check Alerts API
AE Profile APIs.io
Checkly Check Results API
AE Profile APIs.io
Checkly Checks API
AE Profile APIs.io
Checkly Dashboards API
AE Profile APIs.io
Checkly Heartbeats API
AE Profile APIs.io
Checkly Incidents API
AE Profile APIs.io
Checkly Maintenance Windows API
AE Profile APIs.io
Checkly Private Locations API
AE Profile APIs.io
#Check Groups
← Back to C APIs
API Details
ID
checkly:checkly-check-groups-api
Base URL
https://api.checklyhq.com
Docs
https://www.checklyhq.com
Provider
Checkly
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=checkly-check-groups-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/checkly-check-groups-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Checkly Check Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.