Data Deletion & RetentionTrack Deletion Jobs

Track Deletion Jobs

Monitor the status and outcome of asynchronous data deletion jobs using their tracking IDs.

curl -X GET "{baseurl}/api/vault/namespace/job-status?tracking_id=9f799cb6-5315-4199-8d47-3a7ced21dd1d" \
  -H "Authorization: Bearer <NAMESPACE_ADMIN_API_KEY>"
{
  "data": {
    "tracking_id": "9f799cb6-5315-4199-8d47-3a7ced21dd1d",
    "requested_user": "admin@example.com",
    "requested_timestamp": "2024-05-28 18:23:42",
    "process_start_time": "2024-05-28 18:23:43",
    "process_end_time": "2024-05-28 18:23:51",
    "data_deletion": {
      "job_type": "data-deletion",
      "status": "SUCCESS",
      "response": {
        "cleared_records": 150,
        "message": "Records older than the specified date have been cleared successfully."
      },
      "error_msg": ""
    }
  },
  "success": true,
  "error": { "message": "" }
}

All deletion requests run asynchronously. Use this API to track job progress and final outcome.

Only the admin who initiated the deletion can query the job status.

Endpoint

MethodEndpoint
GET{baseurl}/api/vault/namespace/job-status

Query parameters

query
tracking_idstring
Required

Tracking ID returned by the deletion API.

Status values

StatusMeaning
PENDINGJob accepted but not yet started
IN-PROGRESSDeletion is currently running
SUCCESSDeletion completed successfully
FAILEDDeletion failed. Check error_msg

Polling guidance

Poll every 30–60 seconds for large deletion jobs. The data_deletion.response.cleared_records field in a SUCCESS response indicates how many records were deleted.