modifyScanFrequency — Modifying the frequency of automated scans

The modifyScanFrequency method updates the scan frequency for the following scans:

Webpage Scan
Vulnerability Scan (SQL Injection Scan, Cross-Site Scripting Scan, and 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: The method name.
  - site_id: The ID of the site for which to modify the scan frequency.
  - frequency: The scan frequency.
    
    The possible values are daily, weekly, monthly, quarterly, and never.

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: The method name.
  - message: The detailed success or error message.
  - status: Possible values:
    
    ok: Success return value
    
    error: Error return value. The message element contains more detail.

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