Create Action
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"applicationNames": [
"<string>"
],
"description": "<string>",
"dpxlFilter": "<string>",
"isPrivate": true,
"name": "<string>",
"subsystemNames": [
"<string>"
],
"url": "<string>",
"urlFields": [
{
"name": "<string>",
"required": true
}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2"
payload = {
"applicationNames": ["<string>"],
"description": "<string>",
"dpxlFilter": "<string>",
"isPrivate": True,
"name": "<string>",
"subsystemNames": ["<string>"],
"url": "<string>",
"urlFields": [
{
"name": "<string>",
"required": True
}
]
}
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({
applicationNames: ['<string>'],
description: '<string>',
dpxlFilter: '<string>',
isPrivate: true,
name: '<string>',
subsystemNames: ['<string>'],
url: '<string>',
urlFields: [{name: '<string>', required: true}]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2', 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/actions/actions/v2",
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([
'applicationNames' => [
'<string>'
],
'description' => '<string>',
'dpxlFilter' => '<string>',
'isPrivate' => true,
'name' => '<string>',
'subsystemNames' => [
'<string>'
],
'url' => '<string>',
'urlFields' => [
[
'name' => '<string>',
'required' => true
]
]
]),
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/actions/actions/v2"
payload := strings.NewReader("{\n \"applicationNames\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"dpxlFilter\": \"<string>\",\n \"isPrivate\": true,\n \"name\": \"<string>\",\n \"subsystemNames\": [\n \"<string>\"\n ],\n \"url\": \"<string>\",\n \"urlFields\": [\n {\n \"name\": \"<string>\",\n \"required\": true\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/actions/actions/v2")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"applicationNames\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"dpxlFilter\": \"<string>\",\n \"isPrivate\": true,\n \"name\": \"<string>\",\n \"subsystemNames\": [\n \"<string>\"\n ],\n \"url\": \"<string>\",\n \"urlFields\": [\n {\n \"name\": \"<string>\",\n \"required\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2")
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 \"applicationNames\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"dpxlFilter\": \"<string>\",\n \"isPrivate\": true,\n \"name\": \"<string>\",\n \"subsystemNames\": [\n \"<string>\"\n ],\n \"url\": \"<string>\",\n \"urlFields\": [\n {\n \"name\": \"<string>\",\n \"required\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"action": {
"applicationNames": [
"<string>"
],
"createdBy": "<string>",
"description": "<string>",
"dpxlFilter": "<string>",
"id": "<string>",
"isHidden": true,
"isPrivate": true,
"name": "<string>",
"subsystemNames": [
"<string>"
],
"url": "<string>",
"urlFields": [
{
"name": "<string>",
"required": true
}
]
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Actions Service
Create Action
Creates a new action.
Create Action
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"applicationNames": [
"<string>"
],
"description": "<string>",
"dpxlFilter": "<string>",
"isPrivate": true,
"name": "<string>",
"subsystemNames": [
"<string>"
],
"url": "<string>",
"urlFields": [
{
"name": "<string>",
"required": true
}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2"
payload = {
"applicationNames": ["<string>"],
"description": "<string>",
"dpxlFilter": "<string>",
"isPrivate": True,
"name": "<string>",
"subsystemNames": ["<string>"],
"url": "<string>",
"urlFields": [
{
"name": "<string>",
"required": True
}
]
}
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({
applicationNames: ['<string>'],
description: '<string>',
dpxlFilter: '<string>',
isPrivate: true,
name: '<string>',
subsystemNames: ['<string>'],
url: '<string>',
urlFields: [{name: '<string>', required: true}]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2', 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/actions/actions/v2",
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([
'applicationNames' => [
'<string>'
],
'description' => '<string>',
'dpxlFilter' => '<string>',
'isPrivate' => true,
'name' => '<string>',
'subsystemNames' => [
'<string>'
],
'url' => '<string>',
'urlFields' => [
[
'name' => '<string>',
'required' => true
]
]
]),
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/actions/actions/v2"
payload := strings.NewReader("{\n \"applicationNames\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"dpxlFilter\": \"<string>\",\n \"isPrivate\": true,\n \"name\": \"<string>\",\n \"subsystemNames\": [\n \"<string>\"\n ],\n \"url\": \"<string>\",\n \"urlFields\": [\n {\n \"name\": \"<string>\",\n \"required\": true\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/actions/actions/v2")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"applicationNames\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"dpxlFilter\": \"<string>\",\n \"isPrivate\": true,\n \"name\": \"<string>\",\n \"subsystemNames\": [\n \"<string>\"\n ],\n \"url\": \"<string>\",\n \"urlFields\": [\n {\n \"name\": \"<string>\",\n \"required\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/actions/actions/v2")
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 \"applicationNames\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"dpxlFilter\": \"<string>\",\n \"isPrivate\": true,\n \"name\": \"<string>\",\n \"subsystemNames\": [\n \"<string>\"\n ],\n \"url\": \"<string>\",\n \"urlFields\": [\n {\n \"name\": \"<string>\",\n \"required\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"action": {
"applicationNames": [
"<string>"
],
"createdBy": "<string>",
"description": "<string>",
"dpxlFilter": "<string>",
"id": "<string>",
"isHidden": true,
"isPrivate": true,
"name": "<string>",
"subsystemNames": [
"<string>"
],
"url": "<string>",
"urlFields": [
{
"name": "<string>",
"required": true
}
]
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Body
application/json
This data structure represents the request to create an Action.
The application names.
Maximum array length:
1000The application names.
Maximum string length:
1024Pattern:
^[\s\S]*$Human-readable description.
Maximum string length:
65535Pattern:
^[\s\S]*$The dpxl filter.
Maximum string length:
65535Pattern:
^[\s\S]*$The is private.
Display name.
Required string length:
1 - 50Pattern:
^[\s\S]*$Source type.
Available options:
SOURCE_TYPE_UNSPECIFIED, SOURCE_TYPE_LOG, SOURCE_TYPE_DATA_MAP The subsystem names.
Maximum array length:
1000The subsystem names.
Maximum string length:
1024Pattern:
^[\s\S]*$URL. Must start with http:// or https://.
Required string length:
1 - 32768Pattern:
^https?://.*$The url fields. Each field requires both name and required, and names must be unique within the list.
Maximum array length:
1000Show child attributes
Show child attributes
Response
This data structure represents the response to create an Action.
This data structure represents an Action.
Show child attributes
Show child attributes
Was this page helpful?
⌘I