Submit Data Scan

Submit an asynchronous data scan job for one or more objects. Returns a tracking ID to check scan progress.

[
  {
    "data_source_name": "salesforce",
    "object_name": ["CustomerDB", "MarketingSchema", "CustomersTable"],
    "data_samples": [
      {
        "column_name": "CustomerID",
        "samples": ["CID32", "CID34", "CID56", "CID58"]
      },
      {
        "column_name": "email",
        "samples": ["John@gmail.com", "Williams.hary@yahoo.com"]
      }
    ]
  }
]

curl -X PUT https://<domain>/api/vault/data-scan/data-scan-async \
  -H "Authorization: Bearer <AUTH_TOKEN>" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '[
    {
      "data_source_name": "salesforce",
      "object_name": ["CustomerDB", "MarketingSchema", "CustomersTable"],
      "data_samples": [
        {
          "column_name": "CustomerID",
          "samples": ["CID32", "CID34", "CID56", "CID58"]
        },
        {
          "column_name": "email",
          "samples": ["John@gmail.com", "Williams.hary@yahoo.com"]
        }
      ]
    }
  ]'

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

Submits a data scan request for one or more objects. The scan runs asynchronously and returns a tracking ID.

Endpoint

Method	Endpoint
`PUT`	`https://<domain>/api/vault/data-scan/data-scan-async`

Authentication

header

Authorizationstring

Required

Bearer token. Format: Bearer <AUTH_TOKEN>

Request body

body

data_source_namestring

Required

Logical name of the data source (e.g., "salesforce", "snowflake").

body

object_namearray[string]

Required

Fully qualified path as [database, schema, table]. For example: ["CustomerDB", "MarketingSchema", "CustomersTable"].

body

data_samplesarray

Sample values to improve ML detection accuracy. Each element requires column_name and samples.

Response fields

tracking_idstring

Required

Unique identifier for tracking scan progress. Use this with the Scan Status API.

Notes

data_samples is optional but recommended — providing representative samples improves ML detection confidence
A scan job can include multiple objects in a single request
The scan runs in the background. Use the tracking ID to poll for status

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI