Update Policy
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/3/dataplans/policies/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "policy_id",
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"description": "My Policy Description",
"enabled": true,
"name": "My Policy",
"subsystemRule": {
"name": "<string>"
}
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/3/dataplans/policies/v1"
payload = {
"id": "policy_id",
"applicationRule": { "name": "<string>" },
"archiveRetention": { "id": "<string>" },
"description": "My Policy Description",
"enabled": True,
"name": "My Policy",
"subsystemRule": { "name": "<string>" }
}
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({
id: 'policy_id',
applicationRule: {name: '<string>'},
archiveRetention: {id: '<string>'},
description: 'My Policy Description',
enabled: true,
name: 'My Policy',
subsystemRule: {name: '<string>'}
})
};
fetch('https://api.coralogix.com/mgmt/openapi/3/dataplans/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/3/dataplans/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([
'id' => 'policy_id',
'applicationRule' => [
'name' => '<string>'
],
'archiveRetention' => [
'id' => '<string>'
],
'description' => 'My Policy Description',
'enabled' => true,
'name' => 'My Policy',
'subsystemRule' => [
'name' => '<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/3/dataplans/policies/v1"
payload := strings.NewReader("{\n \"id\": \"policy_id\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"description\": \"My Policy Description\",\n \"enabled\": true,\n \"name\": \"My Policy\",\n \"subsystemRule\": {\n \"name\": \"<string>\"\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/3/dataplans/policies/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"policy_id\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"description\": \"My Policy Description\",\n \"enabled\": true,\n \"name\": \"My Policy\",\n \"subsystemRule\": {\n \"name\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/3/dataplans/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 \"id\": \"policy_id\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"description\": \"My Policy Description\",\n \"enabled\": true,\n \"name\": \"My Policy\",\n \"subsystemRule\": {\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"companyId": 1234,
"deleted": false,
"enabled": true,
"id": "policy_id",
"name": "My Policy",
"order": 1,
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"createdAt": "2021-01-01T00:00:00.000Z",
"description": "My Policy Description",
"logRules": {
"severities": []
},
"subsystemRule": {
"name": "<string>"
},
"updatedAt": "2021-01-01T00:00:00.000Z"
}
}Policies Service
Update Policy
No description available
Update Policy
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/3/dataplans/policies/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "policy_id",
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"description": "My Policy Description",
"enabled": true,
"name": "My Policy",
"subsystemRule": {
"name": "<string>"
}
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/3/dataplans/policies/v1"
payload = {
"id": "policy_id",
"applicationRule": { "name": "<string>" },
"archiveRetention": { "id": "<string>" },
"description": "My Policy Description",
"enabled": True,
"name": "My Policy",
"subsystemRule": { "name": "<string>" }
}
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({
id: 'policy_id',
applicationRule: {name: '<string>'},
archiveRetention: {id: '<string>'},
description: 'My Policy Description',
enabled: true,
name: 'My Policy',
subsystemRule: {name: '<string>'}
})
};
fetch('https://api.coralogix.com/mgmt/openapi/3/dataplans/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/3/dataplans/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([
'id' => 'policy_id',
'applicationRule' => [
'name' => '<string>'
],
'archiveRetention' => [
'id' => '<string>'
],
'description' => 'My Policy Description',
'enabled' => true,
'name' => 'My Policy',
'subsystemRule' => [
'name' => '<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/3/dataplans/policies/v1"
payload := strings.NewReader("{\n \"id\": \"policy_id\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"description\": \"My Policy Description\",\n \"enabled\": true,\n \"name\": \"My Policy\",\n \"subsystemRule\": {\n \"name\": \"<string>\"\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/3/dataplans/policies/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"policy_id\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"description\": \"My Policy Description\",\n \"enabled\": true,\n \"name\": \"My Policy\",\n \"subsystemRule\": {\n \"name\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/3/dataplans/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 \"id\": \"policy_id\",\n \"applicationRule\": {\n \"name\": \"<string>\"\n },\n \"archiveRetention\": {\n \"id\": \"<string>\"\n },\n \"description\": \"My Policy Description\",\n \"enabled\": true,\n \"name\": \"My Policy\",\n \"subsystemRule\": {\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"companyId": 1234,
"deleted": false,
"enabled": true,
"id": "policy_id",
"name": "My Policy",
"order": 1,
"applicationRule": {
"name": "<string>"
},
"archiveRetention": {
"id": "<string>"
},
"createdAt": "2021-01-01T00:00:00.000Z",
"description": "My Policy Description",
"logRules": {
"severities": []
},
"subsystemRule": {
"name": "<string>"
},
"updatedAt": "2021-01-01T00:00:00.000Z"
}
}Authorizations
API key authentication
Body
application/json
- Update Policy Request
- Update Policy Request
This data structue is used to update an existing policy.
Example:
"policy_id"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"My Policy Description"
Example:
true
Log rules for a policy.
Show child attributes
Show child attributes
Example:
"My Policy"
Available options:
PRIORITY_TYPE_UNSPECIFIED, PRIORITY_TYPE_BLOCK, PRIORITY_TYPE_LOW, PRIORITY_TYPE_MEDIUM, PRIORITY_TYPE_HIGH Show child attributes
Show child attributes
Response
This data structue is obtained when updating a policy.
A policy is a set of rules that define the behavior of the Coralogix system for a specific company.
- Policy
- Policy
Show child attributes
Show child attributes
Was this page helpful?
⌘I