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. Use of this product and this manual is subject to license. Information in this document is subject to change without notice. Trademarks Barracuda Spam & Virus Firewall is a trademark of Barracuda Networks. [. . . ] 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. Arguments: type: 'global' path: '' variable: scana_subject_tag' Barracuda Spam & Virus Firewall 4. x API Guide 11 Sample Request: <?XML version="1. 0" encoding="UTF8"?> <methodCall> <methodName>config. get</methodName> <params> <param> <value> <struct> <member> <name>variable</name> <value> <string><![CDATA[scana_subject_tag]]> </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> <string><![CDATA[Block]]></string> </value> </param> </params> </methodResponse> Example 2: Get the value of a per-domain setting This example gets the value of the Spam Scoring Limit block level, scana_pd_block_level, for domain perftest. spamqa. net. In the configuration backup file, this variable is listed like this: # Domain Spam Block Score scana_pd_block_level = 5 Arguments: type: 'domain' path: 'perftest. spamqa. net' variable: 'scana_pd_block_level' Barracuda Spam & Virus Firewall 4. x API Guide 12 Sample Request: <?XML version="1. 0" encoding="UTF8"?> <methodCall> <methodName>config. get</methodName> <params> <param> <value> <struct> <member> <name>variable</name> <value> <string> <![CDATA[scana_pd_block_level]]> </string> </value> </member> <member> <name>path</name> <value> <string> <![CDATA[perftest. spamqa. net]]> </string> </value> </member> <member> <name>type</name> <value> <string><![CDATA[domain]]></string> </value> </member> </struct> </value> </param> </params> </methodCall> Response: OK <?XML version="1. 0" encoding="UTF8"?> <methodResponse> <params> <param> <value> <i4>5</i4> </value> </param> </params> </methodResponse> Config. get - tied variable examples The config. get method can also be used to get the values of variables that are dependent upon, or "tied to" other variables. Example 1: Get the value of a global tied variable This example gets the netmask value, httpd_acl_ip_config_netmask, tied to the Allowed SNMP and API IP/Range value, httpd_acl_ip_config_address, set on the BASIC > Administration page. [. . . ] user :: A required parameter that specifies the user account to be created. Arguments: user: test@xyz. com Sample Request: <?xml version="1. 0" encoding="UTF8"?> <methodCall> <methodName>user. create</methodName> <params> <param> <value> <struct> <member> <name>user</name> <value> <string> <![CDATA[test@xyz. com]]> </string> </value> </member> </struct> </value> </param> </methodCall> Response: OK <?xml version="1. 0" encoding="UTF8"?> <methodResponse> <params> <param> <value> Barracuda Spam & Virus Firewall 4. x API Guide 40 <struct> <member> <name>Result</name> <value> <string> <![CDATA[200: OK]]> </string> </value> </member> </struct> </value> </param> </params> </methodResponse> User. list This method simply lists all the user accounts currently on the system. Parameters Allowed: The following variable 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. Sample Request: <?xml version="1. 0" encoding="UTF8"?> <methodCall> <methodName>user. list</methodName> <params> <param> <value> <struct/> </value> </param> </params> </methodCall> Response: OK <?xml version="1. 0" encoding="UTF8"?> <methodResponse> <params> <param> <value> <array> <data> <value> <string> <![CDATA[test@xyz. com]]> </string> </value> <value> <string> <![CDATA[test@perftest. spamqa. net]]> </string> </value> Barracuda Spam & Virus Firewall 4. x API Guide 41 </data> </array> </value> </param> </params> </methodResponse> User. remove Use this method to remove a user account for the user as specified. The output of a successful call is a simple `200 OK'. [. . . ]