Configuring Add-on Plan Settings

The set operation is used to update add-on plan settings.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet adjusting add-on plan settings includes the set operation node:

<packet>
<service-plan-addon>
   <set>
   ...
   </set>
</service-plan-addon>
</packet>

Important: When you update plan settings, all the associated unlocked subscriptions are automatically updated.

The set node is presented by type DomainAddonTemplateSetInputType (domain_addon_template.xsd). Its graphical representation is as follows:

addon_set

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The set node of the output XML packet is of type DomainAddonTemplateSetOutputType (domain_addon_template.xsd) which has the following presentation:

service-plan-addon-set-reps.gif

 

Samples

Update add-on plans that belong to a reseller

To update settings of update only plans of a particular reseller, specify their ID or username.

<packet>
<service-plan-addon>
<set>
   <filter>
      <name>base1</name>
   </filter>
   <owner-login>jdoe</owner-login>
        <limits>
          <limit>
            <name>max_db</name>
            <value>10</value>
          </limit>
        </limits>
</set>
</service-plan-addon>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <set>
      <result>
        <status>ok</status>
        <name>base1</name>
      </result>
    </set>
  </service-plan-addon>
</packet>
Update add-on plans that belong to the Administrator

If you are authorized as the Administrator, you can omit the reseller details:

<packet>
<service-plan-addon>
<set>
   <filter>
      <name>base_plan</name>
   </filter>
        <limits>
          <limit>
            <name>max_db</name>
            <value>10</value>
          </limit>
        </limits>
</set>
</service-plan-addon>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <set>
      <result>
        <status>ok</status>
        <name>base_plan</name>
      </result>
    </set>
  </service-plan-addon>
</packet>

 

Operating multiple add-on plans

Here is the sample packet that sets similar add-on plan settings for two different add-on plans, both specified by ID.

<packet>
<service-plan-addon>
<set>
   <filter>
      <id>11</id>
      <id>12</id>
   </filter>
        <limits>
          <limit>
            <name>max_db</name>
            <value>10</value>
          </limit>
        </limits>
</set>
</service-plan-addon>
</packet>

 

To set different settings for two add-on plans, use two different set operations:

<packet>
<service-plan-addon>
<set>
   <filter>
      <id>12</id>
   </filter>
   <owner-login>JDoe</owner-login>
        <limits>
          <limit>
            <name>max_db</name>
            <value>10</value>
          </limit>
        </limits>
</set>
<set>
   <filter>
      <name>base_plan</name>
   </filter>
        <limits>
          <limit>
            <name>max_db</name>
            <value>10</value>
          </limit>
        </limits>
</set>
</service-plan-addon>
</packet> 

Limits

The following packet updates limits of a plan:

<packet>
<service-plan-addon>
<set>
   <filter>
      <id>12</id>
   </filter>
   <limits>
          <limit>
            <name>disk_space</name>
            <value>10737418240</value>
          </limit>
   </limits>
</set>
</service-plan-addon>
</packet>

Hosting

This packet updates physical hosting settings for the plan with ID 12.

<packet>
<service-plan-addon>
<set>
   <filter>
      <id>12</id>
   </filter>
   <hosting>

            <property>
              <name>ssl</name>
              <value>true</value>
            </property>

   </hosting>
</set>
</service-plan-addon>
</packet>

Performance

Here is the sample packet that updates performance settings for the plan with ID 12.

<packet>
<service-plan-addon>
<set>
   <filter>
      <id>12</id>
   </filter>
   <performance>
      <bandwidth>1000</bandwidth>
      <max_connections>20</max_connections>
   </performance>
</set>
</service-plan-addon>
</packet>