Skip to content

AlertRulesApi.md

Latest commit

 

History

History
164 lines (90 loc) · 4.68 KB

AlertRulesApi.md

File metadata and controls

164 lines (90 loc) · 4.68 KB
Raw

\AlertRulesApi

All URIs are relative to https://api.qovery.com

Method HTTP request Description
create_alert_rule POST /alert-rules Create alert rule
delete_alert_rule DELETE /alert-rules/{alertRuleId} Delete alert rule
edit_alert_rule PUT /alert-rules/{alertRuleId} Update alert rule
get_alert_rule GET /alert-rules/{alertRuleId} Get alert rule
get_alert_rules GET /organization/{organizationId}/alert-rules List alert rules

create_alert_rule

models::AlertRuleResponse create_alert_rule(alert_rule_creation_request) Create alert rule

Create a new alert rule with PromQL expression

Parameters

Name Type Description Required Notes
alert_rule_creation_request Option<AlertRuleCreationRequest>

Return type

models::AlertRuleResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_alert_rule

delete_alert_rule(alert_rule_id) Delete alert rule

Delete an alert rule

Parameters

Name Type Description Required Notes
alert_rule_id uuid::Uuid Alert Rule ID [required]

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_alert_rule

models::AlertRuleResponse edit_alert_rule(alert_rule_id, alert_rule_edit_request) Update alert rule

Update an existing alert rule

Parameters

Name Type Description Required Notes
alert_rule_id uuid::Uuid Alert Rule ID [required]
alert_rule_edit_request Option<AlertRuleEditRequest>

Return type

models::AlertRuleResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_alert_rule

models::AlertRuleResponse get_alert_rule(alert_rule_id) Get alert rule

Retrieve a specific alert rule by its ID

Parameters

Name Type Description Required Notes
alert_rule_id uuid::Uuid Alert Rule ID [required]

Return type

models::AlertRuleResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_alert_rules

models::AlertRuleList get_alert_rules(organization_id) List alert rules

Retrieve all alert rules for a specific organization

Parameters

Name Type Description Required Notes
organization_id uuid::Uuid Organization ID [required]

Return type

models::AlertRuleList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]