modifyAddon — Modifying SiteLock Firewall & CDN

The modifyAddon method changes the SiteLock Firewall & CDN service level.

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

    • modifyAddon: The method name

      • addonInfo: (Repeatable) The subscription to modify

        • site_id: The ID of the site

        • subscription: A partner-specific plan ID that identifies this add-on

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <modifyAddon>
        <addonInfo>
            <site_id>442676</site_id>
            <subscription>123</subscription>
        </addonInfo>
    </modifyAddon>
</SiteLockOnlineRequest>

Response format

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

    • modifyAddon: The method name

      • addonStatuses: A list of subscriptions that were modified

        • addonStatus: (Repeatable) This element corresponds to the addonInfo in the request

          • account_id: The account ID imputed from the site_id in the request

          • site_id: The ID of the site

          • subscription: The plan ID provided in the subscription field from the request

          • subscription_id: The unique value used to identify the instance of the service. This can be used in deleteAddon calls.

          • status: Either ok or error

          • code: (Optional) This element is present only when the value of status is error. To view a list of possible error codes, see Error codes.

          • message: The detailed success or error message

Example response

<SiteLockOnlineResponse>
    <modifyAddon>
        <addonStatuses>
            <addonStatus>
                <account_id>379430</account_id>
                <site_id>442676</site_id>
                <subscription>123</subscription>
                <subscription_id>1234</subscription_id>
                <status>ok</status>
                <message>WAF Subscription modified ok</message>
            </addonStatus>
        </addonStatuses>
    </modifyAddon>
</SiteLockOnlineResponse>