provisionAddon — Provisioning SiteLock DNS

The provisionAddon method provisions SiteLock DNS. It can be provisioned as an add-on to an existing package or a standalone product if the user doesn’t have a SiteLock scanning package.

Smart routing, load balancing, and DNSSEC key rotation are only available for users of Premium DNS. Users of Standard DNS are offered DNSSEC without the key rotation capability.

If you want to purchase more than one subscription, all DNS subscriptions can be provisioned in one request and can be attached to the same SiteLock account_id.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

The example request contains three instances of the addonInfo element, one for each subscription purchased. The following explanation documents one request.

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
- provisionAddon: The method name
  - addonInfo: (Repeatable) The subscription details
    
    site_id: The ID of the site. See also Provisioning an add-on as a standalone product.
    
    subscription: A partner-specific plan ID that identifies the add-on
    
    amount: (Optional) The decimal amount the user was billed for the add-on
    
    This element is not optional when partner invoicing is based on a revenue sharing agreement.
    
    renewal_date: (Optional) The renewal date

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <provisionAddon>
        <addonInfo>
            <site_id>442676</site_id>
            <amount>129.95</amount>
            <subscription>XXX</subscription>
        </addonInfo>
        <addonInfo>
            <site_id>379430</site_id>
            <subscription>XXX</subscription>
            <renewal_date>2022-03-03</renewal_date>
        </addonInfo>
        <addonInfo>
            <site_id>15905</site_id>
            <subscription>XXX</subscription>
        </addonInfo>
    </provisionAddon>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- provisionAddon: The method name
  - addonStatuses: A list of subscriptions that were provisioned.
    
    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 provisioned
    
    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 contains more detail.
    
    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

Since multiple provisioning requests can be submitted at one time, the status of an individual provisioning request should be determined by reading the status and message fields of the specific addonStatus element. To find the addonStatus element in question, use the site ID and subscription plan ID submitted in the provisionAddon request. In the following example, the first two requests to provision this add-on succeeded, whereas the third one failed because the site specified was invalid for this partner.

Example response

<SiteLockOnlineResponse>
    <provisionAddon>
        <addonStatuses>
            <addonStatus>
                <account_id>1000297</account_id>
                <site_id>442676</site_id>
                <subscription>631</subscription>
                <subscription_id>1234</subscription_id>
                <status>ok</status>
                <message>DNS Subscription added ok</message>
            </addonStatus>
            <addonStatus>
                <account_id>1000297</account_id>
                <site_id>379430</site_id>
                <subscription>632</subscription>
                <subscription_id>1254</subscription_id>
                <status>ok</status>
                <message>DNS Subscription added ok</message>
            </addonStatus>
            <addonStatus>
                <account_id></account_id>
                <site_id>15905</site_id>
                <subscription>632</subscription>
                <status>error</status>
                <code>ISI</code>
                <message>Invalid/Unknown Site ID</message>
            </addonStatus>
        </addonStatuses>
    </provisionAddon>
</SiteLockOnlineResponse>