Sophos XG API

Question

As per this article: https://doc.sophos.com/nsg/sophos-firewall/18.5/help/en-us/webhelp/onlinehelp/AdministratorHelp/BackupAndFirmware/API/APIUsingAPI/index.html is seems i can get the ip host objects if i can do something like: 1.1.1.1:4444/.../APIController adminabcd Those articles are note very helpful: https://doc.sophos.com/nsg/sophos-firewall/18.5/help/en-us/webhelp/onlinehelp/AdministratorHelp/BackupAndFirmware/API/APIUsingAPI/index.html#get-add-update-or-delete-an-ip-host This provides a very useful way of doing some things in an programable/automated way. https://docs.sophos.com/nsg/sophos-firewall/18.5/API/index.html But i need to start with the basics: How do i get the objects and how do i know where they are located? for example the following should retrive the firmware version: < Request > < Get > < System > < FirmwareVersion /> however i get: 529 " > Input request file is Invalid I would very much like the documentation for this. I Need to know how to get all the objects form the firewall: firmware version, firewall rules, a single firewall rule(eg: rule 79), web exceptions, a single web exception, live users, pretty much anything that i can click on GUI. Can anyone help? Thanks, Dragos

Vivek Jagad · Accepted Answer

Hello Dragos Avram1 , To retrieve the device info: XML Request XXXXX XXXXX Request Parameter Description > APIVersion – Specify API version. Only valid API versions will get an appropriate response. > UserName – Specify SFM administrator user name. Default administrator user name is ‘admin’. > Password – Specify SFM admin user password. Default administrator password is ‘admin’ XML Response XXXXXXXXXXXXXXXXX XXX XX.XX.X build XXX XX day(s), XX hour(s), XX minutes X X.X.X.X True Response Parameter Description > ApplianceKey – Unique serial number > Model – SFM device model name > OSVersion – SFM firmware version > UpTime – Time since the SFM device is up > ManagedApplianceCount – Number of devices managed by SFM > Gateway – Gateway details o IP address of gateway o Status – Status of gateway > Connected > Disconnected

LuCar Toni · Answer

You could give Factory a try to check the predefined SFOS modules there: www.sophos.com/.../free-trial

Michael Dunn · Answer

https://docs.sophos.com/nsg/sophos-firewall/19.5/API/index.html For configuration I find the easiest way to get the list of objects is to go to Import/Export and then Export Selective Configuration. You'll get the list of all the objects there that are used in configuration. Those same ones you can use in <GET> in the API.

Sophos XG API

Top Replies