Skip to navigation

Create a Malware Scanner global configuration

View as MarkdownOpen in Claude

Creates a Malware Scanner global configuration: a named scan schedule you then assign to websites. Creating it scans no website yet: assign websites with “Assign websites to a Malware Scanner global configuration”.

A Malware Scanner configuration has no region, and the technical batch sizes are a dashboard-only setting.

Body

  • name (string, required): the configuration’s name, at most 255 characters.
  • tier (basic or premium, required): basic scans only, premium scans and cleans and needs the add-on, which is metered per website and per month, with no websites included in the plan. It cannot change after creation.
  • schedule (object, required): when scans run.
    • frequency (monthly, weekly or daily, required): a basic configuration is limited to monthly.
    • start_hour (HH:MM, required): 24 hours.
    • timezone (string, required): IANA name, for example Europe/Madrid.
    • day_week (monday to sunday, required for a weekly schedule).
    • day_month (integer from 1 to 31, required for a monthly schedule).
  • extensions (array of strings, optional): file extensions skipped by every scan, from the scanning provider’s own code-file set (php, phtml, php3, php4, php5, php7, phps, inc, js, html, htm, htaccess, svg). Omit it to scan every extension.
  • max_file_size (integer, optional): bytes, 0 to 5242880 (5 MB). Omit it to keep the default.
  • default (boolean, optional): true makes it the configuration new websites receive.

Errors

  • 403: the tier is premium and the organization has not subscribed the add-on.
  • 422: region or batch is sent.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Request

This endpoint expects an object.
defaultbooleanOptional
extensionslist of stringsOptional
max_file_sizedoubleOptional
namestringOptional
scheduleobjectOptional
tierstringOptional

Response headers

LocationstringOptional

Response

201 - Malware scan configuration created

dataobjectOptional
jsonapiobjectOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error