Skip to main content
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": "policy_id",
  "logRules": {
    "severities": [
      "SEVERITY_UNSPECIFIED"
    ],
    "dpxlExpression": "<string>"
  },
  "applicationRule": {
    "name": "<string>",
    "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
  },
  "archiveRetention": {
    "id": "<string>"
  },
  "description": "My Policy Description",
  "enabled": true,
  "name": "My Policy",
  "priority": "PRIORITY_TYPE_UNSPECIFIED",
  "priorityOverride": {
    "quotaBased": {
      "usageTiers": [
        {
          "dailyQuotaPercentage": 80,
          "priority": "PRIORITY_TYPE_UNSPECIFIED"
        }
      ]
    }
  },
  "subsystemRule": {
    "name": "<string>",
    "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
  },
  "targets": [
    {
      "dataset": "dataset1"
    }
  ]
}
'
{
  "policy": {
    "companyId": 1234,
    "deleted": false,
    "enabled": true,
    "id": "policy_id",
    "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": [
          {
            "dailyQuotaPercentage": 80,
            "priority": "PRIORITY_TYPE_UNSPECIFIED"
          }
        ]
      }
    },
    "priorityOverrideStatus": {
      "quotaBased": {
        "currentPriority": "PRIORITY_TYPE_UNSPECIFIED",
        "currentUsage": 123,
        "dailyLimit": 123
      }
    },
    "subsystemRule": {
      "name": "<string>",
      "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
    },
    "targets": [
      {
        "dataset": "dataset1"
      }
    ],
    "updatedAt": "2021-01-01T00:00:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

This data structue is used to update an existing policy.

id
string
required
Example:

"policy_id"

logRules
Log Rules · object
required

Log rules for a policy.

applicationRule
object
archiveRetention
object
description
string
Example:

"My Policy Description"

enabled
boolean
Example:

true

name
string
Example:

"My Policy"

priority
enum<string>
Available options:
PRIORITY_TYPE_UNSPECIFIED,
PRIORITY_TYPE_BLOCK,
PRIORITY_TYPE_LOW,
PRIORITY_TYPE_MEDIUM,
PRIORITY_TYPE_HIGH
priorityOverride
object
subsystemRule
object
targets
Target · object[]

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.