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.list

  • Last updated on

This method lists the children of child_type ('domain', in this case) under the object parent_path of type 'parent_type'.

Parameters Allowed

The following variables are used by the config.list 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.
  • type – A required parameter that tells the API about the class/scope of the parent container.
  • path – A required parameter that is the qualified name of a parent object. Note that the value for path is an empty string for getting a variable under global scope.
  • child_type – A required parameter that specifies the child class/scope to list.

Example 1: List all valid domains  

List all the children of type 'domain' under scope 'global'. This call returns a list of all domains for which the Barracuda Email Security Gateway will accept email, and which can be created and viewed from the DOMAINS page of the web interface. Each instance of the child_type (domain) appears in the configuration like this:

  • #scope:<domain>::scope_data: = 'thisdomain.net'
  • #scope:<domain>::scope_data = 'barracuda.com'
Arguments
  • type: 'global'
  • path: ''
  • child_type: 'domain'
Sample Request
  <?xml version="1.0" encoding="UTF8"?>
<methodCall>
 <methodName>config.list</methodName>
  <params>
   <param>
    <value>
     <struct>
      <member>
      <name>child_type</name>
       <value>  
        <string>
         <![CDATA[domain]]>
        </string>
       </value>
      </member>
      <member>
       <name>path</name>
        <value>
         <string></string>
        </value>
       </member>
       <member>
        <name>type</name>
         <value>
          <string>
          <![CDATA[global]]>
         </string>
        </value>
       </member>
     </struct>
    </value>
   </param>
 </params>
</methodCall>
Response
 OK <?xml version="1.0" encoding="UTF8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <array>
     <data>
      <value>
       <string>
        <![CDATA[thisdomain.net]]>
       </string>
      </value>
      <value>
        <string>
         <![CDATA[barracuda.com]]>
        </string>
       </value>
       </data>
      </array>
     </value>
   </param>
 </params>
</methodResponse>

Example 2: List of tied objects - all custom RBLs

This example lists all values for the tied object mta_rbl_custom_name, under global scope. Custom RBLs are created from the web interface on the BLOCK/ACCEPT > IP Reputation page and have an associated action of Block, Tag or Quarantine. In the configuration, the three RBLs configured in this example would appear like this:

  • # Custom RBL List
  • mta_rbl_custom_name = sbl.spamblocklist.org
  • xbl.spamblocklist.org
  • sbl.org
Arguments
  • type: 'global'
  • path: ''
  • child_type: 'mta_rbl_custom_name'
Sample Request
 <?xml version="1.0" encoding="UTF8"?>
<methodCall>
<methodName>config.list</methodName>
<params>
 <param>
  <value>
   <struct>
    <member>
     <name>child_type</name>
      <value>
       <string>
        <![CDATA[mta_rbl_custom_name]]>
        </string>
      </value>
     </member>
    <member>
     <name>path</name>
      <value>
       <string></string>
      </value>
    </member>
    <member>
     <name>type</name>
      <value>
       <string>
        <![CDATA[global]]>
       </string>
      </value>
    </member>
   </struct>
  </value>
 </param>
</params>
</methodCall>
Response
 OK <?xml version="1.0" encoding="UTF8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <array>
     <data>
      <value>
       <string>
        <![CDATA[sbl.spamblocklist.org]]>
       </string>
      </value>
      <value>
       <string>
        <![CDATA[xbl.spamblocklist.org]]>
       </string>
      </value>
      <value>
       <string>
        <![CDATA[sbl.org]]>
       </string>
      </value>
     </data>
    </array>
   </value>
  </param>
</params>
</methodResponse>
Last updated on