v5.1.3 Android Client

[Filipp Sudanov]

New Android client uses new WEB API that is a server module. 

Quick setup guide:

• add "Module=webapi,Y" to netxmsd.conf, module listens on port 8000 by default. You can change it:
  [WEBAPI]
  ListenerPort=12345

Please note, it's unencrypted HTTP!

• add nginx, reproxy, traefic - or any other ssl offloading app in front of it.
• connect to the APi endpoint.

But for testing you can skip this and just use HTTP

[cserzs]

Thank you Filipp,

If I add the "Module=webapi,Y" line to the \\NetXMS\etc\netxmsd.conf file, the NetXMS core service always stops and cannot be run.

best regards, Zsolt

[alk]

what's in the logs? Also ",Y" is not required anymore, it's default now.
Which version of the server you are using?

[cserzs]

Hi Alex, I use the latest 5.2.3 version. I will check the logs ASAP. 
Best regards, Zsolt

[cserzs]

Hi Alex,

The following information about the failed NetXMS core startup is in the netxmsd.log:

2025.07.09 19:56:22.642 *I* [logger            ] Log file opened (rotation policy 2, max size 16777216)
2025.07.09 19:56:22.642 *I* [startup            ] Starting NetXMS server version 5.2.3 build tag 5.2-345-g0ca84eba5b
2025.07.09 19:56:22.642 *I* [startup            ] System time zone is KXX+02KXX
2025.07.09 19:56:22.642 *I* [logger            ] Debug level set to 0
2025.07.09 19:56:22.642 *I* [config            ] Main configuration file: C:\NetXMS\etc\netxmsd.conf
2025.07.09 19:56:22.642 *I* [config            ] Configuration tree:
2025.07.09 19:56:22.642 *I* [config            ] config
2025.07.09 19:56:22.642 *I* [config            ]  +- server
2025.07.09 19:56:22.642 *I* [config            ]      +- DBDriver
2025.07.09 19:56:22.642 *I* [config            ]      |    value: pgsql.ddr
2025.07.09 19:56:22.642 *I* [config            ]      +- DBServer
2025.07.09 19:56:22.642 *I* [config            ]      |    value: localhost
2025.07.09 19:56:22.642 *I* [config            ]      +- DBName
2025.07.09 19:56:22.642 *I* [config            ]      |    value: netxms_db
2025.07.09 19:56:22.642 *I* [config            ]      +- DBLogin
2025.07.09 19:56:22.642 *I* [config            ]      |    value: netxms
2025.07.09 19:56:22.642 *I* [config            ]      +- DBPassword
2025.07.09 19:56:22.642 *I* [config            ]      |    value: ********
2025.07.09 19:56:22.642 *I* [config            ]      +- LogFile
2025.07.09 19:56:22.642 *I* [config            ]      |    value: C:\NetXMS\log\netxmsd.log
2025.07.09 19:56:22.642 *I* [config            ]      +- Module
2025.07.09 19:56:22.642 *I* [config            ]      |    value: webapi,Y
2025.07.09 19:56:22.642 *I* [config            ]      +- ListenerPort
2025.07.09 19:56:22.642 *I* [config            ]          value: 8000
2025.07.09 19:56:22.644 *I* [startup            ] System hardware ID 29BD12835A0F6AC5ECC19D4AF52693A9320DC403
2025.07.09 19:56:22.650 *I* [db.drv            ] Database driver "pgsql.ddr" loaded and initialized successfully
2025.07.09 19:56:22.651 *I* [comm.listener      ] SocketListener/LocalAdmin: listening on 127.0.0.1:21784
2025.07.09 19:56:22.651 *I* [comm.listener      ] SocketListener/LocalAdmin: listening on [127.0.0.1]:21784
2025.07.09 19:56:23.308 *I* [startup            ] Server ID 33C6C28F00000029
2025.07.09 19:56:23.331 *I* [db.writer          ] DBWriter/Housekeeper interlock is OFF
2025.07.09 19:56:23.334 *I* [crypto            ] Crypto library initialized (OpenSSL 3.0.15 3 Sep 2024)
2025.07.09 19:56:23.334 *I* [crypto.cert        ] Server certificate not set
2025.07.09 19:56:23.334 *I* [crypto.cert        ] Internal CA certificate not set
2025.07.09 19:56:23.423 *I* [macdb              ] OUI-24 database loaded (32548 entries)
2025.07.09 19:56:23.430 *I* [macdb              ] OUI-28 database loaded (4403 entries)
2025.07.09 19:56:23.437 *I* [macdb              ] OUI-36 database loaded (5046 entries)
2025.07.09 19:56:23.443 *E* [modules            ] Unable to load module "webapi" (The specified module cannot be found.)

