Sign in
Remote Access

🛡️ Update the UPnP port mapping setting.

Enables or disables automatic port forwarding. Enabling maps the port immediately when the Remote Access listener is already running.<br /><hr /><h3>🛡️ Requires Capabilities: <code>ServerSettings.Update</code></h3>

put/api/v1/port-mapper/settings

Request body

enabledboolean required

Whether to automatically forward the Remote Access port with UPnP. Only works with host networking.

Response

state'disabled' | 'not_attempted' | 'active' | 'failed' required
reasonstring

Why the mapping failed. Only present when the state is failed.

externalIpstring nullable

The router-reported external IP. Only present when the state is active.

externalPortnumber

Only present when the state is active.

internalPortnumber

Only present when the state is active.

leaseExpiresAtstring

ISO timestamp. Only present when the state is active.

lastAttemptAtstring

ISO timestamp. Only present when the state is failed.

Changes

Changed in 1 of the 176 revisions of this API.1