Enable/disable HTTP API

PUT

/api/v1/settings/http-api-enabled

Toggle the HTTP API server on or off in config. Requires app restart to take effect.

Query Parameters

enabled*Enabled

Enable or disable the HTTP API

Successful Response

application/json

success*Success

Whether the operation succeeded

changed*Changed

Whether the setting was actually changed

message?|

Optional status message

Example Request

curl -X PUT 'http://127.0.0.1:8100/api/v1/settings/http-api-enabled?enabled=true'

Example Request

curl -X PUT 'http://127.0.0.1:8100/api/v1/settings/http-api-enabled?enabled=true'

Example ResponseSchema

{
  "success": true,
  "changed": true,
  "message": "string"
}

{  "success": true,  "changed": true,  "message": "string"}

Get HTTP API settings GET

Return whether the HTTP API is enabled and its configured port.

Set HTTP API port PUT

Change the HTTP API port in config. Requires app restart to take effect.