New Sophos Support Phone Numbers in Effect July 1st, 2023

Sophos XG API

As per this article:

is seems i can get the ip host objects if i can do something like: admin</Username><Password>abcd</Password></Login><Get><IPHost><Name></Name><IPFamily></IPFamily><HostType></HostType><IPAddress></IPAddress></IPHost></Get></Request>

Those articles are note very helpful:

This provides a very useful way of doing some things in an programable/automated way. 

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/> </System> </Get> </Request> </Request>

however i get: 

<Status code">529">Input request file is Invalid</Status>
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?

Added TAGs
[edited by: Erick Jan at 11:56 PM (GMT -7) on 17 May 2023]
Parents Reply Children
  • did the answer above not allow you to get firmware version?

    <Request APIVersion="X.X">

    XML Response
    <OSVersion>XX.XX.X build XXX</OSVersion>
    <UpTime>XX day(s), XX hour(s), XX minutes</UpTime>


    worlds number one free ICMP monitoring platform:

  • Hi Ryan,

    Thanks for your question.

    I am not able to retrieve the info. 

    <?xml version="1.0" encoding="UTF-8"?>
    <Response APIVersion="1905.1" IPS_CAT_VER="0">
            <status>Authentication Successful</status>
    I was wondering if anyone was successful?