UniFi-API-client

A PHP API client class to interact with Ubiquiti's UniFi Controller API

Runs with mockssource: GitHubPHPMITcommit ce7e6c84a058

PHP, MIT licensed. The project labels itself: api, api client, class, client, controller, curl, php and ubiquiti.

UniFi-API-client runs, with stand-ins for the services it depends on. An Argusic agent installed it in 3 minutes and hit 2 errors and fixed every one without help on a clean machine with no GPU, and the whole session was recorded.

Library installs via composer, autoloads, and the Client class authenticates (password and API key), lists sites, lists usergroups, and reads sysinfo against a mock controller returning valid JSON responses.

What the agent ended up with on a clean machine, in its own words. How this is measured

Measured by Argusic on a fresh machine every time. Every number links to its evidence. Argusic Score 92 of 100 (the mean of this project's run scores).

At a glance

verdict
Runs with mocks
Argusic Score
92 / 100
cost of the verifying run
$0.12 (measured)
recorded runs
1
last tested
stars
1,349
forks
240
open issues
7
watchers
64
size
1 MB
created
last push

Subject data from GitHub, linked at the top of this page, refreshed . Test data by Argusic (CC BY 4.0); every number links to a run page with the full log, the recording, and their sha256 hashes.

What was measured

From the run that decided this verdict. Every line is a recorded value, not an estimate.

Time lost to each failure while testing UniFi-API-client, drawn from the recorded run
Every bar is a failure the agent recorded, with the time it cost. Drawn from this run, not from anywhere else.

What went wrong, in the agent's own words

The agent's own words, worst first, never rewritten into advice.

  • Static PHP's curl could not connect to localhost (musl libc issue)5 minutes
  • PHP not pre-installed in container (no root for apt-get)2 minutes
Install time
3 minutes
Cold machine to finish
25 minutes
Errors hit and fixed
2 hit, 2 fixed with no human help
How the result was proved
/tmp/php /tmp/test_integration.php: login success, list_sites=1, list_usergroups=1, stat_sysinfo=1. /tmp/php /tmp/test_api_key.php: API key auth login success, list_sites=1.
Model tokens used
478,834
Exact commit tested
ce7e6c84a058
Container image
sha256:cdd920bce783

What was not measured

The other half, so you can see exactly how far this evidence goes. A gap is printed as a gap and never filled in.

Peak GPU memory
this ran on a CPU machine, so there was no GPU to sample
Behaviour over a long run
each attempt uses the smallest documented settings and a fixed time budget, so this measures whether it runs, not how it holds up under load
Behaviour against real services
this run was verified against stand-in services only

The end of the recording

The last lines of the terminal session that decided this verdict, exactly as they were recorded.

- The static PHP's embedded curl couldn't connect to localhost (musl-libc network sandboxing). Work…
- Built a Python mock UniFi controller supporting both username/password and API key auth, handling…
**Verification**: Both authentication methods tested successfully against the mock. Login, `list_si…
tokens used
478,834
Here's a summary of what was accomplished:
**Install**: composer installed the library with no errors. The library has zero runtime dependenci…
**Issues encountered**:
- PHP was not pre-installed in the container. Installed via static binary (php 8.0.30) and a glibc-…
- The static PHP's embedded curl couldn't connect to localhost (musl-libc network sandboxing). Work…
- Built a Python mock UniFi controller supporting both username/password and API key auth, handling…
**Verification**: Both authentication methods tested successfully against the mock. Login, `list_si…

Replay the whole session, every command from a clean machine to this point.

How it was tested

One agent, one container, no human help. It installs the project the way its own documentation says to, runs it, and fixes what breaks. Everything below is recorded as it happened: the terminal session, the log and the exact commit. The full method.

Strengths and limits

Measured facts, not opinions. How this is written.

What went well

  • Installed in 3 minutes, faster than the median of the 19 comparable projects Argusic has measured.
  • Recovered from all 2 errors without a human stepping in, which says the failures are documented well enough to solve.
  • Licensed MIT, as reported by its host.

What did not, or is not known

  • Only reached a running state against stand-in services, so nothing here proves it works against the real ones.
  • Measured once so far. A single attempt shows it can run, not that it runs reliably.

Of the 20 api projects Argusic has installed and timed, UniFi-API-client was the 9th fastest to reach a running state, and 14 of 20 reached one at all.

Also tested, in the same area

Every one of these was installed and run by Argusic on a clean machine. Nothing appears here that was not tested.

Run history

tested byattemptoutcomescorecost USDwhen
Argusic Runner1/3Runs with mocks92.000.12

Topics (from GitHub)

apiapi-clientclassclientcontrollercurlphpubiquitiubntunifi

Embed the badge

Markdown for the project README. It links back here; terms on the terms page.

[![Tested by Argusic](https://argusic.com/badge/UniFi-API-client.svg)](https://argusic.com/subject/unifi-api-client)

Questions

Does UniFi-API-client run?
UniFi-API-client runs, with mocks standing in for external services. Argusic installed and launched it on a clean machine in 3 minutes, hitting 2 errors on the way, and recorded the session.
How did Argusic test UniFi-API-client?
On a fresh, disposable machine, with every command recorded and the repository pinned at commit ce7e6c84a058. One attempt is recorded, and the full method is on the methodology page.
What did it cost to test UniFi-API-client?
The run that produced this verdict cost $0.12: real compute and model cost, not a list price per million tokens. It is recorded on that run's page.
How long does UniFi-API-client take to install?
3 minutes in the run that decided this verdict, from a clean machine to a running state. That is one measured attempt, not an average.
Does UniFi-API-client need a GPU?
Not to start. Argusic reached a running state on a machine with no GPU.
What goes wrong when installing UniFi-API-client?
2 things broke in the recorded run, and 2 were fixed without human help. Each one, and the time it cost, is listed on this page.
How does UniFi-API-client compare with the alternatives?
Of the 20 api projects Argusic has installed and timed, UniFi-API-client was the 9th fastest to reach a running state, and 14 of 20 reached one at all.
Where is the evidence for UniFi-API-client?
The recorded run is on this page, each linking to its full log and terminal recording, stored with a sha256 fingerprint so it cannot be quietly altered.

Discussion