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

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

Servers

Path parameters

Name Type Required Description
scan_id String Yes

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"
scan_all_workspaces Boolean No
name String No
scan_type String No
  • pattern - Pattern
  • list_of_values - List of values
  • list_table - List Table

Valid values:

  • "list_table"
  • "list_of_values"
  • "pattern"
whole_words Boolean No
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.