Configuration Guide
Configure Api2File to connect to your APIs
Prerequisites: Ensure you've completed the installation and licensing steps before configuring Api2File .
Ready to Use
Api2File includes example configurations that work out of the box. You can start the service immediately and customize later.
Configuration Files
Api2File uses two simple configuration files that you can edit with any text editor:
AppSettings.json
Controls how Api2File runs—logging, license paths, and service behavior
When to edit: Rarely needed. Ships with sensible defaults.
apis.yaml
Defines your API connections, authentication, and data transformations
When to edit: Essential. This is where you configure your APIs.
AppSettings.json
Advanced configuration for Api2File service behavior. Most users won't need to modify this file.
File Location (Windows):
C:\Program Files\API2File\AppSettings.jsonFile Location (Linux):
/opt/api2file/AppSettings.jsonComing Soon
Docker container support is currently in development.
Common Settings
License Directory
Change where Api2File looks for license files
Logging Level
Adjust verbosity of log output for troubleshooting
API Configuration Path
Override the default location of apis.yaml
apis.yaml
The main configuration file where you define which APIs to expose as network shares. This is where you'll spend most of your configuration time.
File Location (Windows):
C:\Program Files\API2File\apis.yamlFile Location (Linux):
/opt/api2file/apis.yamlComing Soon
Docker container support is currently in development.
What You Can Configure
API Endpoints
Define which APIs to connect to and how to authenticate
Data Transformations
Reshape API responses into file/folder structures
Refresh Intervals
Control how often data is fetched from your APIs
Share Names
Customize how shares appear on your network
Example Configuration Included
The installed apis.yaml includes a working example that connects to a public API. You can test Api2File immediately, then customize the file for your own APIs.
Editing Configuration Files
Use a Text Editor
Any text editor works—Notepad, Nano, VS Code, or your preferred editor
Edit the Files
Modify the configuration values as needed. YAML files are human-readable and well-commented.
YAML is whitespace-sensitive. Maintain consistent indentation (use spaces, not tabs).
Restart the Service
Configuration changes require a restart to take effect:
Windows (if running as service):
services.msc
Find "API2File" and click Restart
Windows (if running manually):
Press Ctrl+C to stop, then run api2file.cli.exe again
Linux (if running as service):
sudo systemctl restart api2file
Linux (if running manually):
Press Ctrl+C to stop, then run ./api2file.cli again
Coming Soon
Docker container support is currently in development.
Configuration Complete!
Your APIs are now configured. Time to start Api2File and access your data!