Skip to main content
Get Company Policies
curl --request GET \
  --url https://api.coralogix.com/mgmt/openapi/latest/dataplans/policies/v1 \
  --header 'Authorization: <api-key>'
{
  "policies": [
    {
      "companyId": 1234,
      "deleted": false,
      "enabled": true,
      "id": "policy_id",
      "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",
      "logRules": {
        "severities": [
          "SEVERITY_UNSPECIFIED"
        ]
      },
      "subsystemRule": {
        "name": "<string>",
        "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED"
      },
      "updatedAt": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
enabled_only
boolean
Example:

true

​
source_type
enum<string>
Available options:
SOURCE_TYPE_UNSPECIFIED,
SOURCE_TYPE_LOGS,
SOURCE_TYPE_SPANS

Response

This data structue is obtained when retrieving all policies of a company.

​
policies
Policy · object[]
required

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