API for Addressing Parameters Provisioning. An OpenAPI 3.0.0 document with 2 path(s), API version 1.0.1, published verbatim by 3GPP in 3GPP TS 29.522 as part of the 5G NEF Northbound (Network Exposure) suite and mirrored in the public 3GPP Forge GitLab repository.
openapi: 3.0.0
info:
title: 3gpp-addr-pp
version: 1.0.1
description: |
API for Addressing Parameters Provisioning.
© 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.522 V19.6.0; 5G System; Network Exposure Function Northbound APIs.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers:
- url: '{apiRoot}/3gpp-addr-pp/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/pp:
get:
summary: Request to retrieve all the active Addressing Parameters Provisionings at the NEF.
operationId: GetAddrParamsProvisionings
tags:
- Addressing Parameters Provisionings (Collection)
responses:
'200':
description: >
OK. All the Individual Addressing Parameters Provisioning resources managed by
the NEF are returned.
If there are no existing Individual Addressing Parameters Provisioning resources
managed by the NEF, an empty array is returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddrPpData'
minItems: 0
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
post:
summary: Request the creation of a new Addressing Parameters Provisioning.
tags:
- Addressing Parameters Provisionings (Collection)
operationId: CreateAddrParamsProvisioning
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddrPpData'
responses:
'201':
description: >
Created. A representation of the created Individual Addressing Parameters
Provisioning resource is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/AddrPpData'
headers:
Location:
description: >
Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/pp/{ppId}:
parameters:
- name: ppId
in: path
description: >
Represents the identifier of the Individual Addressing Parameters Provisioning
resource.
required: true
schema:
type: string
get:
summary: Request to retrieve an existing Individual Addressing Parameters Provisioning resource.
operationId: GetIndAddrParamsProvisioning
tags:
- Individual Addressing Parameters Provisioning (Document)
responses:
'200':
description: >
OK. The requested Individual Group Parameters Provisioning resource is returned in the
response body.
content:
application/json:
schema:
$ref: '#/components/schemas/AddrPpData'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Request the update of an existing Individual Addressing Parameters Provisioning resource.
tags:
- Individual Addressing Parameters Provisioning (Document)
operationId: UpdateIndAddrParamsProvisioning
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddrPpData'
responses:
'200':
description: >
OK. The Individual Addressing Parameters Provisioning resource is successfully
updated and a representation of the updated resource is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/AddrPpData'
'204':
description: >
No Content. The Individual Addressing Parameters Provisioning resource is
successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Request the modification of an existing Individual Addressing Parameters Provisioning resource.
tags:
- Individual Addressing Parameters Provisioning (Document)
operationId: ModifyIndAddrParamsProvisioning
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AddrPpDataPatch'
responses:
'200':
description: >
OK. The Individual Addressing Parameters Provisioning resource is successfully
modified and a representation of the updated resource is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/AddrPpData'
'204':
description: >
No Content. The Individual Addressing Parameters Provisioning resource is
successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Request the deletion of an existing Individual Addressing Parameters Provisioning resource.
tags:
- Individual Addressing Parameters Provisioning (Document)
operationId: DeleteIndAddrParamsProvisioning
responses:
'204':
description: >
No Content. The Individual Addressing Parameters Provisioning resource is
successfully deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
#
# STRUCTURED DATA TYPES
#
AddrPpData:
description: Represents the Addressing Parameters data.
type: object
properties:
afId:
type: string
staticIpaddrParams:
type: array
items:
$ref: '#/components/schemas/StaticIpAddrParams'
minItems: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- afId
StaticIpAddrParams:
description: Represents the Static IP Address Parameters data.
type: object
properties:
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
staticIpAddresses:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
minItems: 1
maxItems: 2
required:
- dnn
- snssai
- gpsi
- staticIpAddresses
AddrPpDataPatch:
description: >
Represents the requested modification to an existing Addressing Parameters Provisioning.
type: object
properties:
staticIpaddrParams:
type: array
items:
$ref: '#/components/schemas/StaticIpAddrParams'
minItems: 1
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#