Policies Service

Get Company Policies

Returns all data policies for the team.

get/dataplans/policies/v1

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/dataplans/policies/v1
  • Auth: API key in header Authorization

Query parameters

enabled_onlyboolean

When true, return only policies that are currently enabled.

Example:true
source_type'SOURCE_TYPE_UNSPECIFIED' | 'SOURCE_TYPE_LOGS' | 'SOURCE_TYPE_SPANS' | 'SOURCE_TYPE_RUM'

Source type.

Filter policies by data source type (for example logs or spans).

Response

Example response

{
  "policies": [
    {
      "companyId": 1234,
      "createdAt": "2021-01-01T00:00:00.000Z",
      "description": "My Policy Description",
      "enabled": true,
      "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
      "name": "My Policy",
      "order": 1,
      "priorityOverride": {
        "quotaBased": {
          "usageTiers": [
            {
              "daily_quota_percentage": 80,
              "priority": "PRIORITY_TYPE_HIGH"
            }
          ]
        }
      },
      "spanRules": {
        "tagRules": [
          {
            "tagName": "tags.environment",
            "tagValue": "tag_value"
          }
        ]
      },
      "targets": [
        {
          "name": "My Target",
          "dataset": "dataset1",
          "priority": "PRIORITY_TYPE_HIGH",
          "archive_retention": {
            "id": "archive_retention_id"
          }
        }
      ],
      "updatedAt": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.