Managing Shares and Permissions via MyWorkDrive Server Public API

MyWorkDrive Server version 7.1 introduces a powerful new Public API that allows administrators to automate the creation, configuration, and removal of file shares and permissions using HTTP requests. This API is designed for advanced users who need to integrate share management into external systems, scripts, or orchestration workflows.

Getting Started

1. Enable the API

Go to Admin Panel > Enterprise Tab

Enable the Public API

Copy your API Key

Note:

All requests must include the API key in the HTTP header:
Header: ApiKey: {your-api-key}

In cURL, for example,
curl -H "ApiKey: abcd12345"

1. Access the API API is hosted locally (by default) on:
   http://127.0.0.1:8360

If you wish to make your Share management API available over the lan or internet, see additional information regarding publishing for remote access below.

Share Management Endpoints

Note: Shares will only appear in the Admin Panel if at least one permission is assigned. API changes may take up to 5 minutes to reflect due to caching.

Permission Management Endpoints

PlacePermission Parameters

Example (for Entra ID Group): GET /api/v3/PlacePermission?name=All%20Entra%20ID%20Members&shareName=LocalTest&domainName=&isGroup=true&webClientAllowed=true&desktopClientAllowed=true&mobileClientAllowed=true&publicSharingEnabled=true&dlpDownloadEnabled=true&dlpOfficeOnlineEditEnabled=true

Storage Providers

To create a share, you need the storageProviderId.

How to Retrieve It:

1. Go to Admin Panel > Integrations
2. Create a new storage entry (e.g., Azure Blob, Azure Files, SMB)
3. Check the General.xml file in Wanpath\wanpath.data\settings for the generated storageProviderId

⚠️ Currently, API support for managing storage providers (add/delete) is under consideration.

Notes and Limitations

• Cache Delay: Updates may take up to 5 minutes to appear in the Admin Panel.
• Delete Behavior: Deleting a share does NOT automatically delete associated permissions (must be done as a separate post).
• HTTP Verbs: The API is verb-agnostic (GET, POST, etc.), but examples here use GET for simplicity.
• Spaces & Encoding: URL parameters must be URL-encoded (e.g., All Entra ID Members → All%20Entra%20ID%20Members).
• Modifications: To modify a share or permission, delete and re-create it.

Security Considerations

This API is designed to run on a private local network interface by default. Making it publicly accessible should be done with extreme caution.

For security, the Management API is hosted on a separate IIS site Wanpath.Admin.API on port 8360. For additional security, add a host name and SSL certificate to this IIS site while continuing to limit access via firewall or authentication controls.

Publishing for Remote Access

When enabled, the Share Management API is bound to the local host IP on port 8360, and no changes are made to Windows firewall. I t will only be accessable from the MyWorkDrive server itself

The following steps need to be taken to make port 8360 available remotely.

1. Adjust the firewall in the local security product (Windows Defender firewall, at minimum) to permit connections on port 8360 by adding an inbound rule on port 8360.
2. Edit the bindings in IIS for the Wanpath.Admin.API site to adjust the allowed IP addresses from 127.0.0.1 to use the machine IP.

This will permit access via http to port 8360 from other machines on the lan.