BodySanitizationRule

object
namestring

Optional identifier for this rule

Example:user-id

strategyOne Of
required

Strategy for body content sanitization.

JsonPathStrategyobject

Strategy using JSONPath expression to locate content for sanitization.

* Additional properties are NOT allowed.
Show Child Parameters
scopearray[string]required

Where the rule applies

Allowed values:requestresponse

Default:request, response

actionstringrequired
  • mask: Replace with “******”

Allowed values:mask

Default:mask

Example

UserDefinedRules

object

User-defined payload sanitization rules

headersarray[object]

Rules for sanitizing HTTP headers

Show Child Parameters
bodyarray[object]

Rules for sanitizing request/response body content

Show Child Parameters
Example

PayloadSanitizationConfig

object

Configuration for sanitizing sensitive data in captured payloads

user_defined_rulesobject

User-defined payload sanitization rules

Show Child Parameters
Example

DebugSession

object
idstring(uuid)read-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The optional session name.

max_samplesinteger

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsinteger

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
started_atstring(date-time)read-only

An ISO-8601 timestamp representation of start date.

Example:2024-11-04T20:10:06.927Z

stopped_atstring(date-time)read-only

An ISO-8601 timestamp representation of stop date.

Example:2022-11-04T20:10:06.927Z

completed_atstring(date-time)read-only

An ISO-8601 timestamp representation of completion date.

Example:2022-11-04T20:10:06.927Z

timed_outbooleanread-only

Determines whether the target did not respond in time before the sampling time elapsed.

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

targetsarray[string](uuid)

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters
Example

DebuggerFeatures

string

Allowed values:logstracespayload_sanitization