Expand API functionality

Unimus support forum
Post Reply
michael.brugge
Posts: 4
Joined: Wed Aug 28, 2019 3:01 pm

Wed Aug 28, 2019 3:12 pm

Hello,

Is it possible to expand the API with the following features it would make it much easier to use.

Expand API create new device:
-Add parameter bind credential
-Add parameter add tag
-Add parameter to the Succes 201 message with "Discovered - Yes/No"



We use our own software which sends an API to create a new device to Unimus, but we cant auto check if the devices succesfully discovered.
We either have to login into the webinterface or use API get device

Best regards,

Michael Brugge
User avatar
Tomas
Posts: 743
Joined: Sat Jun 25, 2016 12:33 pm

Wed Aug 28, 2019 3:26 pm

Hello,

1) API and Credentials
Credentials (and therefore Credential binding) are missing from the API on purpose.
We did not yet decide internally if we want to expose credentials over the API.

If we were to expose cred. binding over the API, we would have to expose the credentials themselves first.

This is for security reasons - as by default Unimus is HTTP, and it would be super simple to sniff the API token, and of course the credentials to your entire network. Currently if the API token (or the API communication) is sniffed, access to the API would be compromised, but at least access to the network itself would not.
Of course, Credentials can also be sniffed from a regular Unimus session, but data there is much more complex that just a simple JSONs the API uses.

As you can imagine, this is a complex discussion, and there are many "but if..." and "we could..." points here, it's just that we have not internally arrived at a firm conclusion what to do yet.

2) API and Tags
We do indeed need to expose Tags and Tagging devices over the API.
I have created a ticket in our internal tracker.

3) API and device status
Here, the device creation endpoint can not return "Discovered - Yes/No".
This is because discovery takes time. Image adding a 1000 devices over the API. It could take up to 3-4 minutes for all the discoveries to complete. The API endpoint can't hold the response to the device creation request for so long.

What we can do here, is add a device status endpoint.
That would tell you if any jobs are running on a device (Discovery, Backup, Mass Config Push), and what the status of the device is (discovered or not, etc.).

I have also created a ticket for this in our internal tracker.
michael.brugge
Posts: 4
Joined: Wed Aug 28, 2019 3:01 pm

Thu Aug 29, 2019 9:39 am

Thanks Tomas for your quick reply.

Best regards,

Michael
Post Reply