Add Enrichments
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"requestEnrichments": [
{
"enrichmentType": {
"geoIp": {
"withAsn": true
},
"aws": {
"resourceType": "ec2"
},
"customEnrichment": {
"id": 1
},
"suspiciousIp": {}
},
"fieldName": "sourceIPs",
"enrichedFieldName": "<string>",
"selectedColumns": [
"<string>"
],
"targets": [
{
"dataset": "dataset1"
}
]
}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1"
payload = { "requestEnrichments": [
{
"enrichmentType": {
"geoIp": { "withAsn": True },
"aws": { "resourceType": "ec2" },
"customEnrichment": { "id": 1 },
"suspiciousIp": {}
},
"fieldName": "sourceIPs",
"enrichedFieldName": "<string>",
"selectedColumns": ["<string>"],
"targets": [{ "dataset": "dataset1" }]
}
] }
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({
requestEnrichments: [
{
enrichmentType: {
geoIp: {withAsn: true},
aws: {resourceType: 'ec2'},
customEnrichment: {id: 1},
suspiciousIp: {}
},
fieldName: 'sourceIPs',
enrichedFieldName: '<string>',
selectedColumns: ['<string>'],
targets: [{dataset: 'dataset1'}]
}
]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1', 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/enrichment-rules/enrichment-rules/v1",
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([
'requestEnrichments' => [
[
'enrichmentType' => [
'geoIp' => [
'withAsn' => true
],
'aws' => [
'resourceType' => 'ec2'
],
'customEnrichment' => [
'id' => 1
],
'suspiciousIp' => [
]
],
'fieldName' => 'sourceIPs',
'enrichedFieldName' => '<string>',
'selectedColumns' => [
'<string>'
],
'targets' => [
[
'dataset' => 'dataset1'
]
]
]
]
]),
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/enrichment-rules/enrichment-rules/v1"
payload := strings.NewReader("{\n \"requestEnrichments\": [\n {\n \"enrichmentType\": {\n \"geoIp\": {\n \"withAsn\": true\n },\n \"aws\": {\n \"resourceType\": \"ec2\"\n },\n \"customEnrichment\": {\n \"id\": 1\n },\n \"suspiciousIp\": {}\n },\n \"fieldName\": \"sourceIPs\",\n \"enrichedFieldName\": \"<string>\",\n \"selectedColumns\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"dataset\": \"dataset1\"\n }\n ]\n }\n ]\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/enrichment-rules/enrichment-rules/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"requestEnrichments\": [\n {\n \"enrichmentType\": {\n \"geoIp\": {\n \"withAsn\": true\n },\n \"aws\": {\n \"resourceType\": \"ec2\"\n },\n \"customEnrichment\": {\n \"id\": 1\n },\n \"suspiciousIp\": {}\n },\n \"fieldName\": \"sourceIPs\",\n \"enrichedFieldName\": \"<string>\",\n \"selectedColumns\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"dataset\": \"dataset1\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1")
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 \"requestEnrichments\": [\n {\n \"enrichmentType\": {\n \"geoIp\": {\n \"withAsn\": true\n },\n \"aws\": {\n \"resourceType\": \"ec2\"\n },\n \"customEnrichment\": {\n \"id\": 1\n },\n \"suspiciousIp\": {}\n },\n \"fieldName\": \"sourceIPs\",\n \"enrichedFieldName\": \"<string>\",\n \"selectedColumns\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"dataset\": \"dataset1\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"enrichments": [
{
"enrichmentType": {
"geoIp": {
"withAsn": true
},
"aws": {
"resourceType": "ec2"
},
"customEnrichment": {
"id": 1
},
"suspiciousIp": {}
},
"fieldName": "1",
"id": 1,
"enrichedFieldName": "1",
"selectedColumns": [
"city",
"population"
],
"targets": [
{
"dataset": "dataset1"
}
]
}
]
}Enrichments Service
Add Enrichments
Creates new enrichment rules.
Add Enrichments
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"requestEnrichments": [
{
"enrichmentType": {
"geoIp": {
"withAsn": true
},
"aws": {
"resourceType": "ec2"
},
"customEnrichment": {
"id": 1
},
"suspiciousIp": {}
},
"fieldName": "sourceIPs",
"enrichedFieldName": "<string>",
"selectedColumns": [
"<string>"
],
"targets": [
{
"dataset": "dataset1"
}
]
}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1"
payload = { "requestEnrichments": [
{
"enrichmentType": {
"geoIp": { "withAsn": True },
"aws": { "resourceType": "ec2" },
"customEnrichment": { "id": 1 },
"suspiciousIp": {}
},
"fieldName": "sourceIPs",
"enrichedFieldName": "<string>",
"selectedColumns": ["<string>"],
"targets": [{ "dataset": "dataset1" }]
}
] }
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({
requestEnrichments: [
{
enrichmentType: {
geoIp: {withAsn: true},
aws: {resourceType: 'ec2'},
customEnrichment: {id: 1},
suspiciousIp: {}
},
fieldName: 'sourceIPs',
enrichedFieldName: '<string>',
selectedColumns: ['<string>'],
targets: [{dataset: 'dataset1'}]
}
]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1', 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/enrichment-rules/enrichment-rules/v1",
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([
'requestEnrichments' => [
[
'enrichmentType' => [
'geoIp' => [
'withAsn' => true
],
'aws' => [
'resourceType' => 'ec2'
],
'customEnrichment' => [
'id' => 1
],
'suspiciousIp' => [
]
],
'fieldName' => 'sourceIPs',
'enrichedFieldName' => '<string>',
'selectedColumns' => [
'<string>'
],
'targets' => [
[
'dataset' => 'dataset1'
]
]
]
]
]),
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/enrichment-rules/enrichment-rules/v1"
payload := strings.NewReader("{\n \"requestEnrichments\": [\n {\n \"enrichmentType\": {\n \"geoIp\": {\n \"withAsn\": true\n },\n \"aws\": {\n \"resourceType\": \"ec2\"\n },\n \"customEnrichment\": {\n \"id\": 1\n },\n \"suspiciousIp\": {}\n },\n \"fieldName\": \"sourceIPs\",\n \"enrichedFieldName\": \"<string>\",\n \"selectedColumns\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"dataset\": \"dataset1\"\n }\n ]\n }\n ]\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/enrichment-rules/enrichment-rules/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"requestEnrichments\": [\n {\n \"enrichmentType\": {\n \"geoIp\": {\n \"withAsn\": true\n },\n \"aws\": {\n \"resourceType\": \"ec2\"\n },\n \"customEnrichment\": {\n \"id\": 1\n },\n \"suspiciousIp\": {}\n },\n \"fieldName\": \"sourceIPs\",\n \"enrichedFieldName\": \"<string>\",\n \"selectedColumns\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"dataset\": \"dataset1\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/enrichment-rules/enrichment-rules/v1")
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 \"requestEnrichments\": [\n {\n \"enrichmentType\": {\n \"geoIp\": {\n \"withAsn\": true\n },\n \"aws\": {\n \"resourceType\": \"ec2\"\n },\n \"customEnrichment\": {\n \"id\": 1\n },\n \"suspiciousIp\": {}\n },\n \"fieldName\": \"sourceIPs\",\n \"enrichedFieldName\": \"<string>\",\n \"selectedColumns\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"dataset\": \"dataset1\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"enrichments": [
{
"enrichmentType": {
"geoIp": {
"withAsn": true
},
"aws": {
"resourceType": "ec2"
},
"customEnrichment": {
"id": 1
},
"suspiciousIp": {}
},
"fieldName": "1",
"id": 1,
"enrichedFieldName": "1",
"selectedColumns": [
"city",
"population"
],
"targets": [
{
"dataset": "dataset1"
}
]
}
]
}Authorizations
API key authentication
Body
application/json
This response data structure represents a collection of enrichments
The request enrichments.
Show child attributes
Show child attributes
Response
200 - application/json
Response data structure for enrichments creation
List of enrichments.
Show child attributes
Show child attributes
Was this page helpful?
⌘I