Skip to main content
Create Policy
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logRules": {
    "severities": [],
    "dpxlExpression": "<string>"
  },
  "name": "My Policy",
  "applicationRule": {
    "name": "<string>"
  },
  "archiveRetention": {
    "id": "<string>"
  },
  "description": "My Policy Description",
  "disabled": true,
  "placement": {
    "first": {}
  },
  "priorityOverride": {
    "quotaBased": {
      "usageTiers": [
        {
          "dailyQuotaPercentage": 80
        }
      ]
    }
  },
  "subsystemRule": {
    "name": "<string>"
  },
  "targets": [
    {
      "archiveRetention": {
        "id": "<string>"
      },
      "dataset": "dataset1",
      "dataspace": "dataspace1",
      "priorityOverride": {
        "quotaBased": {
          "usageTiers": [
            {
              "dailyQuotaPercentage": 80
            }
          ]
        }
      }
    }
  ]
}
'
{
  "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
      }
    },
    "subsystemRule": {
      "name": "<string>"
    },
    "targets": [
      {
        "archiveRetention": {
          "id": "<string>"
        },
        "dataset": "dataset1",
        "dataspace": "dataspace1",
        "priorityOverride": {
          "quotaBased": {
            "usageTiers": [
              {
                "dailyQuotaPercentage": 80
              }
            ]
          }
        }
      }
    ],
    "updatedAt": "2021-01-01T00:00:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

This data structue is used to create a new policy.

​
logRules
Log Rules · object
required

Log rules for a policy.

​
name
string
required

Human-readable name for the policy.

Example:

"My Policy"

​
priority
enum<string>
required

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
​
applicationRule
object

Rule.

​
archiveRetention
object

Archive retention.

​
description
string

Optional free-text description of the policy's purpose.

Example:

"My Policy Description"

​
disabled
boolean

When true, the policy is disabled and will not be evaluated.

​
placement
object

Placement.

​
priorityOverride
object

Priority override.

​
subsystemRule
object

Rule.

​
targets
Target · object[]

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

Response

This data structue is obtained when creating 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.