FileWave Anywhere API Documentation
What
FileWave Anywhere includes a Swagger/OpenAPI documentation page for supported public API paths.
The page lists public, non-internal URL paths and includes a Try it out option that can execute an API command directly from the documentation.
Executing a command from the Swagger API documentation is a live action on the FileWave Server. It runs exactly as requested and can be destructive. Confirm the command, target object, and payload before executing it.
When/Why
Use the API documentation when you need to confirm whether an API call exists, which JSON keys are required, what a field is called, or which object ID should be targeted.
These are some of the questions the Swagger documentation can answer.
Executing commands from the Swagger documentation requires an active FileWave Anywhere login. If the session times out, log in again before using Try it out.
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/
Example GET
The below shows an example of using a 'GET' to return the DEP Profiles:
The response section from an executed action shows the curl command, the requested URL and the returned response (code and body)
