Skip to main content
WebPublish includes a built-in REST API that lets you query and manage publishing tasks programmatically. The API runs as a separate HTTP server on its own port, independent of the main task-serving server. The API is disabled by default. You must enable it explicitly before it accepts any requests.

​
Enabling the API

1

Open Settings

Click the gear icon in the toolbar, or right-click the system-tray icon and choose Settings.
2

Enable the API toggle

In Settings, find the API or REST API section and turn on the Enable API toggle.
3

Set the API port (optional)

The default port is 12110. Change it if that port is already in use on your machine.
4

Save and verify

Click OK to save. WebPublish starts the API server. Verify it is running by sending a request to /getList:
curl http://127.0.0.1:12110/getList
A JSON response containing your task list confirms the API is active.

​
API server settings

SettingConfig keyDefaultDescription
API enabledapi-enabledfalseWhether the REST API server is running.
API portapi-port12110The TCP port the API server listens on.
The API server always binds to 127.0.0.1 (localhost). It is not exposed to the network even if you have changed the main server address to a LAN IP.

​
CORS

The API server allows cross-origin requests from any origin. The following headers are set on every response:
HeaderValue
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsPUT, POST, GET, DELETE, OPTIONS
Access-Control-Allow-Headers*
Access-Control-Allow-Private-Networktrue
This means you can call the API from any web page or browser-based tool without CORS errors.

​
Available endpoints

GET /getList

Returns all current publishing tasks, each with its live URL.

GET /addTask

Adds a new publishing task by providing a local file path.
For full parameter and response documentation, see the API reference overview.

​
Security

The REST API has no authentication. Any process or user that can reach the API port can read your task list and add new tasks. Only enable the API on trusted networks or when you specifically need programmatic access.
Because the API always binds to 127.0.0.1, remote access is blocked by default. If you use port forwarding, a reverse proxy, or a VPN that routes traffic to localhost, be aware that the API will be reachable over those paths without any credential check. To minimize exposure:
  • Enable the API only when you need it, and disable it when you are done.
  • Do not forward the API port through your firewall or router.
  • If you need remote API access, place an authenticating reverse proxy (such as nginx with HTTP basic auth) in front of the API port.

API reference

Full endpoint reference for the WebPublish REST API

Settings

All application settings and their default values

Build docs developers (and LLMs) love

Get started for freeTalk to us