deletePlan — Deleting active scan plans

The deletePlan method deletes active scan plans from a site.

The deletePlan method can only be used to delete individual scan products from the site. Deleting add-on products (Firewall & CDN, PCI compliance) is covered in Deleting SiteLock Firewall & CDN and Deleting SiteLock PCI compliance.

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

    • deletePlan: The method name

      • planInfo: A list of sites from which to delete a plan or plans

        • site_id: (Repeatabl) The ID of the site

          Submitting multiple site_id elements returns multiple site statuses in a single XML response.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <deletePlan>
        <planInfo>
            <site_id>2468012</site_id>
        </planInfo>
    </deletePlan>
</SiteLockOnlineRequest>

Response format

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

    • deletePlan: The method name

      • planStatuses: A list of subscriptions that were removed

      • planStatus: (Repeatable) This element corresponds to the planInfo element in the request

        • site_id: The ID of the site for which the subscription was removed

        • status: Either ok or error

        • error: The error message. This element is present if status is error.

Example success response

<SiteLockOnlineResponse>
    <deletePlan>
        <planStatuses>
            <planStatus>
                <site_id>2468012</site_id>
                <status>ok</status>
            </planStatus>
        </planStatuses>
    </deletePlan>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <deletePlan>
        <planStatuses>
            <planStatus>
                <error>Billing Authority is SiteLock</error>
                <site_id>2468012</site_id>
                <status>error</status>
            </planStatus>
        </planStatuses>
    </deletePlan>
</SiteLockOnlineResponse>

Error message

The error Billing Authority is SiteLock indicates that a plan was added to the site through a direct sale with SiteLock. Only plans sold to the user by the partner may be deleted from an active site.