Skip to content

RESTful APIs of main Network Functions in the 3GPP 5G Core Network

Notifications You must be signed in to change notification settings

network-automation/5GC_APIs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

CircleCI

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.

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

API version: June 2022
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)

MB-STF (Multicast/Broadcast Service Transport Function)

UDM (Unified Data Management)

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)

PCF (Policy Control Function)

BSF (Binding Support Function)

NWDAF (Network Data Analytics Function)

UPF (User-Plane Function)

HSS (Home Subscriber Server)

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)

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

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)

Northbound and Application Layer APIs

Common API Framework (CAPIF)

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

NEF (Network Exposure Function)

VAE (V2X Application Enabler)

SEAL (Service Enabler Architecture Layer)

EDGEAPP (Enabling Edge Applications)

UAS Application Enabler (UAE) Server

5GMARCH (Enabling MSGin5G Service)

5G Media Streaming (5GMS) TS 26.512

Note: The APIs at reference points M1 and M5 are exposed by the 5GMS AF.

Provisioning (M1)

Media Session Handling (M5)

Data Reporting

3GPP SA5 models and MnS OpenAPI definitions

Network Resource Models (NRM)

Management Services (MnS)

About

RESTful APIs of main Network Functions in the 3GPP 5G Core Network

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published