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 Receivers API

The Alert Receivers API from Qovery — 5 operation(s) for alert receivers.

Qovery Alert Receivers 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 Receivers. 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 7 operations across 5 paths, and defines 16 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.

7 operations 5 paths 16 schemas 1 DELETE2 GET3 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 Receivers 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 7

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

Alert Receivers 7
GET
/organization/{organizationId}/alert-receivers
List alert receivers
getAlertReceivers 1 param → 200401403404
POST
/alert-receivers
Create alert receiver
createAlertReceiver body → 201400401403
GET
/alert-receivers/{alertReceiverId}
Get alert receiver
getAlertReceiver 1 param → 200400403404
PUT
/alert-receivers/{alertReceiverId}
Update alert receiver
editAlertReceiver 1 param body → 200400401403404
DELETE
/alert-receivers/{alertReceiverId}
Delete alert receiver
deleteAlertReceiver 1 param → 204401403404
POST
/alert-receivers/{alertReceiverId}/validate
Validate Existing Alert Receiver
validateExistingAlertReceiver 1 param body → 200400401403404
POST
/alert-receivers/validate
Validate New Alert Receiver
validateNewAlertReceiver body → 200400401403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AlertReceiverCreationRequestBase (7 properties), AlertReceiverEditRequestBase (6 properties), Base (3 properties), AlertReceiverCreationValidationRequest (2 properties). Each schema is shown below with its type and property counts.

AlertReceiverType
AlertReceiverList
object
1 property 1 required
EmailAlertReceiverEditRequest
AlertReceiverCreationRequest
AlertReceiverValidationRequest
object
1 property
AlertReceiverEditRequest
AlertReceiverResponse
AlertReceiverEditRequestBase
object
6 properties 4 required
AlertReceiverCreationValidationRequest
object
2 properties 1 required
SlackAlertReceiverEditRequest
SlackAlertReceiverResponse
EmailAlertReceiverResponse
SlackAlertReceiverCreationRequest
AlertReceiverCreationRequestBase
object
7 properties 5 required
EmailAlertReceiverCreationRequest
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Rules 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