← Overview
The management (OAM) API is an operator-facing REST interface, separate from the 5G SBI. It exposes status, statistics, binding inspection/removal, and runtime configuration controls. It is served over HTTPS.
Back to the Operations Guide.
Access
| Property | Value |
|---|
| Scheme | HTTPS (TLS) |
| Port | 8443 |
| Bind address | 0.0.0.0 |
All responses are JSON, wrapped in a standard envelope with a success / error status.
Status Endpoints
| Method | Path | Description |
|---|
GET | /status/api | Liveness probe. Returns "ok". |
GET | /status/nrf | NRF registration status: nrf_status, nf_instance_id, nrf_uri. Returns unknown if the registration process is unavailable. |
GET | /status/nf | NF service status: nf_type, advertised nbsf-management service, sbi_addr/sbi_port, and the current active PCF binding count. |
Binding Inspection
| Method | Path | Description |
|---|
GET | /pcf_bindings | List active PCF bindings (summary view: binding ID, UE IP, DNN, S-NSSAI, SUPI, PCF FQDN). |
GET | /api/bindings | List all bindings with UE address, DNN, S-NSSAI, SUPI, GPSI, and PCF address info, plus a total count. |
GET | /api/bindings/{id} | Detailed view of a single binding by ID, including framed route lists and negotiated suppFeat. Returns 404 if unknown. |
GET | /api/statistics | Aggregate statistics: total bindings and a per-DNN breakdown. |
Binding Management
| Method | Path | Description |
|---|
DELETE | /oam/binding/{id} | Remove a single PCF binding by ID. Returns 404 if the binding does not exist. |
POST | /oam/binding | Clear all PCF bindings. Returns the number of bindings cleared. This is disruptive - active sessions lose their binding until re-registered. |
Runtime Configuration
| Method | Path | Description |
|---|
GET | /oam/config | View current runtime configuration: sbi_addr, sbi_port, nrf_uri, mcc, mnc, NF capacity/priority, and log level. |
PATCH | /oam/config/{id} | Update selected runtime values. Accepted keys: nrf_uri, nf_capacity, nf_priority, log_level. Invalid or empty updates return 400. |
POST | /oam/nrf/reregister | Force NF re-registration with the NRF. Returns the resulting registration status and NF instance ID. |
POST | /oam/log_level | Change the log level at runtime. Body: {"level": "<level>"}. |
Configurable values
| Key | Type | Notes |
|---|
nrf_uri | string | Base URI of the NRF. Takes effect on the next registration/heartbeat cycle. |
nf_capacity | integer | NF capacity advertised in the NRF profile; pushed to the NRF on update. |
nf_priority | integer | NF priority advertised in the NRF profile; pushed to the NRF on update. |
log_level | string | One of emergency, alert, critical, error, warning, warn, notice, info, debug. |
Changes made through this API are applied to the running instance only and are not persisted; they revert to the configured values on restart.