UniFi Network Application API #626

SinisterSpatula · 2023-04-16T22:52:21Z

Hello, the current UniFi code doesn't work well with UniFi Network Application due to specific differences in it's API:
the login route must use: /api/login (not /api/auth/login). The health route must use: /api/s/default/stat/health (not /proxy/network). There is no data for wan availability or lan availability on the health route (at least for my use case, I'm running the Network Application within an LXC container under proxmox). I found "uptime" available from route: /api/s/default/stat/sysinfo. I'm running UniFi Network Application ver 7.3.83 under linux (LXC).

The text was updated successfully, but these errors were encountered:

SinisterSpatula · 2023-04-16T23:31:23Z

output of /api/s/default/stat/health:

"data": [
    {
      "subsystem": "wlan",
      "num_user": 16,
      "num_guest": 0,
      "num_iot": 0,
      "tx_bytes-r": 625557,
      "rx_bytes-r": 12012,
      "status": "ok",
      "num_ap": 2,
      "num_adopted": 2,
      "num_disabled": 0,
      "num_disconnected": 0,
      "num_pending": 0
    },
    {
      "subsystem": "wan",
      "num_gw": 0,
      "num_adopted": 0,
      "num_disconnected": 0,
      "num_pending": 0,
      "status": "unknown"
    },
    {
      "subsystem": "www",
      "status": "unknown"
    },
    {
      "subsystem": "lan",
      "status": "unknown",
      "num_sw": 0,
      "num_adopted": 0,
      "num_disconnected": 0,
      "num_pending": 0
    },
    {
      "subsystem": "vpn",
      "status": "unknown"
    }
  ]
}

ouput of /api/s/default/stat/sysinfo:

"data": [
    {
      "timezone": "America/Chicago",
      "autobackup": false,
      "build": "atag_7.3.83_19645",
      "version": "7.3.83",
      "data_retention_days": 90,
      "data_retention_time_in_hours_for_5minutes_scale": 24,
      "data_retention_time_in_hours_for_hourly_scale": 168,
      "data_retention_time_in_hours_for_daily_scale": 2160,
      "data_retention_time_in_hours_for_monthly_scale": 8760,
      "data_retention_time_in_hours_for_others": 2160,
      "update_available": false,
      "update_downloaded": false,
      "live_chat": "super-only",
      "store_enabled": "super-only",
      "hostname": "example-domain.ui.com",
      "name": "x.home.arpa",
      "ip_addrs": [
        "10.x.x.x"
      ],
      "inform_port": 8080,
      "https_port": 8443,
      "override_inform_host": false,
      "image_maps_use_google_engine": false,
      "radius_disconnect_running": false,
      "facebook_wifi_registered": false,
      "sso_app_id": "redacted",
      "sso_app_sec": "redacted",
      "uptime": 81997,
      "anonymous_controller_id": "redacted",
      "has_webrtc_support": true,
      "debug_setting_preference": "auto",
      "debug_mgmt": "warn",
      "debug_system": "warn",
      "debug_device": "warn",
      "debug_sdn": "warn",
      "unsupported_device_count": 0,
      "unsupported_device_list": [],
      "unifi_go_enabled": false,
      "default_site_device_auth_password_alert": false
    }
  ]
}

SinisterSpatula · 2023-04-16T23:45:16Z

There is also:
/v2/api/site/default/network_status
with output of:

{
  "average_satisfaction": 98,
  "health": "excellent",
  "historical_satisfaction": [
    98,
    98,
    98,
    98,
    98,
    98,
    99,
    98,
    98,
    98,
    98,
    98
  ],
  "reasons": []
}

I think average_satisfaction would be a good one to report on.

vampywiz17 · 2023-07-20T13:00:05Z

@SinisterSpatula

I try to change API endpoints locally, now it connect it, but not get any data. with browser, i able to read the data that Heimdall want to show it.

igorkulman · 2023-07-24T09:33:58Z

Trying this also, changing the endpoint reports a successful login but I get no data changing the health endpoint. Looking at the code and the health endpoint data I would say everything expect for the uptime should work, the name of the properties (num_user, etc) look the same.

igorkulman · 2023-07-24T09:45:43Z

With a bit of trial an error I was able to get to this hardcoding $data['wan_avail'] = 100 changing $data['lan_users'] = isset($detail->num_user) ? $detail->num_user : 0 ; (I have no lan users so the property is missing)

here are my changes to ./config/www/SupportedApps/UniFi/UniFi.php

<?php namespace App\SupportedApps\UniFi;

/**
 * Implementation based on
 * https://ubntwiki.com/products/software/unifi-controller/api
 */
