POST /v1/dataMaskingRules
Create a new data masking rule. The rule will be applied to search results at query time, replacing matches of the regex pattern with the specified mask string.
Servers
- https://api.au.sumologic.com/api/
- https://api.ca.sumologic.com/api/
- https://api.de.sumologic.com/api/
- https://api.eu.sumologic.com/api/
- https://api.fed.sumologic.com/api/
- https://api.jp.sumologic.com/api/
- https://api.kr.sumologic.com/api/
- https://api.in.sumologic.com/api/
- https://api.sumologic.com/api/
- https://api.us2.sumologic.com/api/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the data masking rule. Use a name that makes it easy to identify the rule. Must be unique within the organization. This field is immutable and cannot be changed after creation. |
description |
String | No |
Optional description of the data masking rule. Provide context about what PII this rule masks and why it's needed. |
enabled |
Boolean | Yes |
Whether the data masking rule is active. Only enabled rules are applied to search results. Set to false to temporarily disable a rule without deleting it. Default value: true |
maskString |
String | No |
The string to replace matched PII with. Defaults to '##redactedPII##' if not specified. Use descriptive mask strings like 'EMAIL_REDACTED' or 'PHONE_REDACTED' for clarity. Default value: "##redactedPII##" |
regexPattern |
String | Yes |
Regular expression pattern to match PII data that should be masked. The pattern must be valid according to Java regex syntax. All matches in search results will be replaced with the mask string. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.