The Data Scan Status API’s PUT method allows users to retrieve the status of a data scan process initiated through the Data Scan Async API. This document provides details 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-status
Code Snippet
["47882682-9f38-4f45-afec-daadaa1b230b", "97d18b52-ade8-44f8-9176-802e329c0d2b"]
Input Parameters :
The API expects a JSON (JavaScript Object Notation) object as input with the following key:
- tracking_id(s):
- Description: A single tracking ID or a list of tracking IDs obtained from the Data Scan Async API. This is the identifier associated with the data scan process.
- Type: String or Array of Strings
- Example:
- Single ID:
"123456789" - List of IDs:
["123456789", "987654321"]
- Single ID:
Output
The API will respond with detailed information about the status of the specified data scan process(es):
{
"data": [
{
"tracking_id": "47882682-9f38-4f45-afec-daadaa1b230b",
"status": "PENDING ",
"submitted_at": "2023-11-18 06:20:38.346615",
"process_started_at": "2023-11-18 06:20:38.346615",
"process_ended_at": "2023-11-18 06:20:38.346615",
"error_msg": "-"
},
{
"tracking_id": "97d18b52-ade8-44f8-9176-802e329c0d2b",
"status": "SUCCESS ",
"submitted_at": "2023-11-18 06:20:38.346615",
"process_started_at": "2023-11-18 06:20:38.346615",
"process_ended_at": "2023-11-18 06:20:38.346615",
"error_msg": "-"
}
]
"success": "true",
"error": {
"message": ""
}
}
Output Parameters :
- tracking_id:
- Type: String
- status:
- Description: The current status of the data scan process.
- Type: String
- Possible values:
PENDING,IN-PROGRESS,SUCCESS,FAILED
- Submitted_at:
- Description: The time at which the request was made.
- Type: Timestamp
- process_started_at:
- Description: The time at which the data scan process started.
- Type: Timestamp
- process_ended_at:
- Description: The time at which the data scan process ended.
- Type: Timestamp
- error_msg:
- Description: If any error occurred during the data scan, it will be recorded here.
- Type: String (nullable)
