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

CloudQuery alerts API

The alerts API from CloudQuery — 10 operation(s) for alerts.

CloudQuery alerts API is one of 26 APIs that CloudQuery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 13 operations across 10 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudquery.io.

13 operations 10 paths 20 schemas 2 DELETE5 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cloudquery.io
Authentication
HTTP Bearer, HTTP Basic, HTTP Cookie
License
Terms of Service
Resource Areas
1

Authentication & Security 3

CloudQuery alerts API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). It uses HTTP cookie authentication (cookieAuth). By default, every request must be authenticated.

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

alerts 13
GET
/alerts
List all alerts
PlatformListAllAlerts 5 params → 200401403404422500
POST
/alerts/test
Test an unsaved alert
PlatformTestUnsavedAlert 1 param body → 200400401403404422500
GET
/notifications/destinations
List all notification destinations
PlatformListAllNotificationDestinations 2 params → 200401403404422500
POST
/notifications/destinations
Create notification destination
PlatformCreateNotificationDestination body → 201400401403404422500
POST
/notifications/destinations/test
Test an unsaved notification destination
PlatformTestUnsavedNotificationDestination 1 param body → 200400401403404422500
GET
/notifications/destination/{notification_destination_id}
Get notification destination
PlatformGetNotificationDestination 1 param → 200401403404422500
PATCH
/notifications/destination/{notification_destination_id}
Update a notification destination
PlatformUpdateNotificationDestination 1 param body → 200400401403404422500
DELETE
/notifications/destination/{notification_destination_id}
Delete a notification destination
PlatformDeleteNotificationDestination 1 param → 204401403404422500
GET
/notifications/destination/{notification_destination_id}/alerts
Get notification destination alerts
PlatformGetNotificationDestinationAlerts 3 params → 200401403404422500
POST
/notifications/destination/{notification_destination_id}/test
Test a notification destination
PlatformTestNotificationDestination 1 param → 200400401403404422429500
POST
/slack
Create Slack connection
PlatformCreateSlackConnection body → 201400401403404422500
GET
/slack/{id}/channels
List Slack channels for a connection
PlatformListSlackChannels 2 params → 200401403404422500
DELETE
/queries/{query_id}/alert
Delete an alert associated with a saved query
PlatformDeleteAlert 1 param → 204401403404422500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are PlatformNotificationDestination (16 properties), PlatformAlertDetail (12 properties), PlatformNotificationDestinationUpdate (9 properties), PlatformNotificationDestinationListItem (8 properties). Each schema is shown below with its type and property counts.

PlatformNotificationDestination
object
Notification Destination
16 properties 7 required
PlatformSlackChannel
object
Slack Channel
4 properties 2 required
PlatformNotificationDestinationCreate
object
Create Notification Destination
PlatformAlertTestResponse
object
Alert Test Response
3 properties 2 required
PlatformAlertState
string
PlatformQueryID
string
The unique ID for the query.
PlatformListMetadata
object
4 properties 1 required
PlatformNotificationDestinationID
string
The unique ID for the notification destination.
PlatformAlertCreate
object
Create an alert
4 properties 3 required
PlatformNotificationDestinationUpdate
object
Update Notification Destination
9 properties
PlatformNotificationDestinationTestResponse
object
Notification Destination Test Response
5 properties 5 required
PlatformQueryTag
string
A saved query tag.
PlatformFieldError
PlatformNotificationDestinationListItem
object
Notification Destination List Item
8 properties 7 required
PlatformBasicError
object
Basic Error
2 properties 2 required
PlatformNotificationDestinationData
object
Notification Destination Data
8 properties
PlatformAlertDetail
object
An alert instance that can be triggered by a query including notification destinations for the alert
12 properties 10 required
PlatformSlackConnection
object
Slack Connection
5 properties 5 required
PlatformSlackConnectionCreate
object
Create Slack Connection
2 properties 1 required
PlatformAlertSeverity
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudquery-alerts-api-openapi.yml Raw ↑

Other APIs CloudQuery publishes across the network.

CloudQuery Platform API
CloudQuery admin API
CloudQuery api-keys API
CloudQuery apps API
CloudQuery audit-logs API
CloudQuery chat API
CloudQuery custom-columns API
CloudQuery filters API
CloudQuery healthcheck API
CloudQuery insights API
CloudQuery notifications API
CloudQuery onboardings API
Where this information came from

This is an independent, third-party profile of CloudQuery alerts 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.