Skip to main content
WebPublish includes an optional REST API that lets you list and manage publishing tasks from external scripts or tools. The API is disabled by default and must be turned on in Settings before use.
The REST API has no authentication. Only enable it on trusted networks and disable it when not in use.

​
Enabling the API

1

Open Settings

Click the settings icon in the WebPublish sidebar to open the Settings panel.
2

Enable the API

Toggle API Enabled to on. The API server will start immediately.
3

Set the API port

The default port is 12110. Change it if there is a conflict, then restart the API server.
See API Configuration for full details.

​
Base URL

http://127.0.0.1:12110
Replace 12110 with your configured api-port if you changed it.

​
Available endpoints

MethodPathDescription
GET/getListReturn all current publishing tasks
GET/addTaskAdd a new task from a local file path

​
Response format

All responses use Content-Type: text/json;charset=UTF-8. Successful responses return a JSON object. Unrecognised paths return the plain text string error.

​
CORS

The API sets permissive CORS headers 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 any web page — including those served from localhost on a different port — can call the API directly.

​
Error handling

ScenarioResponse
Unknown path200 OK with body error
Invalid file path in /addTask404 with error message

GET /getList

Retrieve all active publishing tasks

GET /addTask

Add a new task from a local path

Build docs developers (and LLMs) love

Get started for freeTalk to us