deleteAddon — Deleting SiteLock DNS

The deleteAddon method deletes the SiteLock DNS subscription.

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

    • deleteAddon: The method name

      • addonInfo: (Repeatable) The subscription to delete. You can delete subscriptions for different add-ons in a single request, as long as each subscription has a separate addonInfo element.

        • subscription_id: A unique value that identifies the instance of the service. See getStatus for information on retrieving subscription IDs.

          We recommend you only pass subscription_id when deleting a subscription. Specifying an account_id or site_id isn’t recommended.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <deleteAddon>
        <addonInfo>
            <subscription_id>442676</subscription_id>
        </addonInfo>
    </deleteAddon>
</SiteLockOnlineRequest>

Response format

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

    • deleteAddon: The method name

      • addonStatuses: A list of subscriptions that were deleted

        • 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 deleted

          • subscription_id: The ID of the deleted subscription

          • 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 contains 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>
    <deleteAddon>
        <addonStatuses>
            <addonStatus>
                <status>ok</status>
                <message>DNS Subscription deleted ok</message>
                <account_id>123456</account_id>
                <site_id>654321</site_id>
                <subscription_id>442676</subscription_id>
            </addonStatus>
        </addonStatuses>
    </deleteAddon>
</SiteLockOnlineResponse>