Update Policy

PUThttps://api.coralogix.com/mgmt/openapi/5/dataplans/policies/v1

Updates an existing 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

Body

application/json

This data structue is used to update an existing policy.

oneOf
• Option 1
• Option 2
• Option 3
• Option 4
object
applicationRule# object
Rule.
archiveRetention# object
Archive retention.
description#string
Optional free-text description of the policy's purpose. Only Latin-1 characters are accepted.
Possible values: <= 255 characters, Value must match regular expression ^[\x00-\xFF]*$
Example: My Policy Description
enabled#boolean
Indicates whether the policy should be actively evaluated and applied.
Example: true
id#stringrequired
Unique identifier of the policy to update.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f
logRules# object
Log rules for a policy.
name#string
Human-readable name for the policy. Only Latin-1 characters are accepted.
Possible values: non-empty and <= 255 characters, Value must match regular expression ^[\x00-\xFF]*$
Example: My Policy
priority#quota.v1.Priority

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]

priorityOverride# object
Priority override.
rumRules# object
Log rules for a policy.
spanRules# object
Span rules.
subsystemRule# object
Rule.
targets# object[]
List of data targets/destinations to which this policy routes data.
Possible values: <= 5

Response

200400401500application/json

This data structue is obtained when updating a policy.

policy#objectrequired
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
• Option 4
object
policy.applicationRule# object
Rule.
policy.archiveRetention# object
Archive retention.
policy.companyId#int32required
Internal Coralogix company/team identifier that owns this policy.
Possible values: >= 0 and <= 2147483647
Example: 1234
policy.createdAt#string
Timestamp (RFC 3339) when the policy was created.
Possible values: <= 64 characters, Value must match regular expression ^[\s\S]*$
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. Only Latin-1 characters are accepted.
Possible values: <= 255 characters, Value must match regular expression ^[\x00-\xFF]*$
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.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f
policy.logRules# object
Log rules for a policy.
policy.name#stringrequired
Human-readable name for the policy. Only Latin-1 characters are accepted.
Possible values: non-empty and <= 255 characters, Value must match regular expression ^[\x00-\xFF]*$
Example: My Policy
policy.order#int32required
Ordering priority that determines the sequence in which policies are evaluated. Can be negative for policies placed first.
Possible values: >= -2147483648 and <= 2147483647
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.rumRules# object
Log rules for a policy.
policy.spanRules# object
Span rules.
policy.subsystemRule# object
Rule.
policy.targets# object[]
List of data targets/destinations to which this policy routes data.
Possible values: <= 5
policy.updatedAt#string
Timestamp (RFC 3339) when the policy was last updated.
Possible values: <= 64 characters, Value must match regular expression ^[\s\S]*$
Example: 2021-01-01T00:00:00.000Z