The stand-alone WebAdmin offers a REST API to read data from configured UTM applications that are available via the administration program interface.
A web browser or your own Python program, e.g. the delivered client_anonym.py, can be used as a REST API client, see Python Client.
The REST API client must authenticate by entering a WebAdmin user name and a valid password. A user with read access is sufficient.
In a first step, a list of the UTM applications configured in WebAdmin with the associated IDs and further information such as computer name, operating system and availability can be retrieved via the REST API, see structures WebAdminInfo and applications.
Using these persistent IDs, current data for one or all data structures of a specific UTM application can be read, namely
- general application parameters, e.g., parameter type
KC_CURR_PARor - object properties of all objects of a type, e.g., for object type
KC_USER, all USER
All field names of a data structure of the ADMI interface are output via the REST API. Exceptions, see Exceptions for obsolete fields. Examples see structures WebAdminInfo, applicationInfo and applicationData.
Examples of calling the REST API:
- Querying an overview of all UTM applications defined in WebAdmin, along with their IDs:
http://localhost:8080/UtmWebAdmin/api/v1/appls/ - Query all data for the UTM application with ID 4711:
http://localhost:8080/UtmWebAdmin/api/v1/appls/4711 - Querying the data of all TACs of the UTM application with ID 4711:
http://localhost:8080/UtmWebAdmin/api/v1/appls/4711?struct=KC_TAC
v1 stands for the interface version 1.x.y (e.g. 1.0.1).
The REST API data is output as a JSON data structure and can be conveniently displayed in the Mozilla Firefox browser, for example. This is achieved by the option to expand and collapse individual substructures.
For a formal description of the REST API, see YAML file.