5GC APIs Save
RESTful APIs of main Network Functions in the 3GPP 5G Core Network
Project README
OpenAPI Descriptions of 3GPP 5G APIs (Release 18)
The files in this repository have been created by 3GPP, and the master source can be found in the 3GPP site, as part of the official 3GPP Technical Specifications.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
API version: December 2023
Release status: Open ✅
Other releases: Rel-17 (Frozen), Rel-16 (Frozen), Rel-15 (Frozen)
Tools
The links below will open the Swagger Editor (v3.6.23) and auto-load the OpenAPI YAML file of each Network Function (NF) API:
NRF (NF Repository Function)
LMF (Location Management Function)
AMF (Access and Mobility Management Function)
SMF (Session Management Function)
MB-SMF (Multicast Broadcast Session Management Function)
MBSF (Multicast/Broadcast Service Function)
MBSTF (Multicast/Broadcast Service Transport Function)
MB (Multicast/Broadcast) User Services
UDM (Unified Data Management)
- Subscriber Data Management
- UE Context Management
- UE Authentication
- Event Exposure
- Parameter Provisioning
- NIDD Authorization
- MT
- Service-Specific Authorization
- RSDS (Report SM Delivery Status)
- UEID (UE Identifier)
UDR (Unified Data Repository)
UDSF (Unstructured Data Storage Function)
AUSF (Authentication Server Function)
NSSAAF (Network Slice Specific Authentication and Authorization Function)
NSACF (Network Slice Admission Control Function)
NSSF (Network Slice Selection Function)
SMSF (SMS Function)
5G-EIR (5G Equipment Identity Register)
NEF (Network Exposure Function)
- Packet Flow Description (PFD) Management
- Session Management (SM) Context
- Short Message (SM) Service
- NEF Event Exposure
- Authentication
- EAS Deployment
- Traffic Influence Data
- ECS Address
- DNAI Mapping
- UE ID
PCF (Policy Control Function)
- Policy Authorization
- Access and Mobility (AM) Policy Authorization
- Access and Mobility (AM) Policy Control
- Session Management (SM) Policy Control
- Background Data Transfer (BDT) Policy Control
- Policy Control Event Exposure
- UE Policy Control
- Multicast/Broadcast Policy Control
- Multicast/Broadcast Policy Authorization
- Planned Data Transfer with QoS (PDTQ) Policy Control
BSF (Binding Support Function)
NWDAF (Network Data Analytics Function)
- Events Subscription
- Analytics Info
- Data Management
- ML Model Provision
- ML Model Training
- ML Model Monitor
- Roaming Data
- Roaming Analytics
UPF (User-Plane Function)
HSS (Home Subscriber Server)
- UE Authentication
- Subscriber Data Management
- UE Context Management
- Event Exposure
- IMS UE Authentication
- IMS Subscriber Data Management
- IMS UE Context Management
- GBA Subscriber Data Management
- GBA UE Authentication
GBA BSF (GBA Bootstrapping Server Function)
SOR-AF (Steering of Roaming Application Function)
SP-AF (Over-The-Air Function)
AF (Application Function)
CHF (Charging Function)
Common Data Types
SEPP N32 APIs
UCMF (UE Radio Capability Management Function)
MNPF (Mobile Number Portability Function)
GMLC (Gateway Mobile Location Center)
EASDF (Edge Application Server Discovery Function)
AAnF (AKMA Anchor Function)
5G DDNMF (Inter-5G Direct Discovery Name Management Function)
TSCTSF (Time Sensitive Communication and Time Synchronization Function)
ADRF (Analytics Data Repository Function)
MFAF (Messaging Framework Adaptor Function)
Data Collection Application Function
- Common Data Types
- Application Service Provider provisioning (R1)
- Data collection client configuration and reporting (R2, R3, R4)
DCCF (Data Collection Coordination Function)
IP-SM-GW (IP Short Message Gateway)
SMS Router
SMS-IWMSC (Interworking MSC for Short Message Service)
PKMF (ProSe Key Management Service)
SLPKMF (SideLink Positioning Key Management Service)
PANF (ProSe Anchor Function)
IMS AS (IP Multimedia Subsystem Application Server)
MF (Media Function)
Northbound and Application Layer APIs
Common API Framework (CAPIF)
- Discover Service
- Publish Service
- Events
- API Invoker Management
- Security
- Access Control Policy
- Logging API Invocation
- Auditing
- AEF Authentication
- API Provider Management
- Routing Information
SCEF (Service Capability Exposure Function)
NOTE: These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G SCEF to the SCS/AS
- Event Monitoring
- Resource Management of Background Data Transfer (BDT)
- Chargeable Party
- Non-IP Data Delivery (NIDD)
- Device Triggering
- Group Message Delivery via MBMS by MB2
- Group Message Delivery via MBMS by xMB
- Network Status Reporting
- Communication Patterns (CP) Parameters Provisioning
- Packet Flow Description (PFD) Management
- Enhanced Coverage Restriction Control
- Network Parameter Configuration
- Application Server (AS) Session with QoS
- MSISDN-less Mobile-Originated SMS
- RACS (Radio Capability Signaling) Parameter Provisioning
- Common Data
NEF (Network Exposure Function)
- Traffic Influence
- NIDD Configuration Trigger
- 5G LAN Parameter Provision
- Applying BDT Policy
- IPTV Configuration
- Analytics Exposure
- LPI (Location Privacy Indicator) Parameter Provision
- Service Parameter
- ACS Parameter Provision
- MO LCS Notify
- AKMA
- Time Sync Exposure
- ECS Address Provision
- AM Policy Authorization
- AM Influence
- MBS TMGI
- MBS Session
- EAS Deployment
- ASTI
- Data Reporting
- Data Reporting Provisioning
- UE Identifier
- MBS User Service
- MBS User Data Ingest Session
- Media Streaming Event Exposure
- MBS Group Message Delivery
- DNAI Mapping
- PDTQ Policy Negotiation
- Member UE Selection Assistance
- Group Parameters Provisioning
- Slice Parameters Provisioning
- UE Address
- ECS Address
VAE (V2X Application Enabler)
- V2X Message Delivery
- File Distribution
- Application Requirement
- Dynamic Group
- Service Continuity
- HD Map Dynamic Information
- Session Oriented Service
- V2V Config Requirement
- PC5 Provisioning Requirement
- Service And QoS Control Info
- VRU Zone Management
- V2P Application Requirement
SEAL (Service Enabler Architecture Layer)
- Network Resource Adaptation
- Network Resource Monitoring
- Network Slice Adaptation
- User Profile Retrival
- Events
- Group Management
- Location Reporting
- Location Area Information Retrieval
- Key Information Retrieval
- VAL Service Data Retrieval
- VAL Service Area Configuration
- VAL service Parameter Provisioning
- SEALDD Data Transmission
- SEALDD Data Storage
- SEALDD Context Relocation
- SEALDD Transmission Quality Measurement
- SEALDD Policy Configuration
- NSCE Server Policy Management
EDGEAPP (Enabling Edge Applications)
- EAS Registration
- UE Location
- UE Identifier
- Application Client Information
- ACR Management Event
- Session with QoS
- EEC Context Relocation
- EEL Managed ACR
- ACR Status Update
- EES Registration
- Target EES Discovery
- EEC Registration
- ECS Service Provisioning
- EAS Discovery
- EES ACR Events
- EES App Context Relocation
- EES ACR Parameters Information
- EES Common EAS Announcement
- CAS Selected EES
UAS Application Enabler (UAE) Server
5GMARCH (Enabling MSGin5G Service)
- AS Registration
- MSGin5G Server Message Delivery
- L3G Message Delivery
- N3G Message Delivery
- Broadcast Message Delivery
PINAPP (Personal IoT Network Application)
- PINServer PAS Registration
- PINServer Service Switch Information
- PINServer Service Continuity Information
5G Media Streaming (5GMS) TS 26.512
Note: The APIs at reference points M1 and M5 are exposed by the 5GMS AF.
Provisioning (M1)
- Provisioning Sessions
- Server Certificates Provisioning
- Content Preparation Templates Provisioning
- Content Protocols Discovery
- Content Hosting Provisioning
- Consumption Reporting Provisioning
- Metrics Reporting Provisioning
- Policy Templates Provisioning
- Edge Resources Provisioning
- Event Data Processing Provisioning
Media Session Handling (M5)
- Service Access Information
- Consumption Reporting
- Metrics Reporting
- Dynamic Policies
- Network Assistance
Data Reporting
Event Exposure
3GPP SA5 models and MnS OpenAPI definitions
Network Resource Models (NRM)
- Generic NRM (TS 28.623)
- Common NRM definitions (TS 28.623)
- Trace Control (TS 28.623)
- NR NRM (TS 28.541)
- 5GC NRM (TS 28.541)
- Slice NRM (TS 28.541)
- Communication Service Assurance NRM (TS 28.536)
- MDA NRM (TS 28.104)
- MDA Report NRM (TS 28.104)
- AI/ML NRM (TS 28.105)
- Intent NRM (TS 28.312)
- Intent Expectations (TS 28.312)
- Edge NRM (TS 28.538)
- Self-configuration of RAN entities (TS 28.317)
Management Services (MnS)
Open Source Agenda is not affiliated with "5GC APIs" Project. README Source: jdegre/5GC_APIs
Stars
538
Open Issues
30
Last Commit
1 month ago
Repository
Open Source Agenda Badge
