FileWave Anywhere API Documentation
What
FileWave Anywhere has a dedicated documentation page, which is built by Swagger and is OpenAPI.
The documentation should only list public (non-internal) URL paths. Not only does it list possible commands, but there is an option to 'Try it Out', allowing execution of the command from the documentation.
Executing a command from the Swagger API documentation is a live action on the FileWave Server, it will act as requested and can be destructive. Be 100% sure before of any command before executing.
When/Why
Unsure if an API call exists for the intended action? Need to confirm the format or name of a key in the JSON? Are some keys in the JSON required? What is the ID of the item to be targeted?
These are some of the questions the Swagger documentation can answer.
Executing commands from the Swagger documentation requires an active login to the FileWave Anywhere web admin. If this login times out, a fresh login action will be required.
How
On earlier versions of FileWave, the Documentation page may be accessed without logging in first, but it may then only be viewed as 'read only'.
This is no longer the case and it should be expected to log into FileWave Anywhere to access the API documentation.
First log into FileWave Anywhere through a web browser. The address should be the same as shown in the FileWave Central Mobile Preferences:
The URL for the Swagger documents page is the server address appended with /api/doc/. From the example above, it would look as follows:
https://demoz.filewave.com/api/doc/
The response section from an executed action shows the curl command, the requested URL and the returned response (code and body)