OpenAPI Descriptions of 3GPP 5G APIs (Release 17)

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.

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

API version: September 2021
Release status: Open ^✅
Other releases: 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

SMF (Session Management Function)

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

UDM (Unified Data Management)

• Subscriber Data Management
• UE Context Management
• UE Authentication
• Event Exposure
• Parameter Provisioning
• NIDD Authorization
• MT

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

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
• NEF Event Exposure

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

BSF (Binding Support Function)

• Management

NWDAF (Network Data Analytics Function)

• Events Subscription
• Analytics Info

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 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

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

GMLC (Gateway Mobile Location Center)

• Location

AAnF (AKMA Anchor Function)

• AKMA Anchor Service

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

• Discovery

EDGEAPP (Enabling Edge Applications)

• ACR Management Event
• EEC Registration

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

Northbound APIs

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

VAE (V2X Application Enabler)

• V2X Message Delivery
• File Distribution
• Application Requirement
• Dynamic Group
• Service Continuity
• HD Map Dynamic Information

UAS Application Enabler (UAE) Server

• C2 Operation Mode Management

SEAL (Service Enabler Architecture Layer)

• Network Resource Adaptation
• User Profile Retrival
• Events
• Group Management
• Location Reporting
• Key Information Retrieval

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

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

Media Session Handling (M5)

• Service Access Information
• Consumption Reporting
• Metrics Reporting
• Dynamic Policies
• Network Assistance