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.
Barracuda Email Security Gateway

Config.remove

  • Last updated on

Use this method to remove the given value(s) from the list variable. This will not remove values from tied variables. For removing values from tied variables, use the config.delete method.

Parameters Allowed

The following parameters are used by the config.remove method and 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.
  • parent_type – A required parameter that tells the API about the class/scope of the parent container.

  • parent_path – A required parameter which is the qualified name of a parent object.

  • variable – A required parameter that specifies the variable for which values should be removed.

  • values – A required parameter specifying a list of values to be removed.

Example: Removing values from a variable under global scope

Removes host/domain name values 'mytrustedrelay1.com' and 'mytrustedrelay2.com from the mta_trusted_relay_host list. These Trusted Relay Host/Domain names are added or deleted on the ADVANCED > Outbound page in the web interface and represent trusted relays on the Barracuda Email Security Gateway.

Arguments
  • parent_type: 'global',
  • parent_path: ''
  • variable: 'mta_trusted_relay_host'
  • values: ['mytrustedrelay1.com', 'mytrustedrelay2.com']
Sample Request
 <?xml version="1.0" encoding="UTF8"?>
<methodCall>
 <methodName>config.remove</methodName>
  <params>
   <param>
    <value>
     <struct>
      <member>
       <name>parent_type</name>
        <value>
         <string>
          <![CDATA[global]]>
         </string>
        </value>
       </member>
       <member>
        <name>variable</name>
         <value>
          <string>
           <![CDATA[mta_trusted_relay_host]]>
          </string>
         </value>
       </member>
       <member>
        <name>values</name>
         <value>
          <array>
           <data>
            <value>
             <string>
              <![CDATA[mytrustedrelay1.com]]>
             </string>
            </value>
            <value>
             <string>
              <![CDATA[mytrustedrelay2.com]]>
             </string>
            </value>
           </data>
          </array>
         </value>
        </member>
        <member>
         <name>parent_path</name>
          <value>
           <string></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>
Last updated on