Choose a FileWave API

What

An application programming interface (API) lets software read data from a service or send data back through defined requests.

FileWave APIs support integrations, inventory reporting, and repeatable administration. Some vendors provide ready-made FileWave integrations, so check the integration documentation before building your own.

When to use an API

Use an API when another system needs FileWave data, when FileWave must receive a controlled update, or when a tested administrative task should run automatically.

Where to start

Choose the supported API that matches the task, create a restricted application token, and test read-only calls before allowing writes. FileWave Professional Services can help design or review an integration.

• Command Line API (v1)
• Anywhere API (v2)
• How do I export the results of an Inventory query?
• Using the RESTful API to limit, sort, and offset values returned
  

Choose the correct FileWave API URL

FileWave supports two URL patterns for the inventory API examples below.

API URL patterns

For inventory purposes, FileWave has a Command Line API, designed to interact with Inventory Queries.  This API has existed for years and can work on either port 20443 or port 20445.

Since the introduction of the FileWave web admin, 'FileWave Anywhere', a new API was created.  FileWave Anywhere interacts with the FileWave Server using this new API.  Unless configured otherwise, FileWave Anywhere works over port 443.

The FileWave Anywhere route adds /api before /inv/api. The examples below create the same Inventory Query through each base URL.

TCP port 443 (default port if not specified in URL). Notice that it begins with /api/inv/api/

curl -s -H "Authorization: e2M2sssYjIwLTxxx1hMzdiLTFmyyyGIwYTdjOH0=" https://myserver.filewave.net/api/inv/api/v1/query/ \ 
    --header "Content-Type: application/json" -X POST -d @ios16_incompatible.json

TCP port 20445 (could also use port 20443). Notice that it begins /inv/api/

curl -s -H "Authorization: e2M2sssYjIwLTxxx1hMzdiLTFmyyyGIwYTdjOH0=" https://myserver.filewave.net:20445/inv/api/v1/query/ \ 
    --header "Content-Type: application/json" -X POST -d @ios16_incompatible.json

The FileWave Anywhere API covers a broader set of functions than the inventory-focused command-line API. Scripts and integrations should use documented public endpoints only.

Avoid paths that contain internal. They are private implementation details and can change between FileWave releases without compatibility notice. Use the public endpoints documented for your FileWave version.

https://${server_dns}/filewave/api/devices/internal/devices/${filewave_id}/details/custom_fields/fields