---
title: "🛡️ Get the UPnP port mapping status."
method: GET
path: "/api/v1/port-mapper/status"
tags: ["Remote Access"]
---

# 🛡️ Get the UPnP port mapping status.

`GET /api/v1/port-mapper/status`

<h3>🛡️ Requires Capabilities: <code>ServerSettings.Read</code></h3>

## Response `200`

- PortMapperStatusResponse
  - `state` 'disabled' | 'not_attempted' | 'active' | 'failed', required
  - `reason` string — Why the mapping failed. Only present when the state is failed.
  - `externalIp` string, nullable — The router-reported external IP. Only present when the state is active.
  - `externalPort` number — Only present when the state is active.
  - `internalPort` number — Only present when the state is active.
  - `leaseExpiresAt` string — ISO timestamp. Only present when the state is active.
  - `lastAttemptAt` string — ISO timestamp. Only present when the state is failed.

## Other responses

- `401` — Possible reasons: The authorization token is invalid.
- `403` — Possible reasons: The user does not have sufficent capabilities.

## Changes

- **2026-08-09** `0a6b12031de9` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api/changes/api/v1/port-mapper/status/get.md)

---

[API](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api.md) · [All operations](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cardinalapps/cardinal-media-server-api/revisions/7b5e4555e84f/schema)