Without the ",Y" the result is the same.

best regards, Zsolt

[alk]

Looks like webapi module was not packaged in 5.1. I recommend you to upgrade to latest (5.2.4 at the moment) version.

[cserzs]

I upgraded my server from v5.2.3 to v5.2.4, but unfortunately the situation has not changed.
If I add the line "Module = webapi" to the netxmsd.conf file, the NetXMS core service will no longer start.

[alk]

Do you install from packages or build from source?

[cserzs]

Hi Alex,

I used the netxms-server-5.2.4-x64.exe file for the upgrade, as my system has less than 250 nodes.
Another experience is that the netxms-webui-5.2.4-x64.exe cannot be downloaded from the https://netxms.com/downloads page.

Best regard, Zsolt

[Filipp Sudanov]

Yes, looks that there's still a bug with webapi packaging, will check with developers. 
Webui should now be available for download (but, just in case, you can use any 5.2 webui or desktop ui with 5.2.4)

[cserzs]

Hi Filipp,

Thank you in advance. Is there a chance that the problem will be fixed in the next version?

BR, Zsolt

[alk]

It's fixed in upcoming 5.2.5

[cserzs]

Hi Alex,

I upgraded to version 5.2.5. Then, when I added the line "Module=webapi" to the \\NetXMS\etc\netxmsd.conf file, the core NetXMS service
started without any problem (it always stopped with the previous version).
Despite this, unfortunately, the mobile app still does not connect to the server (error code: 404).
I access the server from my mobile phone via a VPN connection.
What is the syntax of the "Hostname or IP" parameter in the mobile app?

BR, Zsolt

[Filipp Sudanov]

The syntax is URL-like
http://hostname:port or http://IP:port

It's adviced to put e.g. nginx as reverse proxy to add ssl (then url would obviously by https://), but if you use VPN you are good with just http

[alk]

@cserzs said in v5.1.3 Android Client:

What is the syntax of the "Hostname or IP" parameter in the mobile app?

You can check if endpoint is correct - it should return information about the API itself, something like:

{"description": "NetXMS web service API", "version": "5.2.3.21", "build": "5.2-366-g15daea330f", "apiVersion": 1}⏎

[cserzs]

Hi,

Thank you for your support.
Can this webapi test be performed in a browser, e.g. with the URL "http://ipaddress:port/webapi"?
I tried this, but unfortunately I didn't get any results.

If I enter the Hostname or IP parameter in the format http://ipaddress:port in the Android app, I get an error code 500.

[WSallade]

Have exact same issue. v5.2.6 on Debian, getting error 500 with Android app. 

Have webapi module loaded and get http://<server ip>:8000 returns "{"description": "NetXMS web service API", "version": "5.2.6", "build": "5.2-443-ge9a696f0c2", "apiVersion": 1}", so this looks good.

[Filipp Sudanov]

Can you capture network traffic on server's 8000 port using tcpdump (tcpdump -s 0 -w snmp.pcap port 8000) or Wireshark if you are on Windows.
You can send resulting file to me via private message.

Also check netxmsd log, may be there are some error messages there.

[tolimanjo]

I was getting the '500' error from the client when using HTTP, and a packet capture showed HTTPS style connection attempts to the server. Perhaps Android was trying to be helpful?
Anyway, putting an HTTPS-HTTP proxy in front of the server (and specifying https:// on the client) fixed the problem.

[alk]

@tolimanjo said in v5.1.3 Android Client:

I was getting the '500' error from the client when using HTTP, and a packet capture showed HTTPS style connection attempts to the server. Perhaps Android was trying to be helpful?
Anyway, putting an HTTPS-HTTP proxy in front of the server (and specifying https:// on the client) fixed the problem.

if protocol is not specified in the connection string, https:// is added.