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

Checkly Alert Channels API

The Alert Channels API from Checkly — 6 operation(s) for alert channels.

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

Tagged areas include Alert Channels. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

6 operations 3 paths 27 schemas 1 DELETE2 GET1 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 Alert Channels 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 6

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

Alert channels 6
GET
/v1/alert-channels
List all alert channels
getV1Alertchannels 3 params → 200401403429
POST
/v1/alert-channels
Create an alert channel
postV1Alertchannels 1 param body → 201401402403429
DELETE
/v1/alert-channels/{id}
Delete an alert channel
deleteV1AlertchannelsId 2 params → 204401403429
GET
/v1/alert-channels/{id}
Retrieve an alert channel
getV1AlertchannelsId 2 params → 200401403404429
PUT
/v1/alert-channels/{id}
Update an alert channel
putV1AlertchannelsId 2 params body → 200401402403429
PUT
/v1/alert-channels/{id}/subscriptions
Update the subscriptions of an alert channel
putV1AlertchannelsIdSubscriptions 2 params body → 200401403404429

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are AlertChannelRead (13 properties), AlertChannel (12 properties), AlertChannelCreate (9 properties), UnauthorizedError (4 properties). Each schema is shown below with its type and property counts.

attributes
object
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
Model2
string
TooManyRequestsError
object
4 properties 2 required
UnauthorizedError
object
4 properties 2 required
AlertChannelCreate
object
9 properties 2 required
AlertChannelSubscriptionCreate
object
3 properties 1 required
PaymentRequiredError
object
4 properties 2 required
AlertChannel
object
12 properties 3 required
ProjectBindingV1
object
2 properties 2 required
AlertChannelList
array
ForbiddenError
object
3 properties 2 required
ProjectBindingDetailsV1
object
The resource's side of this binding.
2 properties 2 required
AlertChanelSubscription
object
4 properties 1 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
BindingProjectV1
object
The project this binding is to.
3 properties 3 required
Model3
string
NotFoundError
object
3 properties 2 required
error
string
type
string
Model4
string
AlertChannelConfig
object
The configuration details for this alert channel. These can be very different based on the type of the channel.
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
AlertChannelCreateConfig
object
AlertChannelRead
object
13 properties 3 required
AlertChanelSubscriptionList
array
All checks subscribed to this channel.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-alert-channels-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly Accounts API
Checkly Analytics API
Checkly Check Alerts API
Checkly Check Groups API
Checkly Check Results API
Checkly Checks API
Checkly Dashboards API
Checkly Heartbeats API
Checkly Incidents API
Checkly Maintenance Windows API
Checkly Private Locations API
Where this information came from

This is an independent, third-party profile of Checkly Alert Channels 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.