class UniFi extends \App\SupportedApps
{
	public $config;

	protected $method = 'POST';

	function __construct()
	{
		$this->jar = new \GuzzleHttp\Cookie\CookieJar;
	}

	public function test()
	{
		$test = parent::appTest(
			$this->url("/api/login"),
			$this->getLoginAttributes(),
        );

		echo $test->status;
	}

	public function livestats()
	{
		$status = "inactive";

		parent::execute(
			$this->url("/api/login"),
			$this->getLoginAttributes(),
			null,
			'POST'
		);

		$res = parent::execute(
			$this->url("/api/s/default/stat/health"),
			$this->getAttributes(),
			null,
			'GET'
		);

		$details = json_decode($res->getBody());

		$data = [];

		if (isset($details->data)) {
			$data['error'] = false;
			foreach ($details->data as $key => $detail) {
				if ($detail->subsystem === 'wlan') {
					$data['wlan_users'] = isset($detail->num_user) ? $detail->num_user : 0;
					$data['wlan_ap'] = isset($detail->num_ap) ? $detail->num_ap : 0;
					$data['wlan_dc'] = isset($detail->num_disconnected) ? $detail->num_disconnected : 0;
				}

				if ($detail->subsystem === 'lan') {
					$data['lan_users'] = isset($detail->num_user) ? $detail->num_user : 0;
				}

				if ($detail->subsystem === 'wan') {
					$data['wan_avail'] = 100; //$detail->uptime_stats->WAN->availability;
				}
			}
		} else {
			$data['error'] = true;
		}

		return parent::getLiveStats($status, $data);
	}

	public function url($endpoint)
	{
		$url = parse_url(parent::normaliseurl($this->config->url));
		$scheme = $url["scheme"];
		$domain = $url["host"];
		$port = isset($url["port"]) ? $url["port"] : "443";

		$api_url =
			$scheme .
			"://" .
			$domain .
			":" .
			$port .
			$endpoint;

		return $api_url;
	}

	public function getConfigValue($key, $default = null)
	{
		return isset($this->config) && isset($this->config->$key)
			? $this->config->$key
			: $default;
	}

	public function getLoginAttributes()
	{
		$ignoreTls = $this->getConfigValue("ignore_tls", false);
		$username = $this->config->username;
		$password = $this->config->password;

		$body = [
			"username" => $username,
			"password" => $password,
		];

		$attrs = [
			"body" => json_encode($body),
			"cookies" => $this->jar,
			"headers" => [
				"Content-Type" => "application/json"
			]
		];

		if ($ignoreTls) {
			$attrs["verify"] = false;
		}

		return $attrs;
	}

	public function getAttributes()
	{
		$attrs = [
			"cookies" => $this->jar,
		];

		$ignoreTls = $this->getConfigValue("ignore_tls", false);

		if ($ignoreTls) {
			$attrs["verify"] = false;
		}

		return $attrs;
	}
}

igorkulman · 2023-07-24T10:03:08Z

@vampywiz17 @SinisterSpatula

I think I fixed it completly, try this, seems to work for me fine

<?php namespace App\SupportedApps\UniFi;

/**
 * Implementation based on
 * https://ubntwiki.com/products/software/unifi-controller/api
 */
class UniFi extends \App\SupportedApps
{
	public $config;

	protected $method = 'POST';

	function __construct()
	{
		$this->jar = new \GuzzleHttp\Cookie\CookieJar;
	}

	public function test()
	{
		$test = parent::appTest(
			$this->url("/api/login"),
			$this->getLoginAttributes(),
        );

		echo $test->status;
	}

	public function livestats()
	{
		$status = "inactive";

		parent::execute(
			$this->url("/api/login"),
			$this->getLoginAttributes(),
			null,
			'POST'
		);

		$res = parent::execute(
			$this->url("/api/s/default/stat/health"),
			$this->getAttributes(),
			null,
			'GET'
		);

               $res_sat = parent::execute(
			$this->url("/v2/api/site/default/network_status"),
			$this->getAttributes(),
			null,
			'GET'
		);

		$details = json_decode($res->getBody());
                $details_sat = json_decode($res_sat->getBody());

		$data = [];

		if (isset($details->data)) {
			$data['error'] = false;
			foreach ($details->data as $key => $detail) {
				if ($detail->subsystem === 'wlan') {
					$data['wlan_users'] = isset($detail->num_user) ? $detail->num_user : 0;
					$data['wlan_ap'] = isset($detail->num_ap) ? $detail->num_ap : 0;
					$data['wlan_dc'] = isset($detail->num_disconnected) ? $detail->num_disconnected : 0;
				}

				if ($detail->subsystem === 'lan') {
					$data['lan_users'] = isset($detail->num_user) ? $detail->num_user : 0;
				}
			}
		} else {
			$data['error'] = true;
		}

               $data['wan_avail'] = isset($details_sat->average_satisfaction) ? $details_sat->average_satisfaction : 0;

		return parent::getLiveStats($status, $data);
	}

