HATEOAS

Hypermedia As The Engine Of Application State

Services →
Introduced in Rel-15

HATEOAS is a REST architectural constraint for 3GPP service-based interfaces where a client interacts entirely through hypermedia links dynamically supplied by the server, enabling loose coupling and discoverability between network functions.

Category
Services
Introduced
Rel-15
Where
Core Network › 5G Core
Specifications
3 specs
HATEOAS Description Purpose Related Classification Detected Changes Specifications

Description

Hypermedia As The Engine Of Application State (HATEOAS) is a core principle of the Representational State Transfer (REST) architectural style applied within the 5G Core Network's service-based architecture (SBA). It dictates that a client (a Network Function, NF, consumer) should interact with a server (a NF producer) by following hypermedia links and forms embedded within the resource representations it receives, rather than relying on out-of-band API knowledge or hardcoded URLs. In practice, when a NF consumer (e.g., an AMF) requests a resource from a NF producer (e.g., an NRF), the response (typically in JSON format) includes not just the requested data, but also a set of `_links`.

These `_links` are Uniform Resource Identifiers (URIs) that indicate the possible next actions or related resources the client can access, such as `self`, `update`, `delete`, or links to other related NF services. The client's application state is driven by navigating these links. For instance, after discovering a Session Management Function (SMF) instance via the NRF, the AMF would follow the link provided for that SMF instance to initiate service-based communication (e.g., using the `nsmf-pdusession` API). The server dictates the available state transitions by which links it includes, allowing the server's API to evolve without breaking clients that simply follow links.

Within the 3GPP specifications (e.g., TS 29.501, TS 23.502), HATEOAS is implemented in the HTTP/2-based service-based interfaces like Nnrf (NF Repository Function), Nnef (Network Exposure Function), and Namf (Access and Mobility Management Function). The OpenAPI definitions for these interfaces include the schema for `Links` and `ProblemDetails` objects. This architectural approach decouples NF service consumers from the specific deployment topology and URI structures, enabling dynamic service discovery, load balancing, and graceful evolution of the network. The Network Repository Function (NRF) acts as a central hypermedia engine, providing the initial links that bootstrap the interaction between other NFs.

Purpose & Motivation

HATEOAS was adopted in 3GPP's 5G SBA to solve critical problems of scalability, flexibility, and maintainability in the core network. Traditional telecom interfaces were based on static, point-to-point protocols (e.g., Diameter) with rigid relationships. Adding a new network function or changing an API version required coordinated updates across multiple nodes, hindering innovation and network slicing. The purpose of applying HATEOAS is to create a loosely coupled system where network functions discover and interact with each other dynamically.

This addresses the limitation of hardcoded dependencies. A client NF only needs to know how to interact with a bootstrap endpoint (like the NRF) and how to interpret hypermedia links. The server NF controls the available interactions. This allows for seamless introduction of new services, versioning of APIs (by providing different links for different versions), and support for network slicing where different slices may have different instances of the same NF type. It empowers cloud-native principles in the 5G Core, enabling auto-scaling, self-healing, and continuous deployment, as new instances can register with the NRF and immediately become discoverable via the hypermedia links it provides without requiring reconfiguration of all potential consumer NFs.

Classification

Part ofREST
Related approachesSBANRF

Detected Changes Across Releases

from 3GPP Change Requests

Specific changes extracted from the „Change history“ tables of 3GPP specifications (1 CRs across 1 releases). Complements the general historical overview above with the evidence-based evolution of this function.

Studied in Rel-15, normative work from Rel-17.

Rel-17 1 change

In Release 17, the HATEOAS function was newly introduced to enable a stateless Network Function (NF) consumer model, specifically through the enhancement of change notifications. This allows an NF service consumer to efficiently discover and navigate available NF service resources and their state transitions using hypermedia controls embedded within API responses, as defined within the REST-based reference points. The update facilitates dynamic interaction without prior knowledge of all API endpoints, aligning with REST architectural principles for service discovery.

  • Change Notification of Array to Stateless NF Consumer TS 29.501CR0103

Explore further

Broader topics and technologies where HATEOAS plays a role.

Defining Specifications

3GPP specifications that define or reference HATEOAS, with the latest known release. Sourced from the 3GPP document catalog — see methodology.

SpecificationTitleRelease
TS 23.722 vf10 Common API Framework (CAPIF) for 3GPP Northbound APIs Rel-15
TS 29.501 vj40 5GC SBI API Design Principles & Guidelines Rel-19
TS 29.890 vg00 CT3 5G System Technical Report Rel-16