API – 5G Software | 5G Cloud Native Software Provider | EnterPrise 5G Wireless
5G Portal  |  5G Portal APIS

5G Portal

5G Portal APIS

Log, Trace Management 6

All Log, Trace management APIs will be in this folder

Description

Gets Log of selected node(s) for logged in user

A sample response below

{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “from_date”: “1601879960123”, “to_date”: “1601869960123”, “time_zone”: “GMT -5”, “log”: [ { “debug”: “Jason formatted log here” } ] } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": 1, "from_date": "1601879960123", "to_date": "1601869960123" }
Description

Get Log collection status

A sample response below

{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “log_status”: “active”, “log_level”: “DEBUG” } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": 1 }
Description

Gets Trace of selected Interface(s) for logged in user

A sample response below

{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N1”, “from_date”: “1601879960123”, “to_date”: “1601869960123”, “time_zone”: “GMT -5”, “trace”: [ { “amf2smf”: “Jason formatted trace here” } ] } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": [ 1, 2 ], "interface": "N11", "from_date": "1601879960123", "to_date": "1601869960123" }
Description

Get Log collection status

A sample response below

{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N11”, “trace_status”: “active” } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_ids": [ 1, 2 ], "interface": "N11" }
Description

Enable, Disable Log collection

A sample response below

{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “log_status”: “active”, “log_level”: “DEBUG” } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": 1, "log_status": "enable", "log_level": "DEBUG" }
Description

Enable, Disable Trace collection

A sample response below

{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N11”, “trace_status”: “active” } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_ids": [ 1, 2 ], "interface": "N11", "trace_status": "enable" }

Node Management 5

All Node management APIs

Description

Creates a Node

A sample response below

{ “status”: “success”, “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “attrs”: { “__name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "user_id": "1", "version": "1", "node_name": "my amf node", "node_type": "amf", "site_id": 1, "attr": [ { "plmn_id": { "mcc": "941", "mnc": "70" }, "network_name": { "full": "5Gcore", "amf_name": "5g-amf0" } } ] }
Description

Delete a Node

A sample response below

{ “status”: “success”

}

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "user_id": "1", "version": "1", "node_name": "user_amf_node", "node_id": 1, "site_id": 1 }
Description

Gets details of All nodes for logged in user

A user may have multiple sites, each site means full 5g core. Mostly it will be 1 site per user. But site_id is being used to scale for future.

Each site will have multiple nodes (5g nodes like amf, smf etc), if node_id parameter (optional) included then node specific details will be returned otherwise node details for all will be returned

A sample response below { “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “attrs”: { “name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } }, { “node_id”: 2, “node_name”: “user_smf_node”, “node_type”: “smf”, “attrs”: { “name”: “smf.localhost!smf”, “active”: true, “host_name”: “smf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100" }
Description

Perform a action node, e.g. start, stop, restart

A sample response below

{ “status”: “success”, “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “attrs”: { “__name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "user_id": "1", "version": "1", "node_name": "user_amf_node", "node_type": "amf", "node_id": 1, "site_id": 1, "action": "restart" }
Description

update a Node

A sample response below

{ “status”: “success”, “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “my_amf_node”, “node_type”: “amf”, “attrs”: { “__name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "user_id": "1", "version": "1", "node_name": "my_amf_node", "node_type": "amf", "node_id": 1, "site_id": 1 }

Performance Management 3

All Performance management APIs will be in this folder

Description

Get KPI collection status

A sample response below

{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_smf_node”, “node_type”: “smf”, “kpi_status”: “active” }, { “node_id”: 2, “node_name”: “user_smf_node”, “node_type”: “smf”, “kpi_status”: “active” } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": [ 1, 2 ] }
Description

Gets KPIS of All nodes or selected node for logged in user

A user may have multiple sites, each site means full 5g core. Mostly it will be 1 site per user. But site_id is being used to scale for future.

Each site will have multiple nodes (5g nodes like amf, smf etc), if node_id parameter (optional) included then node specific KPI details will be returned otherwise node details for all will be returned

A sample response below { “results”: [ { “site_id”: “1”, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “from_date”: “1601879960123”, “to_date”: “1601869960123”, “time_zone”: “GMT -5”, “kpis”: [ { “Registered subscribers measurement”: “100”, “Mean number of registered subscribers”: “100”, “Maximum number of registered subscribers”: “100”, “Registration procedure related measurements”: “100”, “Number of initial registration requests “: “100”, “Number of successful initial registrations”: “100”, “Number of mobility registration update requests”: “100”, “Number of successful mobility registration updates”: “100”, “Number of periodic registration update requests”: “100”, “Number of successful periodic registration updates”: “100” } ] } ] } ] }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": 1 }
Description

Enable, Disable KPI collection

A sample response below

{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “kpi_status”: “active” } ] } ] } }

Headers
KeyValueDescription
AuthorizationBearer { your_token }
Body
{ "version": "1", "user_id": "1", "site_id": "100", "node_id": 1, "kpi_status": "enable" }

Available Variables 2

KeyValueType
tokentesttoken
base_urlhttps://5gsoftware.com/