How to use API calls to remove a device from UIM


Article ID: 107941


Updated On:


NIMSOFT PROBES DX Infrastructure Management


We are looking for API to remove the devices from UIM, right now it has to be deleted manually from Admin Console, net connect and UMP (Inventory) which we want to automate through API.

What are the API commands needed to remove a device from monitoring?


UIM 9.0 and earlier
UMP 9.0 and earlier


There is no single API call to remove a system from UIM currently.

Please make sure you have installed the webservices_rest probe to your UMP robot, as this will be required for the information I am providing below.

There are several factors that have to be taken into consideration:

1) Does the target device have a robot on it?

2) Has it been stopped and removed?

3) Are there remote probes monitoring the device?

4) If so which ones?

NOTE: Support is generally not setup to help client build custom automation solution as you are requesting.
This usually would be refereed to our services department.

Information the API calls available are located here:

With the release of UIM 9.0 there will be a NEW UIMAPI release that is much easier to use that provide Swagger documentation and endpoints.

If there was was a robot on the device that needs to be removed the following steps need to be followed:

1) Deactivate and uninstall the robot;

2) From the hub remove the robot from the hub robots.sds file;

You will need to use the callback  feature on the robot hub.  You can call the removerobot PU callback.

To remove the device from inventory, you will need the cs_key from the cm_computer_system table. You can use the computer_system calls to get this information.

You will then need to use the discovery_server call back to remove master device by cs_key.

There is a KB article on how to do this manually:

NOTE: see the section on deleting an individual system

If you have remote probes such as net_connect or rsp you will need to run a probe call. You could use the callback or callback2 function, or the Delete a Probe Configuration function.

Please review the calls to see which will best meat your needs.