AIO Span & Trace Masking API 1.0.0

Admin API for read-time masking to hide or transform parts of traced data (spans and traces) as they are returned by the read APIs and UI. All requests require an accessKey and secretKey header pair; see the Authentication section for how to generate these.

Server

https://{host}/aio/api/v1/private/aio

Server Variables

Authentication

apiKey accessKeyAuth

API access key generated from the ADOC UI. Both accessKey and secretKey are required on every request. To generate a key pair, see API Keys.

Fields

Key	In
accessKey	Header

apiKey secretKeyAuth

API secret key generated from the ADOC UI, paired with accessKey. To generate a key pair, see API Keys.

Fields

Key	In
secretKey	Header

Masking Rules

Create, list, update, and delete read-time masking rules for spans and traces.

/masking-rules/{ruleId}

DELETE

/masking-rules/{ruleId}

List Masking Rules

List all rules in the workspace (enabled and disabled).

Auth

GET /masking-rules

curl --get \
Copy

Responses

200

A list of masking rules.

array	array
name	string	Unique, descriptive name for the rule.
entityKind	string	Type of entity the rule applies to. Enum: `SPAN`,`TRACE`
action	string	DROP_AND_REWIRE removes matching entities and reconnects the trace around them. REDACT replaces matched field content in place. Enum: `DROP_AND_REWIRE`,`REDACT`
filters	array[object]	Conditions that determine which entities the rule matches.
field	string	Field on the entity to filter on.
operator	string	Comparison operator, for example "=".
value	string	Value to compare the field against.
patches	array[object]	Field-level redaction patches. Required when action is REDACT; empty for DROP_AND_REWIRE.
field	string	Field to patch, for example INPUT or OUTPUT.
jsonPath	string	JSONPath expression identifying the portion of the field to patch.
id	string	Unique identifier of the rule.
enabled	boolean	Whether the rule is currently active.

401

The accessKey/secretKey pair is missing or invalid.

Response

[
Copy

Create Masking Rule

Create a new masking rule that either drops matching spans, rewires the trace around them, or redacts specific fields within matching entities.

Auth

Request Body

object	object
name	string	Unique, descriptive name for the rule.
entityKind	string	Type of entity the rule applies to. Enum: `SPAN`,`TRACE`
action	string	DROP_AND_REWIRE removes matching entities and reconnects the trace around them. REDACT replaces matched field content in place. Enum: `DROP_AND_REWIRE`,`REDACT`
filters	array[object]	Conditions that determine which entities the rule matches.
field	string	Field on the entity to filter on.
operator	string	Comparison operator, for example "=".
value	string	Value to compare the field against.
patches	array[object]	Field-level redaction patches. Required when action is REDACT; empty for DROP_AND_REWIRE.
field	string	Field to patch, for example INPUT or OUTPUT.
jsonPath	string	JSONPath expression identifying the portion of the field to patch.

POST /masking-rules

curl --request POST \
Copy

Responses

201

The masking rule was created.

object	object
name	string	Unique, descriptive name for the rule.
entityKind	string	Type of entity the rule applies to. Enum: `SPAN`,`TRACE`
action	string	DROP_AND_REWIRE removes matching entities and reconnects the trace around them. REDACT replaces matched field content in place. Enum: `DROP_AND_REWIRE`,`REDACT`
filters	array[object]	Conditions that determine which entities the rule matches.
field	string	Field on the entity to filter on.
operator	string	Comparison operator, for example "=".
value	string	Value to compare the field against.
patches	array[object]	Field-level redaction patches. Required when action is REDACT; empty for DROP_AND_REWIRE.
field	string	Field to patch, for example INPUT or OUTPUT.
jsonPath	string	JSONPath expression identifying the portion of the field to patch.
id	string	Unique identifier of the rule.
enabled	boolean	Whether the rule is currently active.

400

The request body was invalid.

401

The accessKey/secretKey pair is missing or invalid.

Response

{
Copy

Toggle Rule Status (Enable/Disable)

Enable or disable an existing masking rule without deleting it.

Auth

Request Body

object	object
enabled	boolean	Whether the rule should be active.

PATCH /masking-rules/{ruleId}

curl --request PATCH \
Copy

Responses

200

The updated masking rule.

object	object
name	string	Unique, descriptive name for the rule.
entityKind	string	Type of entity the rule applies to. Enum: `SPAN`,`TRACE`
action	string	DROP_AND_REWIRE removes matching entities and reconnects the trace around them. REDACT replaces matched field content in place. Enum: `DROP_AND_REWIRE`,`REDACT`
filters	array[object]	Conditions that determine which entities the rule matches.
field	string	Field on the entity to filter on.
operator	string	Comparison operator, for example "=".
value	string	Value to compare the field against.
patches	array[object]	Field-level redaction patches. Required when action is REDACT; empty for DROP_AND_REWIRE.
field	string	Field to patch, for example INPUT or OUTPUT.
jsonPath	string	JSONPath expression identifying the portion of the field to patch.
id	string	Unique identifier of the rule.
enabled	boolean	Whether the rule is currently active.

401

The accessKey/secretKey pair is missing or invalid.

404

No rule exists with the given ruleId.

Response

{
Copy

Delete Masking Rule

Delete a rule permanently from the workspace.

Auth

DELETE /masking-rules/{ruleId}

curl --request DELETE \
Copy

Responses

204

The rule was deleted.

No response body

401

The accessKey/secretKey pair is missing or invalid.

404

No rule exists with the given ruleId.

Response

No response
Copy