Update Policy - Coralogix Developer Docs

Update Policy

curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
  "logRules": {
    "severities": [],
    "dpxlExpression": "<string>"
  },
  "applicationRule": {
    "name": "<string>"
  },
  "archiveRetention": {
    "id": "<string>"
  },
  "description": "My Policy Description",
  "enabled": true,
  "name": "My Policy",
  "priorityOverride": {
    "quotaBased": {
      "usageTiers": [
        {
          "daily_quota_percentage": 80,
          "priority": "PRIORITY_TYPE_HIGH"
        }
      ]
    }
  },
  "spanRules": {
    "actionRule": {
      "name": "<string>"
    },
    "dpxlExpression": "<string>",
    "serviceRule": {
      "name": "<string>"
    },
    "tagRules": [
      {
        "ruleTypeId": "rule_type_id",
        "tagName": "tags.environment",
        "tagValue": "tag_value"
      }
    ]
  },
  "subsystemRule": {
    "name": "<string>"
  },
  "targets": [
    {
      "archiveRetention": {
        "id": "<string>"
      },
      "dataset": "dataset1",
      "dataspace": "dataspace1",
      "priority": "PRIORITY_TYPE_MEDIUM",
      "priorityOverride": {
        "quotaBased": {
          "usageTiers": [
            {
              "daily_quota_percentage": 80,
              "priority": "PRIORITY_TYPE_HIGH"
            }
          ]
        }
      }
    }
  ]
}
'

import requests

url = "https://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1"

payload = {
    "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
    "logRules": {
        "severities": [],
        "dpxlExpression": "<string>"
    },
    "applicationRule": { "name": "<string>" },
    "archiveRetention": { "id": "<string>" },
    "description": "My Policy Description",
    "enabled": True,
    "name": "My Policy",
    "priorityOverride": { "quotaBased": { "usageTiers": [
                {
                    "daily_quota_percentage": 80,
                    "priority": "PRIORITY_TYPE_HIGH"
                }
            ] } },
    "spanRules": {
        "actionRule": { "name": "<string>" },
        "dpxlExpression": "<string>",
        "serviceRule": { "name": "<string>" },
        "tagRules": [
            {
                "ruleTypeId": "rule_type_id",
                "tagName": "tags.environment",
                "tagValue": "tag_value"
            }
        ]
    },
    "subsystemRule": { "name": "<string>" },
    "targets": [
        {
            "archiveRetention": { "id": "<string>" },
            "dataset": "dataset1",
            "dataspace": "dataspace1",
            "priority": "PRIORITY_TYPE_MEDIUM",
            "priorityOverride": { "quotaBased": { "usageTiers": [
                        {
                            "daily_quota_percentage": 80,
                            "priority": "PRIORITY_TYPE_HIGH"
                        }
                    ] } }
        }
    ]
}
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: '3dc02998-0b50-4ea8-b68a-4779d716fa1f',
    logRules: {severities: [], dpxlExpression: '<string>'},
    applicationRule: {name: '<string>'},
    archiveRetention: {id: '<string>'},
    description: 'My Policy Description',
    enabled: true,
    name: 'My Policy',
    priorityOverride: {
      quotaBased: {usageTiers: [{daily_quota_percentage: 80, priority: 'PRIORITY_TYPE_HIGH'}]}
    },
    spanRules: {
      actionRule: {name: '<string>'},
      dpxlExpression: '<string>',
      serviceRule: {name: '<string>'},
      tagRules: [
        {ruleTypeId: 'rule_type_id', tagName: 'tags.environment', tagValue: 'tag_value'}
      ]
    },
    subsystemRule: {name: '<string>'},
    targets: [
      {
        archiveRetention: {id: '<string>'},
        dataset: 'dataset1',
        dataspace: 'dataspace1',
        priority: 'PRIORITY_TYPE_MEDIUM',
        priorityOverride: {
          quotaBased: {usageTiers: [{daily_quota_percentage: 80, priority: 'PRIORITY_TYPE_HIGH'}]}
        }
      }
    ]
  })
};

