Test an unsaved channel configuration
curl --request POST \
--url https://app.aiaxoniq.com/api/alerts/test-channel \
--header 'Content-Type: application/json' \
--cookie oiq_token= \
--data '
{
"channel": "<string>",
"channelConfig": {},
"ruleName": "<string>",
"severity": "<string>"
}
'import requests
url = "https://app.aiaxoniq.com/api/alerts/test-channel"
payload = {
"channel": "<string>",
"channelConfig": {},
"ruleName": "<string>",
"severity": "<string>"
}
headers = {
"cookie": "oiq_token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'oiq_token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
channel: '<string>',
channelConfig: {},
ruleName: '<string>',
severity: '<string>'
})
};
fetch('https://app.aiaxoniq.com/api/alerts/test-channel', 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://app.aiaxoniq.com/api/alerts/test-channel",
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([
'channel' => '<string>',
'channelConfig' => [
],
'ruleName' => '<string>',
'severity' => '<string>'
]),
CURLOPT_COOKIE => "oiq_token=",
CURLOPT_HTTPHEADER => [
"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://app.aiaxoniq.com/api/alerts/test-channel"
payload := strings.NewReader("{\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"ruleName\": \"<string>\",\n \"severity\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "oiq_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://app.aiaxoniq.com/api/alerts/test-channel")
.header("cookie", "oiq_token=")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"ruleName\": \"<string>\",\n \"severity\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiaxoniq.com/api/alerts/test-channel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'oiq_token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"ruleName\": \"<string>\",\n \"severity\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}Alerts
Test an unsaved channel configuration
Requires an authenticated session with at least the ADMIN role. ADMIN only. channel is validated against the delivery vocabulary by the handler, which answers 400 naming the valid set.
POST
/
api
/
alerts
/
test-channel
Test an unsaved channel configuration
curl --request POST \
--url https://app.aiaxoniq.com/api/alerts/test-channel \
--header 'Content-Type: application/json' \
--cookie oiq_token= \
--data '
{
"channel": "<string>",
"channelConfig": {},
"ruleName": "<string>",
"severity": "<string>"
}
'import requests
url = "https://app.aiaxoniq.com/api/alerts/test-channel"
payload = {
"channel": "<string>",
"channelConfig": {},
"ruleName": "<string>",
"severity": "<string>"
}
headers = {
"cookie": "oiq_token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'oiq_token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
channel: '<string>',
channelConfig: {},
ruleName: '<string>',
severity: '<string>'
})
};
fetch('https://app.aiaxoniq.com/api/alerts/test-channel', 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://app.aiaxoniq.com/api/alerts/test-channel",
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([
'channel' => '<string>',
'channelConfig' => [
],
'ruleName' => '<string>',
'severity' => '<string>'
]),
CURLOPT_COOKIE => "oiq_token=",
CURLOPT_HTTPHEADER => [
"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://app.aiaxoniq.com/api/alerts/test-channel"
payload := strings.NewReader("{\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"ruleName\": \"<string>\",\n \"severity\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "oiq_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://app.aiaxoniq.com/api/alerts/test-channel")
.header("cookie", "oiq_token=")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"ruleName\": \"<string>\",\n \"severity\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiaxoniq.com/api/alerts/test-channel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'oiq_token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"ruleName\": \"<string>\",\n \"severity\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}Authorizations
sessionCookiebearerAuth
Query Parameters
Tenant identifier. Overwritten from the authenticated session; a value naming a different tenant is refused with 403.
Required string length:
1 - 64Pattern:
^[A-Za-z0-9][A-Za-z0-9_-]*$Body
application/json
Response
Success