Sign in
Remote Access

🛡️ Get the UPnP port mapping status.

<h3>🛡️ Requires Capabilities: <code>ServerSettings.Read</code></h3>
get/api/v1/port-mapper/status

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