Validate New Alert Receiver

Validate a future alert receiver by sending a test message.

POST /alert-receivers/validate

Validate New Alert Receiver

cURL

curl --request POST \
  --url https://api.qovery.com/alert-receivers/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alert_receiver": {
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "send_resolved": true,
    "webhook_url": "<string>",
    "owner": "<string>",
    "severity": "<string>"
  },
  "message": "<string>"
}
'

import requests

url = "https://api.qovery.com/alert-receivers/validate"

payload = {
    "alert_receiver": {
        "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "send_resolved": True,
        "webhook_url": "<string>",
        "owner": "<string>",
        "severity": "<string>"
    },
    "message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    alert_receiver: {
      organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      name: '<string>',
      description: '<string>',
      send_resolved: true,
      webhook_url: '<string>',
      owner: '<string>',
      severity: '<string>'
    },
    message: '<string>'
  })
};

fetch('https://api.qovery.com/alert-receivers/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/alert-receivers/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'alert_receiver' => [
        'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'name' => '<string>',
        'description' => '<string>',
        'send_resolved' => true,
        'webhook_url' => '<string>',
        'owner' => '<string>',
        'severity' => '<string>'
    ],
    'message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/alert-receivers/validate"

	payload := strings.NewReader("{\n  \"alert_receiver\": {\n    \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"send_resolved\": true,\n    \"webhook_url\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"severity\": \"<string>\"\n  },\n  \"message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.qovery.com/alert-receivers/validate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alert_receiver\": {\n    \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"send_resolved\": true,\n    \"webhook_url\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"severity\": \"<string>\"\n  },\n  \"message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/alert-receivers/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"alert_receiver\": {\n    \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"send_resolved\": true,\n    \"webhook_url\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"severity\": \"<string>\"\n  },\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

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 ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Body

application/json

alert_receiver · SlackAlertReceiverCreationRequest · object · required

SlackAlertReceiverCreationRequest

EmailAlertReceiverCreationRequest

Show child attributes

message · string

Response

200

OK