deleteAddon — Deleting SiteLock Firewall & CDN

Once provisioned, the SiteLock Firewall & CDN service can be removed at any time using the deleteAddon call. Make sure that the user reverts their DNS settings to the origin IP settings and away from SiteLock Firewall & CDN service, or their site may become unavailable.

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

        • site_id: A valid SiteLock site ID

        • prod_type: WAF

Example request

Example Firewall & CDN deletion request
<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <deleteAddon>
        <addonInfo>
            <site_id>442676</site_id>
            <prod_type>WAF</prod_type>
        </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 removed

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

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

          • site_id: The SiteLock site ID from the request

          • subscription: The plan ID deleted

          • dns_orig_a: The original origin IP address for the site

          • dns_orig_cname: The original CNAME alias assigned to the site

          • status: Can be one of the following values:

            • ok: Success return value

            • error: Error return value. The message element contains more detail.

          • code: This element is present when status is error.

          • message: The detailed error or success message, for example:

            • WAF Subscription deleted ok

            • Invalid/Unknown Account ID

Example response

<SiteLockOnlineResponse>
    <deleteAddon>
        <addonStatuses>
            <addonStatus>
                <account_id>379430</account_id>
                <site_id>442676</site_id>
                <subscription>1234</subscription>
                <dns_orig_a>193.20.121.90</dns_orig_a>
                <dns_orig_cname>www.example.com</dns_orig_cname>
                <status>ok</status>
                <message>WAF Subscription deleted ok</message>
            </addonStatus>
        </addonStatuses>
    </deleteAddon>
</SiteLockOnlineResponse>

Overview: Provisioning Firewall & CDN and checking Firewall & CDN provisioning status

  • Provision the site using provisionAccount or provisionAddon.

  • If the site has no SSL, skip to Continue the site’s DNS zone…, below.

  • If the site has SSL, set up the DNS TXT resource record provided in dns_ssl_verify.

  • Firewall & CDN DNS records may always be retrieved by sending a request to getAnpProvisioningStatus.

  • After setting up the DNS TXT record, periodically send requests to getAnpProvisioningStatus to check the state.

  • When the state value changes from pending-domain-validation to pending-dns, you will be provided with the new A records (IP addresses) and a CNAME alias, as shown previously.

  • Configure the site’s DNS zone with the information specified in the dns_new_a and dns_new_cname records.

  • (Optional) Call getAnpProvisioningStatus periodically to check for the ready state.

  • The site will be configured automatically. If you wish to confirm a site has been set up correctly, you may use this call to check.