API Documentation

OmniFi Access provides a reference documentation page accessible from <Service URL>/api/doc (e.g. https://host:port/api/doc). The automatic documentation includes both the standard API and any custom endpoints that have been published.

Additional documentation for the standard APIs can be found in the API Portal.


OmniFi automatic reference documentation

The documentation page provides a good starting point for discovering the available API functions, and detailed information on how to use them. Clicking on one of the API functions provides detailed information on that function, including request parameters and sample output in various formats.


Detailed API function documentation can be accessed directly in the API reference pages

Import endpoints are POST methods, accepting parameter data in the request body. The documentation contains samples of request bodies that can be used as basis for calling the endpoint.


Copying the request body sample provided with the documentation is a convenient basis for calling Import endpoints