1. Cloud Native Security Edge Protection Proxy (SEPP) User's Guide
  2. Configuring SEPP Using REST APIs

2 Configuring SEPP Using REST APIs

The following SEPP managed objects can be configured using REST APIs:

Resource information

RoamingPartnerProfile

Method URL Description Input Return Example
GET /sepp-configuration/v1/roamingpartnerprofile

Returns all the configured roaming partner profiles

Empty List [], if no roaming partner profiles are configured

   List of RoamingPartnerProfile 
curl --location --request GET 
'http://:<SEPP-Configuration IP>:<PORT>
//sepp-configuration/v1/roamingpartnerprofile/'
GET /sepp-configuration/v1/roamingpartnerprofile/{name}

Returns configured RoamingPartnerProfile if not present returns 404

Exception: Roaming partner profile not found for the name

 Name of RoamingPartnerProfile as request parameter RoamingPartnerProfile 
curl --location --request GET 
'http://<SEPP-Configuration IP>:<PORT>//sepp-configuration/v1/
roamingpartnerprofile/SEPP-3'
POST /sepp-configuration/v1/roamingpartnerprofile/ Returns configured RoamingPartnerProfile RoamingPartnerProfile Object RoamingPartnerProfile 
curl --location --request POST 
'http://<SEPP-Configuration IP>:<PORT>/sepp-configuration/v1/
roamingpartnerprofile/' \ --header 'Content-Type: application/json' 
\ --data-raw '{ "plmn": { "mcc":"111", "mnc":"123" }, "domain":"ocsepp-nf33", 
"seppId": "sepp33", "seppFqdn":"10.75.237.33", "securityCapabilityList": 
[ "PRINS" ], "connectionType":"INITIATOR", "isEnabled":"TRUE", "apiPrefix":"n32c-handshake",
 "apiVersion":"v1", "port":30043 }'
DELETE /sepp-configuration/v1/roamingpartnerprofile/{name} Delete configured RoamingPartnerProfile Name of RoamingPartnerProfile as request param   
curl --location --request DELETE 
'http://<SEPP-Configuration IP>:<PORT>//sepp-configuration/v1/roamingpartnerprofile/SEPP-3'
PUT /sepp-configuration/v1/roamingpartnerprofile/{name}

Update configured RoamingPartnerProfile

404 Error if not found

Exception: Roaming partner profile not found for the name
  1. Name of RoamingPartnerProfile as request param
  2. Updated RoamingPartnerProfile object
 RoamingPartnerProfile 
curl --location --request PUT 'http://<SEPP-Configuration IP>:
<PORT>//sepp-configuration/v1/roamingpartnerprofile/SEPP-3' \ 
--header 'Content-Type: application/json' \ --data-raw '{ "name": "SEPP-3", "plmn": 
{ "mcc": "311", "mnc": "282" }, "domain": "ocsepp-nf3", "seppId": "sepp3", 
"seppFqdn": "10.75.237.9", "connectionType": "INITIATOR", "securityCapabilityList": [ "TLS" ], 
"isEnabled": "FALSE", "port": 30043, "apiPrefix": "n32c-handshake", "apiVersion": "v1", "priority": 0 }'
PATCH /sepp-configuration/v1/roamingpartnerprofile/{name}

Update only provided fields of configured RoamingPartnerProfile

404 Error if not found

Exception: Roaming partner profile not found for the name
  1. Name of RoamingPartnerProfile as request param
  2. Fields of RoamingPartnerProfile to be updated
 RoamingPartnerProfile 
curl --location --request PATCH 
'http://<SEPP-Configuration IP>:<PORT>/sepp-configuration/v1/roamingpartnerprofile/SEPP-2'
 \ --header 'Content-Type: application/json' \ --data-raw '{ "isEnabled": "FALSE" }'

Handshake Status

Attribute Datatype Compliance Default Value Pattern Description
GET /sepp-configuration/v1/handshakestatus

Returns all the handshake status

Empty list [], if no handshake status

   List of HandshakeStatus 
curl --location --request GET 
'http://<SEPP-Configuration IP>:<PORT>
/sepp-configuration/v1/handshakestatus/'
GET /sepp-configuration/v1/handshakestatus/{fqdn}

Returns handshake status of the SEPP FQDN

404 Error if not found

Exception: Handshake Status not found for the fqdn

 SEPP FQDN of the handshake status HandshakeStatus 
curl --location --request GET
 'http://<SEPP-Configuration IP>:<PORT>
/sepp-configuration/v1/handshakestatus/10.75.191.11'