Test Connector Config
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors:testConfig \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": [
{
"fieldName": "<string>",
"value": "<string>"
}
],
"payloadType": "default"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors:testConfig"
payload = {
"fields": [
{
"fieldName": "<string>",
"value": "<string>"
}
],
"payloadType": "default"
}
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({fields: [{fieldName: '<string>', value: '<string>'}], payloadType: 'default'})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors: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/connectors: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([
'fields' => [
[
'fieldName' => '<string>',
'value' => '<string>'
]
],
'payloadType' => 'default'
]),
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/connectors:testConfig"
payload := strings.NewReader("{\n \"fields\": [\n {\n \"fieldName\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"payloadType\": \"default\"\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/connectors:testConfig")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": [\n {\n \"fieldName\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"payloadType\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors: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 \"fields\": [\n {\n \"fieldName\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"payloadType\": \"default\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"success": {
"metadata": {}
},
"failure": {
"message": "<string>",
"statusCode": 349
}
}
}Notifications Testing Service
Test Connector Config
Tests a notification connector configuration.
Test Connector Config
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors:testConfig \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": [
{
"fieldName": "<string>",
"value": "<string>"
}
],
"payloadType": "default"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors:testConfig"
payload = {
"fields": [
{
"fieldName": "<string>",
"value": "<string>"
}
],
"payloadType": "default"
}
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({fields: [{fieldName: '<string>', value: '<string>'}], payloadType: 'default'})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors: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/connectors: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([
'fields' => [
[
'fieldName' => '<string>',
'value' => '<string>'
]
],
'payloadType' => 'default'
]),
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/connectors:testConfig"
payload := strings.NewReader("{\n \"fields\": [\n {\n \"fieldName\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"payloadType\": \"default\"\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/connectors:testConfig")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": [\n {\n \"fieldName\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"payloadType\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors: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 \"fields\": [\n {\n \"fieldName\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"payloadType\": \"default\"\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 to test a connector configuration
Entity type.
Available options:
ENTITY_TYPE_UNSPECIFIED, ALERTS, TEST_NOTIFICATIONS, CASES Fields.
Maximum array length:
100Show child attributes
Show child attributes
Payload type to use when testing the connector.
Required string length:
1 - 100Pattern:
^[\s\S]*$Example:
"default"
Connector type.
Available options:
CONNECTOR_TYPE_UNSPECIFIED, SLACK, GENERIC_HTTPS, PAGERDUTY, IBM_EVENT_NOTIFICATIONS, SERVICE_NOW, EMAIL, PAGERDUTY_INCIDENTS, MICROSOFT_TEAMS Response
200 - application/json
Response containing the results of a connector 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