modifyAddon — Modifying SiteLock DNS

The modifyAddon method updates the SiteLock DNS subscription.

When you move from Standard DNS to Premium DNS or vice versa, SiteLock migrates all DNS records for the domain from the original subscription to the new subscription. Any DNS record changes after the subscription change is initiated will only take place on the new subscription. You’ll have 7 days to update the nameservers for the domain.

If you have DNSSEC enabled, make sure to disable it before initiating an upgrade or downgrade.

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 the 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 element in the request

          • account_id: The ID of the account to which the site belongs

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

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

          • subscription_id: A unique value that identifies the instance of the service. This value can be used later in a deleteAddon request.

          • status: The status of the request. The value can be one of the following:

          • ok: The request was successful.

          • error: An error occurred. The message element provides more detail.

          • code: (Optional) This element is present 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>DNS Subscription modified ok</message>
            </addonStatus>
        </addonStatuses>
    </modifyAddon>
</SiteLockOnlineResponse>