Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Alert Rules API

The Alert Rules API from Qovery — 3 operation(s) for alert rules.

Qovery Alert Rules API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alert Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 5 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

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

5 operations 3 paths 20 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Alert Rules API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 5

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

Alert Rules 5
POST
/alert-rules
Create alert rule
createAlertRule body → 201400401403
GET
/alert-rules/{alertRuleId}
Get alert rule
getAlertRule 1 param → 200401403404
PUT
/alert-rules/{alertRuleId}
Update alert rule
editAlertRule 1 param body → 200400401403404
DELETE
/alert-rules/{alertRuleId}
Delete alert rule
deleteAlertRule 1 param → 204401403404
GET
/organization/{organizationId}/alert-rules
List alert rules
getAlertRules 1 param → 200401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AlertRuleCreationRequest (12 properties), ServiceLightResponse (11 properties), AlertRuleEditRequest (9 properties), AlertRuleCondition (5 properties). Each schema is shown below with its type and property counts.

AlertTargetType
The target of an alert
AlertRuleResponse
GhostAlertRuleResponse
Response for ghost alerts that exist in Prometheus but have been deleted from the database
AlertRuleConditionKind
AlertRuleCondition
object
5 properties 2 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
AlertRuleConditionFunction
AlertRuleConditionOperator
ServiceLightResponse
object
11 properties 10 required
AlertRuleList
object
1 property 1 required
AlertRuleSource
Source of the alert rule: - MANAGED: Alert rule created and managed through the Qovery API - GHOST: Alert rule that exists in Prometheus but has been deleted f…
AlertTarget
object
3 properties 2 required
AlertRuleCreationRequest
object
12 properties 12 required
AlertPresentationResponse
object
2 properties
AlertRuleState
AlertSeverity
Alert severity level: - LOW: Minor issues or informational alerts that don't require immediate attention. Can be addressed during normal business hours. - MEDI…
AlertRuleResponseBase
object
Base schema for alert rule responses with discriminator
3 properties 3 required
AlertPresentation
object
2 properties
AlertRuleEditRequest
object
9 properties 9 required
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-alert-rules-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API
Qovery Applications API