Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Admin data scanner

Updates a data scan configuration. When the scan type, pattern, or list items change, stale results are automatically cleaned up. Enterprise feature.

patch/api/admin/data-scanner/scans/{scan_id}/

Path parameters

scan_idstring required

Request body

namestring
scan_type'pattern' | 'list_of_values' | 'list_table'
  • pattern - Pattern
  • list_of_values - List of values
  • list_table - List Table
patternstring nullable
frequency'manual' | 'hourly' | 'daily' | 'weekly'
  • manual - Manual
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly
scan_all_workspacesboolean
workspace_idsinteger[]
list_itemsstring[]
source_table_idinteger nullable
source_field_idinteger nullable
whole_wordsboolean

Response

idinteger required
namestring required
scan_type'pattern' | 'list_of_values' | 'list_table' required
  • pattern - Pattern
  • list_of_values - List of values
  • list_table - List Table
patternstring nullable
frequency'manual' | 'hourly' | 'daily' | 'weekly'
  • manual - Manual
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly
scan_all_workspacesboolean
workspace_idsstring required
is_runningboolean
last_run_started_atstring date-time nullable
last_run_finished_atstring date-time nullable
last_errorstring nullable
list_itemsstring required
results_countstring required
source_table_idstring required
source_field_idstring required
whole_wordsboolean
source_workspace_idstring required
source_database_idstring required
created_onstring date-time required
updated_onstring date-time required