POST /api/admin/data-scanner/scans/

Creates a new data scan. A data scan searches the Baserow instance for sensitive data matching a pattern (e.g. credit card numbers), a list of uploaded values, or values sourced from another Baserow table. Enterprise feature.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
source_field_id Integer No
workspace_ids[] Array No
frequency String No
  • manual - Manual
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly

Valid values:

  • "manual"
  • "weekly"
  • "daily"
  • "hourly"

Default value: "manual"

scan_all_workspaces Boolean No

Default value: true

name String Yes
scan_type String Yes
  • pattern - Pattern
  • list_of_values - List of values
  • list_table - List Table

Valid values:

  • "list_table"
  • "list_of_values"
  • "pattern"
whole_words Boolean No

Default value: true

list_items[] Array No
source_table_id Integer No
pattern String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.