	public function url($endpoint)
	{
		$url = parse_url(parent::normaliseurl($this->config->url));
		$scheme = $url["scheme"];
		$domain = $url["host"];
		$port = isset($url["port"]) ? $url["port"] : "443";

		$api_url =
			$scheme .
			"://" .
			$domain .
			":" .
			$port .
			$endpoint;

		return $api_url;
	}

	public function getConfigValue($key, $default = null)
	{
		return isset($this->config) && isset($this->config->$key)
			? $this->config->$key
			: $default;
	}

	public function getLoginAttributes()
	{
		$ignoreTls = $this->getConfigValue("ignore_tls", false);
		$username = $this->config->username;
		$password = $this->config->password;

		$body = [
			"username" => $username,
			"password" => $password,
		];

		$attrs = [
			"body" => json_encode($body),
			"cookies" => $this->jar,
			"headers" => [
				"Content-Type" => "application/json"
			]
		];

		if ($ignoreTls) {
			$attrs["verify"] = false;
		}

		return $attrs;
	}

	public function getAttributes()
	{
		$attrs = [
			"cookies" => $this->jar,
		];

		$ignoreTls = $this->getConfigValue("ignore_tls", false);

		if ($ignoreTls) {
			$attrs["verify"] = false;
		}

		return $attrs;
	}
}

vampywiz17 · 2023-07-24T22:09:44Z

@igorkulman thanks!

gitterdoneplease · 2023-07-25T21:25:07Z

Works perfectly. Thanks. Will this get pulled into the source?

igorkulman · 2023-07-26T08:25:12Z

Thanks for testing, I have opened a PR with this #645

nerakhon · 2023-07-26T08:40:18Z

Have you guys tested this with a UDM or other unifi HW? Because per my PR, the only problem there was the decimals. (I am running the lastest firmware). I will test your code against my UDM, to see if there is really a difference between the appliance and the real HW.

igorkulman · 2023-07-26T11:09:58Z

I only tested in my home setup which is Unifi Controller 7.4.162 running in a docker container on Linux.

adam-rudd · 2023-09-08T14:28:47Z

I only tested in my home setup which is Unifi Controller 7.4.162 running in a docker container on Linux.

Can you quote exactly what goes in the enhanced api url field? I have this right now: "https://192.168.40.2/api/login" Says API successful but no stats

igorkulman · 2023-09-12T12:35:57Z

Can you quote exactly what goes in the enhanced api url field? I have this right now: "https://192.168.40.2/api/login" Says API successful but no stats

just https://192.168.1.187:8443

livioh · 2023-10-15T22:46:42Z

I've try that, still can't get it to connect?

gavinmcfall · 2023-11-08T22:33:36Z

Hello,
I am also experiencing this issue.
Heimdall v2.5.7
Unfi UDM Pro OS v3.1.16
Unifi Network v7.5.187

I tried editing the ./config/www/SupportedApps/UniFi/UniFi.php
With the fix from https://github.com/igorkulman from July 25th

gavinmcfall · 2023-11-09T00:16:03Z

I got this to work. here are the steps I took.

First I changed the PHP file in my heimdall container (/config/www/SupportedApps/UniFi/UniFi.php)
I copied the code provided by @igorkulman above.
Then I edited the file and changed the URL Paths because I have a UDM Pro. It stipulated here that the endpoint are different: https://ubntwiki.com/products/software/unifi-controller/api
After changing the paths in the PHP file I was still getting errors and moved over to testing in Postman.
That is when I discovered that the API still expects 2fa...
So I logged into my UniFi OS console and created a new user
Set the user to "restrict to local access only = true"
Give it a username and password
Untick the pre-defined role and set all to "View Only"
Save and go back to heimdall and change the username and password in the config
Ensure the URL in the config looks like this: https://10.90.254.1/
Don't add ports or anything, the application uses 443 so its not needed.

ZoltrixGFC · 2024-01-07T07:04:38Z

@igorkulman fix also worked for me. Pity it isn't being rolled into the official Heimdall release. I guess when updating to a newer version of Heimdal in the future, it will break again?

mvdkleijn · 2024-01-23T14:00:22Z

