Skip to main content

Anywhere API (v2 API)

What

As you may suspect, the FileWave Anywhere (formerly called WebAdmin) functions by making API calls to the FileWave server.  We can also leverage this API to make calls for our own purposes.

When/Why

Typically we will want to make calls to the API to get data from FileWave for some external system, or to do automation of some sort.

How

The documentation for this new API is available once you have authenticated to FileWave Anywhere...you simply go to https://my.server.name/api/doc to see the documentation as built by Swagger and OpenAPI (it is quite extensive).  Each action can be tested from the documentation directly as you'll see below, but be careful, some of the calls are destructive! 

API calls are not something to be taken lightly, and you should make 100% sure that you understand your intended actions before taking them.

WebAdminAPI.png

If wanting to call the API without a FileWave Anywhere session active, your header would be in the form of "Authorization: base_64_token" rather than the X-CSRFToken shown in the examples.

Digging Deeper

Because it can be a topic that can trip someone up it is important to note that API calls are done on TCP 443. You may see references to 20445 in some documentation, but that is the RESTful API (v1 API) and it is on TCP 20445 however you can make a small change in the URL for the API endpoint and use TCP 443 for all calls. Simply prepend /api/ on the URL and you can use TCP 443 for the /inv/ endpoint URLs.