Mask Data API
POST /v1/integration/mask-data
Summary
Mask data in a file based on user-specified column masking options.
Request Headers
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer API_TOKEN | The API token required for authentication. |
Form Data Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| file | file | Yes | The file to be masked. Supported formats include Parquet, CSV, JSON, Avro and Feather. |
| column_masking_options | string | No | JSON string specifying the columns to mask and their masking types. If not provided, auto-detection is applied. |
column_masking_options Example:
[
{"column_name": "email", "masking": "email"},
{"column_name": "phone", "masking": "phone_number"}
]
200: Successful Response
The successful response streams the masked file back to the client. The response headers include the appropriate Content-Disposition for downloading the file. The same file format (Parquet, CSV, JSON, Avro and Feather) is returned with the 'masked' columns.
Content-Disposition: attachment; filename=masked_data.<media_type>
Content-Type: <media_type>