Test integration
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationData": {
"integrationKey": "<string>",
"integrationParameters": {
"parameters": [
{
"stringValue": "<string>",
"apiKey": {
"id": "<string>",
"value": "<string>"
},
"booleanValue": true,
"key": "<string>",
"numericValue": 123,
"sensitiveData": {},
"stringList": {
"values": [
"<string>"
]
}
}
]
},
"version": "<string>"
},
"integrationId": "<string>"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test"
payload = {
"integrationData": {
"integrationKey": "<string>",
"integrationParameters": { "parameters": [
{
"stringValue": "<string>",
"apiKey": {
"id": "<string>",
"value": "<string>"
},
"booleanValue": True,
"key": "<string>",
"numericValue": 123,
"sensitiveData": {},
"stringList": { "values": ["<string>"] }
}
] },
"version": "<string>"
},
"integrationId": "<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({
integrationData: {
integrationKey: '<string>',
integrationParameters: {
parameters: [
{
stringValue: '<string>',
apiKey: {id: '<string>', value: '<string>'},
booleanValue: true,
key: '<string>',
numericValue: 123,
sensitiveData: {},
stringList: {values: ['<string>']}
}
]
},
version: '<string>'
},
integrationId: '<string>'
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test', 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/integrations/metadata/v1/test",
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([
'integrationData' => [
'integrationKey' => '<string>',
'integrationParameters' => [
'parameters' => [
[
'stringValue' => '<string>',
'apiKey' => [
'id' => '<string>',
'value' => '<string>'
],
'booleanValue' => true,
'key' => '<string>',
'numericValue' => 123,
'sensitiveData' => [
],
'stringList' => [
'values' => [
'<string>'
]
]
]
]
],
'version' => '<string>'
],
'integrationId' => '<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/integrations/metadata/v1/test"
payload := strings.NewReader("{\n \"integrationData\": {\n \"integrationKey\": \"<string>\",\n \"integrationParameters\": {\n \"parameters\": [\n {\n \"stringValue\": \"<string>\",\n \"apiKey\": {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"booleanValue\": true,\n \"key\": \"<string>\",\n \"numericValue\": 123,\n \"sensitiveData\": {},\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n },\n \"version\": \"<string>\"\n },\n \"integrationId\": \"<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/integrations/metadata/v1/test")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integrationData\": {\n \"integrationKey\": \"<string>\",\n \"integrationParameters\": {\n \"parameters\": [\n {\n \"stringValue\": \"<string>\",\n \"apiKey\": {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"booleanValue\": true,\n \"key\": \"<string>\",\n \"numericValue\": 123,\n \"sensitiveData\": {},\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n },\n \"version\": \"<string>\"\n },\n \"integrationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test")
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 \"integrationData\": {\n \"integrationKey\": \"<string>\",\n \"integrationParameters\": {\n \"parameters\": [\n {\n \"stringValue\": \"<string>\",\n \"apiKey\": {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"booleanValue\": true,\n \"key\": \"<string>\",\n \"numericValue\": 123,\n \"sensitiveData\": {},\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n },\n \"version\": \"<string>\"\n },\n \"integrationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"success": {},
"failure": {
"errorMessage": "<string>"
}
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Integration Service
Test integration
Tests the integration configuration.
Requires the following permissions:
integrations:ReadConfig
Test integration
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationData": {
"integrationKey": "<string>",
"integrationParameters": {
"parameters": [
{
"stringValue": "<string>",
"apiKey": {
"id": "<string>",
"value": "<string>"
},
"booleanValue": true,
"key": "<string>",
"numericValue": 123,
"sensitiveData": {},
"stringList": {
"values": [
"<string>"
]
}
}
]
},
"version": "<string>"
},
"integrationId": "<string>"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test"
payload = {
"integrationData": {
"integrationKey": "<string>",
"integrationParameters": { "parameters": [
{
"stringValue": "<string>",
"apiKey": {
"id": "<string>",
"value": "<string>"
},
"booleanValue": True,
"key": "<string>",
"numericValue": 123,
"sensitiveData": {},
"stringList": { "values": ["<string>"] }
}
] },
"version": "<string>"
},
"integrationId": "<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({
integrationData: {
integrationKey: '<string>',
integrationParameters: {
parameters: [
{
stringValue: '<string>',
apiKey: {id: '<string>', value: '<string>'},
booleanValue: true,
key: '<string>',
numericValue: 123,
sensitiveData: {},
stringList: {values: ['<string>']}
}
]
},
version: '<string>'
},
integrationId: '<string>'
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test', 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/integrations/metadata/v1/test",
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([
'integrationData' => [
'integrationKey' => '<string>',
'integrationParameters' => [
'parameters' => [
[
'stringValue' => '<string>',
'apiKey' => [
'id' => '<string>',
'value' => '<string>'
],
'booleanValue' => true,
'key' => '<string>',
'numericValue' => 123,
'sensitiveData' => [
],
'stringList' => [
'values' => [
'<string>'
]
]
]
]
],
'version' => '<string>'
],
'integrationId' => '<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/integrations/metadata/v1/test"
payload := strings.NewReader("{\n \"integrationData\": {\n \"integrationKey\": \"<string>\",\n \"integrationParameters\": {\n \"parameters\": [\n {\n \"stringValue\": \"<string>\",\n \"apiKey\": {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"booleanValue\": true,\n \"key\": \"<string>\",\n \"numericValue\": 123,\n \"sensitiveData\": {},\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n },\n \"version\": \"<string>\"\n },\n \"integrationId\": \"<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/integrations/metadata/v1/test")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integrationData\": {\n \"integrationKey\": \"<string>\",\n \"integrationParameters\": {\n \"parameters\": [\n {\n \"stringValue\": \"<string>\",\n \"apiKey\": {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"booleanValue\": true,\n \"key\": \"<string>\",\n \"numericValue\": 123,\n \"sensitiveData\": {},\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n },\n \"version\": \"<string>\"\n },\n \"integrationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test")
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 \"integrationData\": {\n \"integrationKey\": \"<string>\",\n \"integrationParameters\": {\n \"parameters\": [\n {\n \"stringValue\": \"<string>\",\n \"apiKey\": {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"booleanValue\": true,\n \"key\": \"<string>\",\n \"numericValue\": 123,\n \"sensitiveData\": {},\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n },\n \"version\": \"<string>\"\n },\n \"integrationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"success": {},
"failure": {
"errorMessage": "<string>"
}
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Body
application/json
Response
Response containing the results of an integration test.
Test integration result.
- Test integration result
- Test integration result
- Test integration result
Show child attributes
Show child attributes
Was this page helpful?