Updated on July 4, 2024

Data Scan Async

Note: Data Scan APIs are not available for trial users. A subscription is required to access these features. Please contact help@protecto.ai for assistance.

 

The Data Scan Async API’s PUT method is designed to initiate an asynchronous scanning process for column values within a specified data source. This document provides information on how to use the API, the required input parameters, and the expected output.

Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token.

# Import the ProtectoVault class from the protecto_ai module
from protecto_ai import ProtectoVault
# Create an instance of ProtectoVault with your authentication token
obj = ProtectoVault("<auth_token>")

HTTP Method: PUT

Endpoint: /data-scan-async

Code Snippet

[
  {
    "data_source_name": "Datasource1",
    "object_name": ["db1","schema1","table1"],   
    "data_samples": [
      {
        "column_name": "column_1",
        "samples": [ "s1", "s2","s3","s4","s5"]
      } 
   ]
  }
]

input Parameters :

  1. data_source_name:
    • Description: A user-defined identifier for the data source. Users can provide any name for this identifier.
    • Type: String
    • Example: "Datasource1"
  2. object_name:
    • Description: The fully qualified table name or object name in the list that represents the target data structure for scanning.
    • Type: String
    • Example: "schema_name.table_name"
  3. List of columns and their sample values:
    • Description: An array or nested structure containing information about the columns to be scanned and their sample values

Output :

Upon successful initiation of the scanning process, the API will respond with a tracking ID. The tracking ID serves as a unique identifier for the initiated scan.

{
  "data": {
    "tracking_id": "47882682-9f38-4f45-afec-daadaa1b230b"
  },
  "success": "true",
  "error": {
    "message": ""
  }
}

 

What are your feelings?
Scroll to Top