We use cookies on our website to ensure we provide you with the best experience on our website. By using our website, you agree to the use of cookies for analytics and personalized content.This website uses cookies. More Information
It seems like your browser didn't download the required fonts. Please revise your security settings and try again.

Config.delete

  • Last updated on

This method deletes an object of type $type identified by $path.

Parameters Allowed

The following variables are used by the config.delete method. These variables should be provided as part of the request XML in the HTTP POST request.

  • password – A required parameter which the API uses to authenticate access to a page and which is set by your administrator.
  • type – A required parameter which specifies the class/scope of an object.

  • path – A required parameter which is the qualified name of an object to be deleted.

Example 1: Deleting a scoped object

Delete domain 'xyz.com'.

Arguments
  • type: 'domain'
  • path: 'xyz.com'
  • variable-value list: httpd_acl_ip_config_netmask = 255.255.128.0
Sample Request
 <?xml version="1.0" encoding="UTF8"?>
<methodCall>
 <methodName>config.delete</methodName>
  <params>
   <param>
    <value>
      <struct>
       <member>
        <name>path</name>
         <value>
          <string><![CDATA[xyz.com]]></string>
         </value>
       </member>
       <member>
        <name>type</name>
         <value>   
        <string>
          <![CDATA[domain]]>
         </string>
         </value>
        </member>
       </struct>
      </value>
     </param>
   </params>
</methodCall>

Example 2: Delete a tied object and its tied variable values – global scope

Delete the global tied object mta_rbl_custom_name 'xyz.com' along with all of its tied variables. In this example, the tied variable is mta_rbl_custom_action, which stores the action (Block, Tag or Quarantine) to take with messages originating from IP addresses in custom external RBLs. These variables appear in the configuration like this:

  • # Custom RBL Action List
  • mta_rbl_custom_action = Block
  • # Custom RBL List
  • mta_rbl_custom_name = xyz.com
Arguments
  • type: 'mta_rbl_custom_name'
  • path: 'xyz.com'
Sample Request
 <?xml version="1.0" encoding="UTF8"?>
<methodCall>
 <methodName>config.delete</methodName>
  <params>
   <param>
    <value>
     <struct>
      <member>
       <name>path</name>
        <value>
         <string><![CDATA[xyz.com]]></string>
        </value>
       </member>
       <member>
        <name>type</name>
         <value>            
          <string>
           <![CDATA[mta_rbl_custom_name]]>
          </string>
         </value>
        </member>
       </struct>
     </value>
    </param>
 </params>
</methodCall>
Response
 OK <?xml version="1.0" encoding="UTF8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>Result</name>
       <value>
        <string>
         <![CDATA[200: OK]]>
        </string>
       </value>
      </member>
     </struct>
    </value>
   </param>
 </params>
</methodResponse>

Example 3: Delete a tied object and its tied variable values – domain scope

Delete the per-domain tied variable mta_sender_allow_address along with its tied variable values. This example deletes the  Allowed Email Address and Domains tied variable values 'test1.com' and 'test2.com' for the domain ‘barracuda.com’.

Arguments
  • type: 'mta_sender_allow_address'
  • path: 'barracuda.com'
Sample Request
 <?xml version="1.0" encoding="UTF8"?>
 <methodCall>
  <methodName>config.delete</methodName>
    <params>
      <param>
       <value>
        <struct>
          <member>
            <name>path</name>
             <value>
              <string><![CDATA[barracuda.com]]></string>
             </value>
            </member>
            <member>
             <name>type</name>
              <value>
              <string>
                 <![CDATA[domain]]>
              </string>
            </value>
          </member>
          <member>
            <name>variable</name>
                <value>
                   <string>
                    <![CDATA[mta_sender_allow_address]]>
                   </string>
               </value>
         </member>
         <member>
            <name>values</name>
                <value>
                 <array>
                     <data>
                       <value>
                        <string>
                        <![CDATA[test1.com]]>
                        </string>
                        </value>
                      <value>
                        <string>
                        <![CDATA[test2.com]]>
                        </string>
                      </value>
                     </data>
                </array>
              </value>
         </member>
       </struct>
     </value>
    </param>
 </params>
</methodCall>
Last updated on