List Scan Objects

List objects available for scanning under a data source — filter by database, schema, or list all objects.

{
  "data": {
    "data_source_name": "salesforce",
    "object_name": ["CustomerDB"]
  }
}

curl -X PUT https://<domain>/api/vault/data-scan/objects/list \
  -H "Authorization: Bearer <AUTH_TOKEN>" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "data": {
      "data_source_name": "salesforce",
      "object_name": ["CustomerDB"]
    }
  }'

{
  "data": [
    {
      "data_source_name": "salesforce",
      "objects": [
        ["CustomerDB", "MarketingSchema", "CustomersTable"],
        ["CustomerDB", "AnalyticsSchema", "CustomerAnalyticsTable"]
      ]
    }
  ],
  "success": true,
  "error": { "message": "" }
}

Lists objects available for scanning under a data source. Use this to explore the data source hierarchy before or after scanning.

Endpoint

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

Filtering options

Use case	`object_name` value
List all objects	Not provided
Filter by database	`["CustomerDB"]`
Filter by schema	`["CustomerDB", "MarketingSchema"]`

Notes

Each element in objects is a fully qualified path array: [database, schema, table]
Use these paths directly as the object_name in scan requests
Omit object_name entirely to list all available objects across the data source

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI