modifyScanFrequency — Modifying the frequency of automated scans

The modifyScanFrequency endpoint enables partners to update frequency options, similar to the SMART feature.

This endpoint allows modifying scan frequency for the following features:

  • Webpage Scan (malware scan)

  • SQL Injection Scan

  • Cross-Site Scripting Scan

  • Platform Scan

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

  • SiteLockOnlineRequest: This element is used to delineate the full API request.

    • authentication: The partner’s username, password, and branding

      • username: The partner’s API username

      • password: The partner’s API password

      • partner: (Optional) The brand name to use in messaging

    • modifyScanFrequency: Update frequency options.

      • site_id: The ID of the site for which to modify the scan frequency.

      • frequency: Desired scan frequency. Allowed values: hourly, daily, weekly, monthly, quarterly, never (subject to plan features).

Example request

The following request triggers all available scan products for a specific site.

<SiteLockOnlineRequest>
    <authentication>
        <user>[]</user>
        <password>[]</password>
    </authentication>
    <modifyScanFrequency>
        <site_id>[]</site_id>
        <frequency>[]</frequency>
    </modifyScanFrequency>
</SiteLockOnlineRequest>

Response format

Example successful response

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • modifyScanFrequency: Updates frequency options.

      • message: Descriptive message about the request status.

      • status: Indicates success or failure.

<SiteLockOnlineResponse>
    <modifyScanFrequency>
        <message>[]</message>
        <status>[]</status>
    </modifyScanFrequency>
</SiteLockOnlineResponse>