This API allows users to update the threshold percentage used to determine the presence of personally identifiable information (PII) in scanned data. This threshold can be set globally or for specific database objects.
For authentication, include the following token in the request headers:
Headers: {“Authorization”: “Bearer <AUTH_TOKEN>”}
Note: To obtain the <auth token>
, please refer to the Step-by-Step Guide to Obtain Your Auth Token
Endpoint: /data-scan/pi-conclusion-percentage/update
Method: PUT
Input Formats:
The input JSON can be provided in two formats:
- Global PI Conclusion Percentage Update
- Description: Update the global threshold percentage for all data scans.
Sample Input :
{ "pi_conclusion_percentage": 40 }
Sample Output :
{ "data": { "message": "Global pi_conclusion_percentage updated successfully to 40." }, "success": "true", "error": { "message": "" } }
Specific Object PI Conclusion Percentage Update
- Description: Update the threshold percentage for a specific data source and object.
Sample Input:
{ "data_source_name": "Snowflake", "object_name": ["AnalyticsDB", "ReportsSchema", "AnnualSalestable"], "pi_conclusion_percentage": 40 }
Sample Output :
{ "data": { "message": "pi_conclusion_percentage updated successfully for object ["AnalyticsDB","ReportsSchema","AnnualSalestable"] to 40." }, "success": "true", "error": { "message": "" } }
Output Parameters:
- data: An object containing a message that confirms the successful update of the pi_conclusion_percentage.
Usage Notes:
- When providing only the pi_conclusion_percentage in the input, the API updates the global threshold percentage used across all THE OBJECTS WITHIN THE DATASOURCE.
- When providing the data_source_name and object_name along with the pi_conclusion_percentage, the API updates the threshold percentage for the specified object within the data source.
- The object_name should be an array specifying the full path to the object in the format eg[database, schema, table].