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.

© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

API version: March 2024
Release status: Frozen ^🔒
Other releases: Rel-17 (Frozen), Rel-16 (Frozen), Rel-15 (Frozen)

• Info about 3GPP Releases and their status
  
  

Tools

• API Parser/Validator and Linter
• Data Type Finder
• API Versions Overview
  
  

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)

• NF Management
• NF Discovery
• Access Token (OAuth2)
• Bootstrapping

LMF (Location Management Function)

• Location
• Broadcast

AMF (Access and Mobility Management Function)

• Communication
• Event Exposure
• Location
• MT
• MBS Communication
• MBS Broadcast

SMF (Session Management Function)

• PDU Session
• Event Exposure
• NIDD (Non-IP Data Delivery)

MB-SMF (Multicast Broadcast Session Management Function)

• MBS Session
• MBS TMGI

MBSF (Multicast/Broadcast Service Function)

• MBS User Service
• MBS User Data Ingest Session

MBSTF (Multicast/Broadcast Service Transport Function)

• MBS Distribution Session

MB (Multicast/Broadcast) User Services

• MBS Service User Announcement
• MBS Object Manifest

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)

• Data Repository
  • Subscription Data
  • Policy Data
  • Exposure Data
  • Application Data
• Group ID Map

UDSF (Unstructured Data Storage Function)

• Data Repository
• Timer

AUSF (Authentication Server Function)

• UE Authentication
• SoR (Steering of Roaming) Protection
• UPU (UE Parameter Update) Protection

NSSAAF (Network Slice Specific Authentication and Authorization Function)

• NSSAA
• AIW

NSACF (Network Slice Admission Control Function)

• NSAC
• Slice Event Exposure

NSSF (Network Slice Selection Function)

• NSSAI Availability
• NS Selection

SMSF (SMS Function)

• SM Service

5G-EIR (5G Equipment Identity Register)

• Equipment Identity Check

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)

• Management

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)

• Event Exposure
• Get Private UE IP Address

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)

• GBA Service

SOR-AF (Steering of Roaming Application Function)

• Steering of Roaming

SP-AF (Over-The-Air Function)

• Secured Packet

AF (Application Function)

• Event Exposure
• ProSe
• Authentication

CHF (Charging Function)

• Spending Limit Control
• Converged Charging
• Offline-Only Charging

Common Data Types

• Common Data

SEPP N32 APIs

• Handshake (N32-c)
• Forwarding (N32-f)
• Telescopic FQDN Mapping

UCMF (UE Radio Capability Management Function)

• UE Radio Capability Management
• Provisioning

MNPF (Mobile Number Portability Function)

• Number Portability Status

GMLC (Gateway Mobile Location Center)

• Location

EASDF (Edge Application Server Discovery Function)

• DNS Context
• Baseline DNS Pattern

AAnF (AKMA Anchor Function)

• AKMA Anchor Service

5G DDNMF (Inter-5G Direct Discovery Name Management Function)

• Discovery

TSCTSF (Time Sensitive Communication and Time Synchronization Function)

• Time Synchronization
• QoS and TSC Assistance
• ASTI

ADRF (Analytics Data Repository Function)

• Data Management
• ML Model Management

MFAF (Messaging Framework Adaptor Function)

• 3GPP DCCF Adaptor (3DA) Data Management
• 3GPP Consumer Adaptor (3CA) Data Management

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)

• Data Management
• Context Management

IP-SM-GW (IP Short Message Gateway)

• SM Service

SMS Router

• SM Service

SMS-IWMSC (Interworking MSC for Short Message Service)

• SM Service

PKMF (ProSe Key Management Service)

• KeyRequest Service
• Resolve Remote User Id
• Discovery

SLPKMF (SideLink Positioning Key Management Service)

• KeyRequest Service
• Discovery

PANF (ProSe Anchor Function)

• Prose Key Service
• Resolve Remote User Id

IMS AS (IP Multimedia Subsystem Application Server)

• Session Event Control
• Media Control

MF (Media Function)

• Media Resource Management Service

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

• C2 Operation Mode Management
• Real-time UAV Status
• USS Change Management
• DAA Support

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.

• Common Data Types

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

• 5GMS Client (R2)
• 5GMS AS (R4)

Event Exposure

• Data Collection AF (R5, R6)

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)

• Provisioning MnS (TS 28.532)
• Fault Supervision MnS (TS 28.532)
• Performance Measurement Job Control MnS (28.550)
• File Data Reporting MnS (TS 28.532)
• Performance Threshold Monitoring MnS (TS 28.532)
• Heartbeat Notifications(TS 28.532)
• Streaming Data Reporting MnS (TS 28.532)