User manual BARRACUDA VIRUS FIREWALL 4.0 API GUIDE

[. . . ] Version 4. x - 4. x Barracuda Spam & Virus Firewall API Guide Barracuda Networks Inc. Winchester Blvd Campbell, CA 95008 http://www. barracuda. com Copyright Notice Copyright 2010, Barracuda Networks www. barracudanetworks. com v5x-101210-01-1210 All rights reserved. Information in this document is subject to change without notice. Trademarks Barracuda Spam & Virus Firewall is a trademark of Barracuda Networks. All other brand and product names mentioned in this document are registered trademarks or trademarks of their respective holders Barracuda Spam & Virus Firewall 4. x API Guide 2 Contents How the Barracuda API Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [. . . ] The example below is a request for a list of domains configured as Accepted Email Recipient Domain(s) on the Barracuda Spam & Virus Firewall, which can be set from the BASIC > IP Configuration page in the Web UI and which are stored in the configuration database in the mta_relay_domain variable. Here's a snapshot of the configuration file as viewed in Windows NotePad: mta_relay_domain = domain1. com<cr>domain2. com<cr>domain3. com # Email Address For Testing mta_relay_email = myemail@barracudanetworks. com # Default Relay Mail Server mta_relay_host = 216. 129. 105. 115 # Default Relay Mail Server Port mta_relay_port = 25 The response may include multiple values, returned as an array inside the <array> tag. The format of the response body looks like this, returning three (domain name) values: OK <?XML version="1. 0" encoding="UTF8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>mta_relay_domain</name> <value> <array> <data> <value> <string>domain1. com</string> </value> <value> <string>domain2. com</string> </value> <value> <string>domain3. com</string> </value> </data> </array> </value> </member> </struct> </value> </param> </params> </methodResponse> Barracuda Spam & Virus Firewall 4. x API Guide 9 Error Response Error responses use the XML-RPC faultCode and faultString format. The error code will be the value of the faultCode member and the error string will be the value of the faultString member. See the Appendix 1 for a list of faultCodes and descriptions of possible errors. Here's an example of an error response: OK <?XML version="1. 0"?> <methodResponse> <fault> <value> <struct> <member> <name>faultCode</name> <value><i4>500</4></value> </member> <member> <name>faultString</name> <value> <string>No such variable in configuration</string> </value> </member> </struct> </value> </fault> </methodResponse> Barracuda Spam & Virus Firewall 4. x API Guide 10 General APIs The API interfaces presented in this section are general in that they are applicable to the Barracuda Spam & Virus Firewall as well as to other Barracuda Networks appliances. The examples presented here are specific to the Barracuda Spam & Virus Firewall. Config. get Use this method to retrieve values of variables in the system configuration. If the variable requested has only a single value (Spam Tag Configuration Subject Tag level, for example), the output will be different than the output for a variable that contains a list (users, domains, etc. ). This method gets the value of the variable in the object of $type named $path. The return $value is a reference to an array if it is multi-valued, i. e. Refer to the example in Single Value Response above for getting a variable with a single value and to Multi-value Response above for getting a variable that contains a list. Arguments to the method can be specified by just adding the parameter in the XML request. Parameters Allowed: The following variables are used with the config. get method. These variables should be provided as part of the request XML in the HTTP POST request. variable :: A required parameter that tells the API which variable to return. 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 specifies the class/scope of a variable. path :: A required parameter that is the qualified name of an object for which the value is required. Note that the value for path is an empty string for getting a variable under global scope. Example 1: Get the value of a variable under global scope Get the value of a variable, scana_subject_tag in this case, under global scope. This example will return the Subject Tag string to be inserted by the Barracuda Spam & Virus Firewall in the subject of a message determined to be spam. This setting is configured from the BASIC > Spam Checking page for the global setting. Note that the path value is an empty string since the scope, or type, is global. [. . . ] variable :: A required parameter that specifies the variable for which attributes are required. Example: List the attributes and their values for global Block level. This example lists the attributes of global blocking: min level, max level, current setting, etc. and returns the current value for each attribute. Barracuda Spam & Virus Firewall 4. x API Guide 37 Sample Request: <?xml version="1. 0" encoding="UTF8"?> <methodCall> <methodName>config. var_attr</methodName> <params> <param> <value> <struct> <member> <name>variable</name> <value> <string> <![CDATA[scana_block_level]]> </string> </value> </member> </struct> </value> </param> </params> </methodCall> Response: OK <?xml version="1. 0" encoding="UTF8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>scana_block_level</name> <value> <struct> <member> <name>min</name> <value> <string></string> </value> </member> <member> <name>max</name> <value> <string></string> </value> </member> <member> <name>default</name> <value> <i4>7</i4> </value> </member> <member> <name>description</name> <value> <string> <![CDATA[Spam Block Level]]> </string> </value> </member> <member> <name>choices</name> Barracuda Spam & Virus Firewall 4. x API Guide 38 <value> <array> <data/> </array> </value> </member> <member> <name>required</name> <value> <i4>1</i4> </value> </member> <member> <name>class</name> <value> <string> <![CDATA[global]]> </string> </value> </member> <member> <name>type</name> <value> <string> <![CDATA[float]]> </string> </value> </member> </struct> </value> </member> </struct </value> </param> </params> </methodResponse> Barracuda Spam & Virus Firewall 4. x API Guide 39 APIs for the Barracuda Spam & Virus Firewall Creating a block of new user accounts or domains, deleting one or more of each, listing user accounts and updating user-level spam score or quarantine inbox settings are some of the remote configuration capabilities presented here for the Barracuda Spam & Virus Firewall. User. create This method creates a user account for the user as specified. Parameters Allowed: 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. [. . . ]