Policies Service

Get Policy by ID

Returns the details of the specified data policy.

get/dataplans/policies/v1/{id}

Request

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

Path parameters

idstring required

The unique identifier of the data policy to retrieve.

Example:3dc02998-0b50-4ea8-b68a-4779d716fa1f

Response

Example response

{
  "policy": {
    "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.