fetch('https://api.coralogix.com/mgmt/openapi/5/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/5/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' => '3dc02998-0b50-4ea8-b68a-4779d716fa1f',
    'logRules' => [
        'severities' => [
                
        ],
        'dpxlExpression' => '<string>'
    ],
    'applicationRule' => [
        'name' => '<string>'
    ],
    'archiveRetention' => [
        'id' => '<string>'
    ],
    'description' => 'My Policy Description',
    'enabled' => true,
    'name' => 'My Policy',
    'priorityOverride' => [
        'quotaBased' => [
                'usageTiers' => [
                                [
                                                                'daily_quota_percentage' => 80,
                                                                'priority' => 'PRIORITY_TYPE_HIGH'
                                ]
                ]
        ]
    ],
    'spanRules' => [
        'actionRule' => [
                'name' => '<string>'
        ],
        'dpxlExpression' => '<string>',
        'serviceRule' => [
                'name' => '<string>'
        ],
        'tagRules' => [
                [
                                'ruleTypeId' => 'rule_type_id',
                                'tagName' => 'tags.environment',
                                'tagValue' => 'tag_value'
                ]
        ]
    ],
    'subsystemRule' => [
        'name' => '<string>'
    ],
    'targets' => [
        [
                'archiveRetention' => [
                                'id' => '<string>'
                ],
                'dataset' => 'dataset1',
                'dataspace' => 'dataspace1',
                'priority' => 'PRIORITY_TYPE_MEDIUM',
                'priorityOverride' => [
                                'quotaBased' => [
                                                                'usageTiers' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'daily_quota_percentage' => 80,
                                                                                                                                                                                                                                                                'priority' => 'PRIORITY_TYPE_HIGH'
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  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/policies/v1"

	payload := strings.NewReader("{\n  \"id\": \"3dc02998-0b50-4ea8-b68a-4779d716fa1f\",\n  \"logRules\": {\n    \"severities\": [],\n    \"dpxlExpression\": \"<string>\"\n  },\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  \"priorityOverride\": {\n    \"quotaBased\": {\n      \"usageTiers\": [\n        {\n          \"daily_quota_percentage\": 80,\n          \"priority\": \"PRIORITY_TYPE_HIGH\"\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        \"ruleTypeId\": \"rule_type_id\",\n        \"tagName\": \"tags.environment\",\n        \"tagValue\": \"tag_value\"\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      \"priority\": \"PRIORITY_TYPE_MEDIUM\",\n      \"priorityOverride\": {\n        \"quotaBased\": {\n          \"usageTiers\": [\n            {\n              \"daily_quota_percentage\": 80,\n              \"priority\": \"PRIORITY_TYPE_HIGH\"\n            }\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/policies/v1")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"3dc02998-0b50-4ea8-b68a-4779d716fa1f\",\n  \"logRules\": {\n    \"severities\": [],\n    \"dpxlExpression\": \"<string>\"\n  },\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  \"priorityOverride\": {\n    \"quotaBased\": {\n      \"usageTiers\": [\n        {\n          \"daily_quota_percentage\": 80,\n          \"priority\": \"PRIORITY_TYPE_HIGH\"\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        \"ruleTypeId\": \"rule_type_id\",\n        \"tagName\": \"tags.environment\",\n        \"tagValue\": \"tag_value\"\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      \"priority\": \"PRIORITY_TYPE_MEDIUM\",\n      \"priorityOverride\": {\n        \"quotaBased\": {\n          \"usageTiers\": [\n            {\n              \"daily_quota_percentage\": 80,\n              \"priority\": \"PRIORITY_TYPE_HIGH\"\n            }\n          ]\n        }\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coralogix.com/mgmt/openapi/5/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\": \"3dc02998-0b50-4ea8-b68a-4779d716fa1f\",\n  \"logRules\": {\n    \"severities\": [],\n    \"dpxlExpression\": \"<string>\"\n  },\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  \"priorityOverride\": {\n    \"quotaBased\": {\n      \"usageTiers\": [\n        {\n          \"daily_quota_percentage\": 80,\n          \"priority\": \"PRIORITY_TYPE_HIGH\"\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        \"ruleTypeId\": \"rule_type_id\",\n        \"tagName\": \"tags.environment\",\n        \"tagValue\": \"tag_value\"\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      \"priority\": \"PRIORITY_TYPE_MEDIUM\",\n      \"priorityOverride\": {\n        \"quotaBased\": {\n          \"usageTiers\": [\n            {\n              \"daily_quota_percentage\": 80,\n              \"priority\": \"PRIORITY_TYPE_HIGH\"\n            }\n          ]\n        }\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "policy": {
    "companyId": 1234,
    "deleted": false,
    "enabled": true,
    "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
    "logRules": {
      "severities": [
        "SEVERITY_UNSPECIFIED"
      ],
      "dpxlExpression": "<string>"
    },
    "name": "My Policy",
    "order": 1,
    "priority": "PRIORITY_TYPE_UNSPECIFIED",
    "applicationRule": {
      "name": "<string>",
      "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
    },
    "archiveRetention": {
      "id": "<string>"
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "description": "My Policy Description",
    "priorityOverride": {
      "quotaBased": {
        "usageTiers": [
          {
            "daily_quota_percentage": 80,
            "priority": "PRIORITY_TYPE_HIGH"
          }
        ]
      }
    },
    "priorityOverrideStatus": {
      "quotaBased": {
        "currentPriority": "PRIORITY_TYPE_UNSPECIFIED",
        "currentUsage": 123,
        "dailyLimit": 123
      }
    },
    "rumRules": {
      "severities": [
        "SEVERITY_UNSPECIFIED"
      ],
      "dpxlExpression": "<string>"
    },
    "spanRules": {
      "actionRule": {
        "name": "<string>",
        "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
      },
      "dpxlExpression": "<string>",
      "serviceRule": {
        "name": "<string>",
        "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
      },
      "tagRules": [
        {
          "ruleTypeId": "rule_type_id",
          "tagName": "tags.environment",
          "tagValue": "tag_value"
        }
      ]
    },
    "subsystemRule": {
      "name": "<string>",
      "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
    },
    "targets": [
      {
        "name": "My Target",
        "dataset": "dataset1",
        "priority": "PRIORITY_TYPE_HIGH",
        "archive_retention": {
          "id": "archive_retention_id"
        }
      }
    ],
    "updatedAt": "2021-01-01T00:00:00.000Z"
  }
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

Update Policy

curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
  "logRules": {
    "severities": [],
    "dpxlExpression": "<string>"
  },
  "applicationRule": {
    "name": "<string>"
  },
  "archiveRetention": {
    "id": "<string>"
  },
  "description": "My Policy Description",
  "enabled": true,
  "name": "My Policy",
  "priorityOverride": {
    "quotaBased": {
      "usageTiers": [
        {
          "daily_quota_percentage": 80,
          "priority": "PRIORITY_TYPE_HIGH"
        }
      ]
    }
  },
  "spanRules": {
    "actionRule": {
      "name": "<string>"
    },
    "dpxlExpression": "<string>",
    "serviceRule": {
      "name": "<string>"
    },
    "tagRules": [
      {
        "ruleTypeId": "rule_type_id",
        "tagName": "tags.environment",
        "tagValue": "tag_value"
      }
    ]
  },
  "subsystemRule": {
    "name": "<string>"
  },
  "targets": [
    {
      "archiveRetention": {
        "id": "<string>"
      },
      "dataset": "dataset1",
      "dataspace": "dataspace1",
      "priority": "PRIORITY_TYPE_MEDIUM",
      "priorityOverride": {
        "quotaBased": {
          "usageTiers": [
            {
              "daily_quota_percentage": 80,
              "priority": "PRIORITY_TYPE_HIGH"
            }
          ]
        }
      }
    }
  ]
}
'

import requests

url = "https://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1"

payload = {
    "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
    "logRules": {
        "severities": [],
        "dpxlExpression": "<string>"
    },
    "applicationRule": { "name": "<string>" },
    "archiveRetention": { "id": "<string>" },
    "description": "My Policy Description",
    "enabled": True,
    "name": "My Policy",
    "priorityOverride": { "quotaBased": { "usageTiers": [
                {
                    "daily_quota_percentage": 80,
                    "priority": "PRIORITY_TYPE_HIGH"
                }
            ] } },
    "spanRules": {
        "actionRule": { "name": "<string>" },
        "dpxlExpression": "<string>",
        "serviceRule": { "name": "<string>" },
        "tagRules": [
            {
                "ruleTypeId": "rule_type_id",
                "tagName": "tags.environment",
                "tagValue": "tag_value"
            }
        ]
    },
    "subsystemRule": { "name": "<string>" },
    "targets": [
        {
            "archiveRetention": { "id": "<string>" },
            "dataset": "dataset1",
            "dataspace": "dataspace1",
            "priority": "PRIORITY_TYPE_MEDIUM",
            "priorityOverride": { "quotaBased": { "usageTiers": [
                        {
                            "daily_quota_percentage": 80,
                            "priority": "PRIORITY_TYPE_HIGH"
                        }
                    ] } }
        }
    ]
}
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: '3dc02998-0b50-4ea8-b68a-4779d716fa1f',
    logRules: {severities: [], dpxlExpression: '<string>'},
    applicationRule: {name: '<string>'},
    archiveRetention: {id: '<string>'},
    description: 'My Policy Description',
    enabled: true,
    name: 'My Policy',
    priorityOverride: {
      quotaBased: {usageTiers: [{daily_quota_percentage: 80, priority: 'PRIORITY_TYPE_HIGH'}]}
    },
    spanRules: {
      actionRule: {name: '<string>'},
      dpxlExpression: '<string>',
      serviceRule: {name: '<string>'},
      tagRules: [
        {ruleTypeId: 'rule_type_id', tagName: 'tags.environment', tagValue: 'tag_value'}
      ]
    },
    subsystemRule: {name: '<string>'},
    targets: [
      {
        archiveRetention: {id: '<string>'},
        dataset: 'dataset1',
        dataspace: 'dataspace1',
        priority: 'PRIORITY_TYPE_MEDIUM',
        priorityOverride: {
          quotaBased: {usageTiers: [{daily_quota_percentage: 80, priority: 'PRIORITY_TYPE_HIGH'}]}
        }
      }
    ]
  })
};

fetch('https://api.coralogix.com/mgmt/openapi/5/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/5/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' => '3dc02998-0b50-4ea8-b68a-4779d716fa1f',
    'logRules' => [
        'severities' => [
                
        ],
        'dpxlExpression' => '<string>'
    ],
    'applicationRule' => [
        'name' => '<string>'
    ],
    'archiveRetention' => [
        'id' => '<string>'
    ],
    'description' => 'My Policy Description',
    'enabled' => true,
    'name' => 'My Policy',
    'priorityOverride' => [
        'quotaBased' => [
                'usageTiers' => [
                                [
                                                                'daily_quota_percentage' => 80,
                                                                'priority' => 'PRIORITY_TYPE_HIGH'
                                ]
                ]
        ]
    ],
    'spanRules' => [
        'actionRule' => [
                'name' => '<string>'
        ],
        'dpxlExpression' => '<string>',
        'serviceRule' => [
                'name' => '<string>'
        ],
        'tagRules' => [
                [
                                'ruleTypeId' => 'rule_type_id',
                                'tagName' => 'tags.environment',
                                'tagValue' => 'tag_value'
                ]
        ]
    ],
    'subsystemRule' => [
        'name' => '<string>'
    ],
    'targets' => [
        [
                'archiveRetention' => [
                                'id' => '<string>'
                ],
                'dataset' => 'dataset1',
                'dataspace' => 'dataspace1',
                'priority' => 'PRIORITY_TYPE_MEDIUM',
                'priorityOverride' => [
                                'quotaBased' => [
                                                                'usageTiers' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'daily_quota_percentage' => 80,
                                                                                                                                                                                                                                                                'priority' => 'PRIORITY_TYPE_HIGH'
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  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/policies/v1"

	payload := strings.NewReader("{\n  \"id\": \"3dc02998-0b50-4ea8-b68a-4779d716fa1f\",\n  \"logRules\": {\n    \"severities\": [],\n    \"dpxlExpression\": \"<string>\"\n  },\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  \"priorityOverride\": {\n    \"quotaBased\": {\n      \"usageTiers\": [\n        {\n          \"daily_quota_percentage\": 80,\n          \"priority\": \"PRIORITY_TYPE_HIGH\"\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        \"ruleTypeId\": \"rule_type_id\",\n        \"tagName\": \"tags.environment\",\n        \"tagValue\": \"tag_value\"\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      \"priority\": \"PRIORITY_TYPE_MEDIUM\",\n      \"priorityOverride\": {\n        \"quotaBased\": {\n          \"usageTiers\": [\n            {\n              \"daily_quota_percentage\": 80,\n              \"priority\": \"PRIORITY_TYPE_HIGH\"\n            }\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/policies/v1")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"3dc02998-0b50-4ea8-b68a-4779d716fa1f\",\n  \"logRules\": {\n    \"severities\": [],\n    \"dpxlExpression\": \"<string>\"\n  },\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  \"priorityOverride\": {\n    \"quotaBased\": {\n      \"usageTiers\": [\n        {\n          \"daily_quota_percentage\": 80,\n          \"priority\": \"PRIORITY_TYPE_HIGH\"\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        \"ruleTypeId\": \"rule_type_id\",\n        \"tagName\": \"tags.environment\",\n        \"tagValue\": \"tag_value\"\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      \"priority\": \"PRIORITY_TYPE_MEDIUM\",\n      \"priorityOverride\": {\n        \"quotaBased\": {\n          \"usageTiers\": [\n            {\n              \"daily_quota_percentage\": 80,\n              \"priority\": \"PRIORITY_TYPE_HIGH\"\n            }\n          ]\n        }\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coralogix.com/mgmt/openapi/5/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\": \"3dc02998-0b50-4ea8-b68a-4779d716fa1f\",\n  \"logRules\": {\n    \"severities\": [],\n    \"dpxlExpression\": \"<string>\"\n  },\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  \"priorityOverride\": {\n    \"quotaBased\": {\n      \"usageTiers\": [\n        {\n          \"daily_quota_percentage\": 80,\n          \"priority\": \"PRIORITY_TYPE_HIGH\"\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        \"ruleTypeId\": \"rule_type_id\",\n        \"tagName\": \"tags.environment\",\n        \"tagValue\": \"tag_value\"\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      \"priority\": \"PRIORITY_TYPE_MEDIUM\",\n      \"priorityOverride\": {\n        \"quotaBased\": {\n          \"usageTiers\": [\n            {\n              \"daily_quota_percentage\": 80,\n              \"priority\": \"PRIORITY_TYPE_HIGH\"\n            }\n          ]\n        }\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "policy": {
    "companyId": 1234,
    "deleted": false,
    "enabled": true,
    "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
    "logRules": {
      "severities": [
        "SEVERITY_UNSPECIFIED"
      ],
      "dpxlExpression": "<string>"
    },
    "name": "My Policy",
    "order": 1,
    "priority": "PRIORITY_TYPE_UNSPECIFIED",
    "applicationRule": {
      "name": "<string>",
      "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
    },
    "archiveRetention": {
      "id": "<string>"
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "description": "My Policy Description",
    "priorityOverride": {
      "quotaBased": {
        "usageTiers": [
          {
            "daily_quota_percentage": 80,
            "priority": "PRIORITY_TYPE_HIGH"
          }
        ]
      }
    },
    "priorityOverrideStatus": {
      "quotaBased": {
        "currentPriority": "PRIORITY_TYPE_UNSPECIFIED",
        "currentUsage": 123,
        "dailyLimit": 123
      }
    },
    "rumRules": {
      "severities": [
        "SEVERITY_UNSPECIFIED"
      ],
      "dpxlExpression": "<string>"
    },
    "spanRules": {
      "actionRule": {
        "name": "<string>",
        "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
      },
      "dpxlExpression": "<string>",
      "serviceRule": {
        "name": "<string>",
        "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
      },
      "tagRules": [
        {
          "ruleTypeId": "rule_type_id",
          "tagName": "tags.environment",
          "tagValue": "tag_value"
        }
      ]
    },
    "subsystemRule": {
      "name": "<string>",
      "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
    },
    "targets": [
      {
        "name": "My Target",
        "dataset": "dataset1",
        "priority": "PRIORITY_TYPE_HIGH",
        "archive_retention": {
          "id": "archive_retention_id"
        }
      }
    ],
    "updatedAt": "2021-01-01T00:00:00.000Z"
  }
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

API key authentication

Body

application/json

Update Policy Request
Update Policy Request
Update Policy Request
Update Policy Request

This data structue is used to update an existing policy.

string

required

Unique identifier of the policy to update.

Required string length: 36

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example:

"3dc02998-0b50-4ea8-b68a-4779d716fa1f"

logRules

Log Rules · object

required

Log rules for a policy.

Show child attributes

applicationRule

object

Rule.

Show child attributes

archiveRetention

object

Archive retention.

Show child attributes

description

string

Optional free-text description of the policy's purpose. Only Latin-1 characters are accepted.

Maximum string length: 255

Pattern: ^[\x00-\xFF]*$

Example:

"My Policy Description"

enabled

boolean

Indicates whether the policy should be actively evaluated and applied.

Example:

true

name

string

Human-readable name for the policy. Only Latin-1 characters are accepted.

Required string length: 1 - 255

Pattern: ^[\x00-\xFF]*$

Example:

"My Policy"

priority

enum<string>

TCO priority level assigned to a policy, controlling how data is routed and archived.

Available options:

PRIORITY_TYPE_UNSPECIFIED,

PRIORITY_TYPE_BLOCK,

PRIORITY_TYPE_LOW,

PRIORITY_TYPE_MEDIUM,

PRIORITY_TYPE_HIGH

priorityOverride

object

Priority override.

Show child attributes

rumRules

Log Rules · object

Log rules for a policy.

Show child attributes

spanRules

object

Span rules.

Show child attributes

subsystemRule

object

Rule.

Show child attributes

targets

Target · object[]

List of data targets/destinations to which this policy routes data.

Maximum array length: 5

Show child attributes

Response

This data structue is obtained when updating a policy.

policy

Policy · object

required

A policy is a set of rules that define the behavior of the Coralogix system for a specific company.

Policy
Policy
Policy
Policy

Show child attributes