Atomic Overwrite Span Policies
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"policies": [
{
"policy": {
"description": "My Policy Description",
"name": "My Policy",
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"disabled": true,
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
},
"subsystemRule": {
"name": "<string>"
},
"targets": [
{
"archiveRetention": {
"id": "<string>"
},
"dataset": "dataset1",
"dataspace": "dataspace1",
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
}
}
]
},
"spanRules": {
"actionRule": {
"name": "<string>"
},
"dpxlExpression": "<string>",
"serviceRule": {
"name": "<string>"
},
"tagRules": [
{
"tagName": "tag_name",
"tagValue": "tag_value"
}
]
}
}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1"
payload = { "policies": [
{
"policy": {
"description": "My Policy Description",
"name": "My Policy",
"applicationRule": { "name": "<string>" },
"archiveRetention": { "id": "<string>" },
"disabled": True,
"priorityOverride": { "quotaBased": { "usageTiers": [{ "dailyQuotaPercentage": 80 }] } },
"subsystemRule": { "name": "<string>" },
"targets": [
{
"archiveRetention": { "id": "<string>" },
"dataset": "dataset1",
"dataspace": "dataspace1",
"priorityOverride": { "quotaBased": { "usageTiers": [{ "dailyQuotaPercentage": 80 }] } }
}
]
},
"spanRules": {
"actionRule": { "name": "<string>" },
"dpxlExpression": "<string>",
"serviceRule": { "name": "<string>" },
"tagRules": [
{
"tagName": "tag_name",
"tagValue": "tag_value"
}
]
}
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
policies: [
{
policy: {
description: 'My Policy Description',
name: 'My Policy',
applicationRule: {name: '<string>'},
archiveRetention: {id: '<string>'},
disabled: true,
priorityOverride: {quotaBased: {usageTiers: [{dailyQuotaPercentage: 80}]}},
subsystemRule: {name: '<string>'},
targets: [
{
archiveRetention: {id: '<string>'},
dataset: 'dataset1',
dataspace: 'dataspace1',
priorityOverride: {quotaBased: {usageTiers: [{dailyQuotaPercentage: 80}]}}
}
]
},
spanRules: {
actionRule: {name: '<string>'},
dpxlExpression: '<string>',
serviceRule: {name: '<string>'},
tagRules: [{tagName: 'tag_name', tagValue: 'tag_value'}]
}
}
]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/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/dataplans/span-policies/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'policies' => [
[
'policy' => [
'description' => 'My Policy Description',
'name' => 'My Policy',
'applicationRule' => [
'name' => '<string>'
],
'archiveRetention' => [
'id' => '<string>'
],
'disabled' => true,
'priorityOverride' => [
'quotaBased' => [
'usageTiers' => [
[
'dailyQuotaPercentage' => 80
]
]
]
],
'subsystemRule' => [
'name' => '<string>'
],
'targets' => [
[
'archiveRetention' => [
'id' => '<string>'
],
'dataset' => 'dataset1',
'dataspace' => 'dataspace1',
'priorityOverride' => [
'quotaBased' => [
'usageTiers' => [
[
'dailyQuotaPercentage' => 80
]
]
]
]
]
]
],
'spanRules' => [
'actionRule' => [
'name' => '<string>'
],
'dpxlExpression' => '<string>',
'serviceRule' => [
'name' => '<string>'
],
'tagRules' => [
[
'tagName' => 'tag_name',
'tagValue' => 'tag_value'
]
]
]
]
]
]),
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/dataplans/span-policies/v1"
payload := strings.NewReader("{\n \"policies\": [\n {\n \"policy\": {\n \"description\": \"My Policy Description\",\n \"name\": \"My Policy\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"disabled\": true,\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n },\n \"subsystemRule\": {\n \"name\": \"<string>\"\n },\n \"targets\": [\n {\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"dataset\": \"dataset1\",\n \"dataspace\": \"dataspace1\",\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n }\n }\n ]\n },\n \"spanRules\": {\n \"actionRule\": {\n \"name\": \"<string>\"\n },\n \"dpxlExpression\": \"<string>\",\n \"serviceRule\": {\n \"name\": \"<string>\"\n },\n \"tagRules\": [\n {\n \"tagName\": \"tag_name\",\n \"tagValue\": \"tag_value\"\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"policies\": [\n {\n \"policy\": {\n \"description\": \"My Policy Description\",\n \"name\": \"My Policy\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"disabled\": true,\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n },\n \"subsystemRule\": {\n \"name\": \"<string>\"\n },\n \"targets\": [\n {\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"dataset\": \"dataset1\",\n \"dataspace\": \"dataspace1\",\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n }\n }\n ]\n },\n \"spanRules\": {\n \"actionRule\": {\n \"name\": \"<string>\"\n },\n \"dpxlExpression\": \"<string>\",\n \"serviceRule\": {\n \"name\": \"<string>\"\n },\n \"tagRules\": [\n {\n \"tagName\": \"tag_name\",\n \"tagValue\": \"tag_value\"\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"policies\": [\n {\n \"policy\": {\n \"description\": \"My Policy Description\",\n \"name\": \"My Policy\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"disabled\": true,\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n },\n \"subsystemRule\": {\n \"name\": \"<string>\"\n },\n \"targets\": [\n {\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"dataset\": \"dataset1\",\n \"dataspace\": \"dataspace1\",\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n }\n }\n ]\n },\n \"spanRules\": {\n \"actionRule\": {\n \"name\": \"<string>\"\n },\n \"dpxlExpression\": \"<string>\",\n \"serviceRule\": {\n \"name\": \"<string>\"\n },\n \"tagRules\": [\n {\n \"tagName\": \"tag_name\",\n \"tagValue\": \"tag_value\"\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"createResponses": [
{
"policy": {
"companyId": 1234,
"deleted": false,
"enabled": true,
"id": "policy_id",
"logRules": {
"severities": [],
"dpxlExpression": "<string>"
},
"name": "My Policy",
"order": 1,
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"createdAt": "2021-01-01T00:00:00.000Z",
"description": "My Policy Description",
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
},
"priorityOverrideStatus": {
"quotaBased": {
"currentUsage": 123,
"dailyLimit": 123
}
},
"rumRules": {
"severities": [],
"dpxlExpression": "<string>"
},
"spanRules": {
"actionRule": {
"name": "<string>"
},
"dpxlExpression": "<string>",
"serviceRule": {
"name": "<string>"
},
"tagRules": [
{
"tagName": "tag_name",
"tagValue": "tag_value"
}
]
},
"subsystemRule": {
"name": "<string>"
},
"targets": [
{
"archiveRetention": {
"id": "<string>"
},
"dataset": "dataset1",
"dataspace": "dataspace1",
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
}
}
],
"updatedAt": "2021-01-01T00:00:00.000Z"
}
}
]
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Policies Service
Atomic Overwrite Span Policies
Updates span data retention policies.
Atomic Overwrite Span Policies
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"policies": [
{
"policy": {
"description": "My Policy Description",
"name": "My Policy",
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"disabled": true,
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
},
"subsystemRule": {
"name": "<string>"
},
"targets": [
{
"archiveRetention": {
"id": "<string>"
},
"dataset": "dataset1",
"dataspace": "dataspace1",
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
}
}
]
},
"spanRules": {
"actionRule": {
"name": "<string>"
},
"dpxlExpression": "<string>",
"serviceRule": {
"name": "<string>"
},
"tagRules": [
{
"tagName": "tag_name",
"tagValue": "tag_value"
}
]
}
}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1"
payload = { "policies": [
{
"policy": {
"description": "My Policy Description",
"name": "My Policy",
"applicationRule": { "name": "<string>" },
"archiveRetention": { "id": "<string>" },
"disabled": True,
"priorityOverride": { "quotaBased": { "usageTiers": [{ "dailyQuotaPercentage": 80 }] } },
"subsystemRule": { "name": "<string>" },
"targets": [
{
"archiveRetention": { "id": "<string>" },
"dataset": "dataset1",
"dataspace": "dataspace1",
"priorityOverride": { "quotaBased": { "usageTiers": [{ "dailyQuotaPercentage": 80 }] } }
}
]
},
"spanRules": {
"actionRule": { "name": "<string>" },
"dpxlExpression": "<string>",
"serviceRule": { "name": "<string>" },
"tagRules": [
{
"tagName": "tag_name",
"tagValue": "tag_value"
}
]
}
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
policies: [
{
policy: {
description: 'My Policy Description',
name: 'My Policy',
applicationRule: {name: '<string>'},
archiveRetention: {id: '<string>'},
disabled: true,
priorityOverride: {quotaBased: {usageTiers: [{dailyQuotaPercentage: 80}]}},
subsystemRule: {name: '<string>'},
targets: [
{
archiveRetention: {id: '<string>'},
dataset: 'dataset1',
dataspace: 'dataspace1',
priorityOverride: {quotaBased: {usageTiers: [{dailyQuotaPercentage: 80}]}}
}
]
},
spanRules: {
actionRule: {name: '<string>'},
dpxlExpression: '<string>',
serviceRule: {name: '<string>'},
tagRules: [{tagName: 'tag_name', tagValue: 'tag_value'}]
}
}
]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/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/dataplans/span-policies/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'policies' => [
[
'policy' => [
'description' => 'My Policy Description',
'name' => 'My Policy',
'applicationRule' => [
'name' => '<string>'
],
'archiveRetention' => [
'id' => '<string>'
],
'disabled' => true,
'priorityOverride' => [
'quotaBased' => [
'usageTiers' => [
[
'dailyQuotaPercentage' => 80
]
]
]
],
'subsystemRule' => [
'name' => '<string>'
],
'targets' => [
[
'archiveRetention' => [
'id' => '<string>'
],
'dataset' => 'dataset1',
'dataspace' => 'dataspace1',
'priorityOverride' => [
'quotaBased' => [
'usageTiers' => [
[
'dailyQuotaPercentage' => 80
]
]
]
]
]
]
],
'spanRules' => [
'actionRule' => [
'name' => '<string>'
],
'dpxlExpression' => '<string>',
'serviceRule' => [
'name' => '<string>'
],
'tagRules' => [
[
'tagName' => 'tag_name',
'tagValue' => 'tag_value'
]
]
]
]
]
]),
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/dataplans/span-policies/v1"
payload := strings.NewReader("{\n \"policies\": [\n {\n \"policy\": {\n \"description\": \"My Policy Description\",\n \"name\": \"My Policy\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"disabled\": true,\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n },\n \"subsystemRule\": {\n \"name\": \"<string>\"\n },\n \"targets\": [\n {\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"dataset\": \"dataset1\",\n \"dataspace\": \"dataspace1\",\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n }\n }\n ]\n },\n \"spanRules\": {\n \"actionRule\": {\n \"name\": \"<string>\"\n },\n \"dpxlExpression\": \"<string>\",\n \"serviceRule\": {\n \"name\": \"<string>\"\n },\n \"tagRules\": [\n {\n \"tagName\": \"tag_name\",\n \"tagValue\": \"tag_value\"\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"policies\": [\n {\n \"policy\": {\n \"description\": \"My Policy Description\",\n \"name\": \"My Policy\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"disabled\": true,\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n },\n \"subsystemRule\": {\n \"name\": \"<string>\"\n },\n \"targets\": [\n {\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"dataset\": \"dataset1\",\n \"dataspace\": \"dataspace1\",\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n }\n }\n ]\n },\n \"spanRules\": {\n \"actionRule\": {\n \"name\": \"<string>\"\n },\n \"dpxlExpression\": \"<string>\",\n \"serviceRule\": {\n \"name\": \"<string>\"\n },\n \"tagRules\": [\n {\n \"tagName\": \"tag_name\",\n \"tagValue\": \"tag_value\"\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"policies\": [\n {\n \"policy\": {\n \"description\": \"My Policy Description\",\n \"name\": \"My Policy\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"disabled\": true,\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n },\n \"subsystemRule\": {\n \"name\": \"<string>\"\n },\n \"targets\": [\n {\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"dataset\": \"dataset1\",\n \"dataspace\": \"dataspace1\",\n \"priorityOverride\": {\n \"quotaBased\": {\n \"usageTiers\": [\n {\n \"dailyQuotaPercentage\": 80\n }\n ]\n }\n }\n }\n ]\n },\n \"spanRules\": {\n \"actionRule\": {\n \"name\": \"<string>\"\n },\n \"dpxlExpression\": \"<string>\",\n \"serviceRule\": {\n \"name\": \"<string>\"\n },\n \"tagRules\": [\n {\n \"tagName\": \"tag_name\",\n \"tagValue\": \"tag_value\"\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"createResponses": [
{
"policy": {
"companyId": 1234,
"deleted": false,
"enabled": true,
"id": "policy_id",
"logRules": {
"severities": [],
"dpxlExpression": "<string>"
},
"name": "My Policy",
"order": 1,
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"createdAt": "2021-01-01T00:00:00.000Z",
"description": "My Policy Description",
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
},
"priorityOverrideStatus": {
"quotaBased": {
"currentUsage": 123,
"dailyLimit": 123
}
},
"rumRules": {
"severities": [],
"dpxlExpression": "<string>"
},
"spanRules": {
"actionRule": {
"name": "<string>"
},
"dpxlExpression": "<string>",
"serviceRule": {
"name": "<string>"
},
"tagRules": [
{
"tagName": "tag_name",
"tagValue": "tag_value"
}
]
},
"subsystemRule": {
"name": "<string>"
},
"targets": [
{
"archiveRetention": {
"id": "<string>"
},
"dataset": "dataset1",
"dataspace": "dataspace1",
"priorityOverride": {
"quotaBased": {
"usageTiers": [
{
"dailyQuotaPercentage": 80
}
]
}
}
}
],
"updatedAt": "2021-01-01T00:00:00.000Z"
}
}
]
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Body
application/json
In an atomic operation delete all existing span policies and create the provided list by order.
List of span policies to create as part of the atomic overwrite.
Show child attributes
Show child attributes
Response
This data structue is obtained when overwriting span policies atomically.
The create responses.
Show child attributes
Show child attributes
Was this page helpful?
⌘I