ziggo-connectbox v1.0.2

Ziggo Connectbox V2 (Sagemcom F3896LG) reversed API.

The Connectbox V2 Sagemcom API reversed in order to find devices by hostname or get a list of all hosts connected to the network. Sharing this because it may help others that were struggling doing the same as I was. Check out #Experimenting documentation to see why I started playing around with this project. This may prove totally useless but I guess it's interesting in a way haha.

Additional information...

This project is under a lot of maintenance still and may not be maintained further. As I said, it's a project of passion so I may only develop it to where I need it myself but feel free to open a new issue to suggest changes!

How to use

The package is available in NPM under the name ziggo-connectbox and you should be able to do npm i ziggo-connectbox in order to install this package to your project.

Within the index.ts file there's a function called Example(). I'll show it here as well.

const Modem = require("ziggo-connectbox");

//* Create new instance of a modem.
const modem = new Modem();

//* Login to the instance of the modem (required for most API endpoints)
await modem.Login("YourPasswordHere.");

//* Find by hostname (if connected).
const SleepyPC = await modem.FindByHostName("Sleepy's PC");
console.log(SleepyPC);

//* Show all the hosts currently connected.
const allHosts = await modem.getConnectedHosts();
console.log(allHosts);

//? Always end with logging out, otherwise a restart or 15 minutes waiting time is required to login again.
await modem.Logout();

REST Endpoints

POST:Login

For the vast majority of the REST API you'll need to authenticate yourself through the login, luckily this is merely just a JSON body with the password parameter. JSON body example:

{
  "password": "WhichEverPasswordHere123?"
}

GET:Hosts

Login required! This returns the hosts back to the consumer and you're able to add ?connectedOnly=true to show connected only, this is better because in some cases it may return older devices that share the same hostname and it makes it a bit puzzling sometimes.

Experimenting documentation

I started working on this because of the mere fact that my camera is not able to be detected through Windows for some reason. I can't even find it by MAC address and I've tried a whole bunch of modules that ended up wasting my time and not working. I started looking into my modem, which is a brand new one that we're offering with the internet service nowadays, and if there was a way to actually get the hosts list as provided by the admin panel.

Luckily as soon as I entered the password in, I found everything I needed and right on the homepage too! From here I just went through everything and ended up falling over some hiccups every once in a while as the token does not expire without logging out, so you'll be stuck on a page where it errors out when logging in because "someone else is already active in the dashboard".