Test Preset Config
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"configOverrides": [
{
"conditionType": {
"matchEntityType": {},
"matchEntityTypeAndSubType": {
"entitySubType": "<string>"
}
},
"messageConfig": {
"fields": [
{
"fieldName": "title",
"template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
},
"payloadType": "<string>"
}
],
"connectorId": "<string>",
"entitySubType": "metric",
"parentPresetId": "<string>"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig"
payload = {
"configOverrides": [
{
"conditionType": {
"matchEntityType": {},
"matchEntityTypeAndSubType": { "entitySubType": "<string>" }
},
"messageConfig": { "fields": [
{
"fieldName": "title",
"template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
] },
"payloadType": "<string>"
}
],
"connectorId": "<string>",
"entitySubType": "metric",
"parentPresetId": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configOverrides: [
{
conditionType: {matchEntityType: {}, matchEntityTypeAndSubType: {entitySubType: '<string>'}},
messageConfig: {
fields: [
{
fieldName: 'title',
template: '{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}'
}
]
},
payloadType: '<string>'
}
],
connectorId: '<string>',
entitySubType: 'metric',
parentPresetId: '<string>'
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig', 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.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig",
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([
'configOverrides' => [
[
'conditionType' => [
'matchEntityType' => [
],
'matchEntityTypeAndSubType' => [
'entitySubType' => '<string>'
]
],
'messageConfig' => [
'fields' => [
[
'fieldName' => 'title',
'template' => '{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}'
]
]
],
'payloadType' => '<string>'
]
],
'connectorId' => '<string>',
'entitySubType' => 'metric',
'parentPresetId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig"
payload := strings.NewReader("{\n \"configOverrides\": [\n {\n \"conditionType\": {\n \"matchEntityType\": {},\n \"matchEntityTypeAndSubType\": {\n \"entitySubType\": \"<string>\"\n }\n },\n \"messageConfig\": {\n \"fields\": [\n {\n \"fieldName\": \"title\",\n \"template\": \"{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}\"\n }\n ]\n },\n \"payloadType\": \"<string>\"\n }\n ],\n \"connectorId\": \"<string>\",\n \"entitySubType\": \"metric\",\n \"parentPresetId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configOverrides\": [\n {\n \"conditionType\": {\n \"matchEntityType\": {},\n \"matchEntityTypeAndSubType\": {\n \"entitySubType\": \"<string>\"\n }\n },\n \"messageConfig\": {\n \"fields\": [\n {\n \"fieldName\": \"title\",\n \"template\": \"{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}\"\n }\n ]\n },\n \"payloadType\": \"<string>\"\n }\n ],\n \"connectorId\": \"<string>\",\n \"entitySubType\": \"metric\",\n \"parentPresetId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configOverrides\": [\n {\n \"conditionType\": {\n \"matchEntityType\": {},\n \"matchEntityTypeAndSubType\": {\n \"entitySubType\": \"<string>\"\n }\n },\n \"messageConfig\": {\n \"fields\": [\n {\n \"fieldName\": \"title\",\n \"template\": \"{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}\"\n }\n ]\n },\n \"payloadType\": \"<string>\"\n }\n ],\n \"connectorId\": \"<string>\",\n \"entitySubType\": \"metric\",\n \"parentPresetId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"success": {
"metadata": {}
},
"failure": {
"message": "<string>",
"statusCode": 349
}
}
}Notifications Testing Service
Test Preset Config
Tests a notification preset configuration.
Test Preset Config
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"configOverrides": [
{
"conditionType": {
"matchEntityType": {},
"matchEntityTypeAndSubType": {
"entitySubType": "<string>"
}
},
"messageConfig": {
"fields": [
{
"fieldName": "title",
"template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
},
"payloadType": "<string>"
}
],
"connectorId": "<string>",
"entitySubType": "metric",
"parentPresetId": "<string>"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig"
payload = {
"configOverrides": [
{
"conditionType": {
"matchEntityType": {},
"matchEntityTypeAndSubType": { "entitySubType": "<string>" }
},
"messageConfig": { "fields": [
{
"fieldName": "title",
"template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
] },
"payloadType": "<string>"
}
],
"connectorId": "<string>",
"entitySubType": "metric",
"parentPresetId": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configOverrides: [
{
conditionType: {matchEntityType: {}, matchEntityTypeAndSubType: {entitySubType: '<string>'}},
messageConfig: {
fields: [
{
fieldName: 'title',
template: '{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}'
}
]
},
payloadType: '<string>'
}
],
connectorId: '<string>',
entitySubType: 'metric',
parentPresetId: '<string>'
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig', 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.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig",
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([
'configOverrides' => [
[
'conditionType' => [
'matchEntityType' => [
],
'matchEntityTypeAndSubType' => [
'entitySubType' => '<string>'
]
],
'messageConfig' => [
'fields' => [
[
'fieldName' => 'title',
'template' => '{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}'
]
]
],
'payloadType' => '<string>'
]
],
'connectorId' => '<string>',
'entitySubType' => 'metric',
'parentPresetId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig"
payload := strings.NewReader("{\n \"configOverrides\": [\n {\n \"conditionType\": {\n \"matchEntityType\": {},\n \"matchEntityTypeAndSubType\": {\n \"entitySubType\": \"<string>\"\n }\n },\n \"messageConfig\": {\n \"fields\": [\n {\n \"fieldName\": \"title\",\n \"template\": \"{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}\"\n }\n ]\n },\n \"payloadType\": \"<string>\"\n }\n ],\n \"connectorId\": \"<string>\",\n \"entitySubType\": \"metric\",\n \"parentPresetId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configOverrides\": [\n {\n \"conditionType\": {\n \"matchEntityType\": {},\n \"matchEntityTypeAndSubType\": {\n \"entitySubType\": \"<string>\"\n }\n },\n \"messageConfig\": {\n \"fields\": [\n {\n \"fieldName\": \"title\",\n \"template\": \"{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}\"\n }\n ]\n },\n \"payloadType\": \"<string>\"\n }\n ],\n \"connectorId\": \"<string>\",\n \"entitySubType\": \"metric\",\n \"parentPresetId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/presets:testConfig")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configOverrides\": [\n {\n \"conditionType\": {\n \"matchEntityType\": {},\n \"matchEntityTypeAndSubType\": {\n \"entitySubType\": \"<string>\"\n }\n },\n \"messageConfig\": {\n \"fields\": [\n {\n \"fieldName\": \"title\",\n \"template\": \"{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}\"\n }\n ]\n },\n \"payloadType\": \"<string>\"\n }\n ],\n \"connectorId\": \"<string>\",\n \"entitySubType\": \"metric\",\n \"parentPresetId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"success": {
"metadata": {}
},
"failure": {
"message": "<string>",
"statusCode": 349
}
}
}Authorizations
API key authentication
Body
application/json
Request for testing a notification preset configuration.
The config overrides.
Maximum array length:
100Show child attributes
Show child attributes
The connector id.
Required string length:
1 - 128Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_-]*$Entity sub-type to use when testing the preset configuration.
Required string length:
1 - 100Pattern:
^[\s\S]*$Example:
"metric"
Entity type.
Available options:
ENTITY_TYPE_UNSPECIFIED, ALERTS, TEST_NOTIFICATIONS, CASES The parent preset id.
Required string length:
1 - 128Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_-]*$Response
200 - application/json
Response containing the results of a notification preset configuration test.
Result of a notification test, either a success or failure.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Was this page helpful?
⌘I