Get Policy by ID

GEThttps://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1/{id}

Returns the details of the specified data policy.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

id# stringrequired

The unique identifier of the data policy to retrieve.

Example: id

Response

application/json

This data structue is obtained when retrieving a policy by its ID.

policy#object

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

oneOf

Option 1
Option 2
Option 3

object

policy.applicationRule# object

Rule.

policy.archiveRetention# object

Archive retention.

policy.companyId#int32required

Internal Coralogix company/team identifier that owns this policy.

Example: 1234

policy.createdAt#string

Timestamp (RFC 3339) when the policy was created.

Example: 2021-01-01T00:00:00.000Z

policy.deleted#booleanrequired

Soft-delete marker; when true the policy has been deleted and is no longer applied.

Example: false

policy.description#string

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

Example: My Policy Description

policy.enabled#booleanrequired

Indicates whether the policy is actively evaluated and applied.

Example: true

policy.id#stringrequired

Unique identifier for the policy.

Example: policy_id

policy.logRules# object

Log rules for a policy.

policy.name#stringrequired

Human-readable name for the policy.

Example: My Policy

policy.order#int32required

Ordering priority that determines the sequence in which policies are evaluated.

Example: 1

policy.priority#quota.v1.Priorityrequired

TCO priority level assigned to a policy, controlling how data is routed and archived.

Possible values: [PRIORITY_TYPE_UNSPECIFIED, PRIORITY_TYPE_BLOCK, PRIORITY_TYPE_LOW, PRIORITY_TYPE_MEDIUM, PRIORITY_TYPE_HIGH]

policy.priorityOverride# object

Priority override.

policy.priorityOverrideStatus# object

Priority override status.

policy.spanRules# object

Span rules.

policy.subsystemRule# object

Rule.

policy.targets# object[]

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

policy.updatedAt#string

Timestamp (RFC 3339) when the policy was last updated.