The Web API is a RESTful client interface that can be used to retrieve information from the i-net HelpDesk and trigger various actions. It also provides a graphical interface to quickly check the available Web API extensions, read the documentation for each end point and try them out.

The Web API user interface can be hidden from end users to tighten security in environments which should still allow the access to the api interfaces itself.

If enabled (default) the Web API user interface can be accessed as an application from the i-net HelpDesk start page. The interface enables users with the Web API permission and specific plugin permissions to browse and access the API endpoints - and their respective help page - at the /api context.

Disabling the option will disable the browsing web interface. It does not disable the access to the Web API when used by other tools, like curl or AJAX.

Note: This is a global option and will allow/disallow access for all users of the i-net HelpDesk server.

The Web API user interface can be hidden by enabling this option. The user interface has to be enabled to modify this option.

If disabled, the Web API application will not be shown in either the start page or the application menu. Users can still access and the user interface when using Web API endpoints in the browser.

Access to the swagger.json file is by default enabled without authentication, so that developers of additional APIs have unrestricted access from their tools. However, you can disable the public access and restrict it to Web API extensions that eiuther do not require authentication or that the user has access to. In that case, users have to authenticate against the Swagger file URL.

You can also export the Swagger file using the Web API application - in that case you are authenticated with the user you access the application with.