POST /v1/dataMaskingRules/evaluate

Evaluate a regex pattern against input text. This endpoint can be used to test regex patterns for data masking rules. You can provide your own mask string which will be used for masking, otherwise it will be masked with default value of ##redactedPII##. The response includes the masked text, match count, and positions of matches in the masked output text.

Servers

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
text String Yes

Sample message used for masking evaluation.

maskString String No

Optional mask string. If null or empty, the service may apply a default mask string.

Default value: "##redactedPII##"

regexPattern String Yes

Regex pattern used to identify substrings to mask.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.