@ZoltrixGFC The reason its not being rolled into the official release is likely because the fix appears incomplete. It would break things for people with UDM. (based on comment from @gavinmcfall ) In other words: it needs work.

ZoltrixGFC · 2024-01-24T02:23:16Z

@mvdkleijn all good, I think maybe it has already been rolled in. The last update to Heimdall didn't remove the changes.

mvdkleijn · 2024-01-24T07:53:11Z

Then I'll close this issue if no-one objects. Feel free to comment if that's a problem, I'll reopen.

neocharles · 2024-04-03T19:45:13Z

For what It's worth, I am running Heimdall 2.6.1 and I had to perform the fix listed above in order for the API to connect. Unifi Controller Network 8.0.26 and 8.1.113

obriencj · 2024-07-22T18:30:05Z

Maybe this could just be split out so that UniFi Network is one type (with this fix) and UniFi remains the old Controller type (ie. without this fix) ?

zaepho · 2024-11-03T19:37:13Z

Maybe this could just be split out so that UniFi Network is one type (with this fix) and UniFi remains the old Controller type (ie. without this fix) ?

or a checkbox to select which type you're running
or some form of automatic detection

I am having to revert these changes to connect to my self hosted Unifi controller but would prefer to stay vanilla.

zaepho · 2024-11-03T21:56:08Z

I created a PR #798 for the above (added a config switch for Self Hosted controllers).

keriati transferred this issue from linuxserver/Heimdall Apr 26, 2023

vampywiz17 mentioned this issue Jul 21, 2023

Unifi - Failed: Invalid credentials #640

Open

igorkulman mentioned this issue Jul 26, 2023

Fix Unifi data retrieval #645

Closed

mvdkleijn closed this as completed Jan 24, 2024

aptalca moved this from Non-Docker Issues to Done in Issue & PR Tracker Feb 18, 2024

gitterdoneplease mentioned this issue Feb 23, 2024

UniFI app does not show any statistics; test button shows invalid credentials #695

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UniFi Network Application API #626

UniFi Network Application API #626

SinisterSpatula commented Apr 16, 2023 •

edited

Loading

SinisterSpatula commented Apr 16, 2023

SinisterSpatula commented Apr 16, 2023

vampywiz17 commented Jul 20, 2023

igorkulman commented Jul 24, 2023

igorkulman commented Jul 24, 2023 •

edited

Loading

igorkulman commented Jul 24, 2023

vampywiz17 commented Jul 24, 2023

gitterdoneplease commented Jul 25, 2023

igorkulman commented Jul 26, 2023

nerakhon commented Jul 26, 2023

igorkulman commented Jul 26, 2023

adam-rudd commented Sep 8, 2023

igorkulman commented Sep 12, 2023

livioh commented Oct 15, 2023

gavinmcfall commented Nov 8, 2023

gavinmcfall commented Nov 9, 2023

ZoltrixGFC commented Jan 7, 2024

mvdkleijn commented Jan 23, 2024

ZoltrixGFC commented Jan 24, 2024

mvdkleijn commented Jan 24, 2024

neocharles commented Apr 3, 2024

obriencj commented Jul 22, 2024

zaepho commented Nov 3, 2024

zaepho commented Nov 3, 2024

UniFi Network Application API #626

UniFi Network Application API #626

Comments

SinisterSpatula commented Apr 16, 2023 • edited Loading

SinisterSpatula commented Apr 16, 2023

SinisterSpatula commented Apr 16, 2023

vampywiz17 commented Jul 20, 2023

igorkulman commented Jul 24, 2023

igorkulman commented Jul 24, 2023 • edited Loading

igorkulman commented Jul 24, 2023

vampywiz17 commented Jul 24, 2023

gitterdoneplease commented Jul 25, 2023

igorkulman commented Jul 26, 2023

nerakhon commented Jul 26, 2023

igorkulman commented Jul 26, 2023

adam-rudd commented Sep 8, 2023

igorkulman commented Sep 12, 2023

livioh commented Oct 15, 2023

gavinmcfall commented Nov 8, 2023

gavinmcfall commented Nov 9, 2023

ZoltrixGFC commented Jan 7, 2024

mvdkleijn commented Jan 23, 2024

ZoltrixGFC commented Jan 24, 2024

mvdkleijn commented Jan 24, 2024

neocharles commented Apr 3, 2024

obriencj commented Jul 22, 2024

zaepho commented Nov 3, 2024

zaepho commented Nov 3, 2024

SinisterSpatula commented Apr 16, 2023 •

edited

Loading

igorkulman commented Jul 24, 2023 •

edited

Loading