Metadata list | ||
---|---|---|
| ||
||Product on coverpage|SBC Core| ||Product Release|10.x| ||Document Title|REST API Reference Guide - global| ||Document Number|550-xxxx| ||Document Revision|01.01| ||Filename|global_01| |
|
Parameter | Presence | Type | Default | Description | |
---|---|---|---|---|---|
![]() | license | O | License data. | ||
![]() | system | O | Global system objects. | ||
![]() | cac | O | Global CAC objects. | ||
![]() | callRouting | O | Global call routing objects. | ||
![]() | qoeCallRouting | O | QOE based call routing. | ||
![]() | servers | O | Global server objects. | ||
![]() | signaling | O | Global Signaling objects | ||
![]() | sipOod | O | Out-Of-Dialog Message Config Data. | ||
![]() | security | O | Global security objects. | ||
![]() | policyServer | O | Policy Server Statistics | ||
![]() | saveRecentCallFlowsInMemory | O | Recent call flow storage | ||
![]() | callQueuing | O | call queuing. | ||
![]() | callTrace | O | Call Trace Group configuration for the Node. | ||
![]() | monitorEndpoint | O | the monitor endpoint (MCT) | ||
![]() | mediaCapture | O | |||
![]() | siprec | O | Initiates Media Recording with siprec protocol. | ||
![]() | monitorTarget | O | the monitor target | ||
![]() | carrier | O | Carrier definitions. | ||
![]() | sipDomain | O | SIP Domain. | ||
![]() | subscriber | O | Subscriber. | ||
![]() | country | O | Country definitions. | ||
![]() | npaNxx | O | Npa Nxx. |
Parameter | Description | |
---|---|---|
![]() | activeRegistrationDumpStatus | Current Status for the dump of activeRegistration |
![]() | deletedRegistrationDumpStatus | Current Status for the dump of deletedRegistration |
![]() | generatedSubscriptionDumpStatus | Current Status for the dump of generatedSubscription |
![]() | callCountCurrentStatistics | The global current call count statistics. |
![]() | callCountIntervalStatistics | Global interval call count statistics. |
![]() | serviceAuthorisedCurStats | The global current service authorisation statistics. |
![]() | serviceAuthorisedIntStats | Global interval service authorisation statistics. |
![]() | oodMessageCurrentStatistics | The global current out-of-dialog message statistics. |
![]() | oodMessageIntervalStatistics | Global interval OOD message statistics. |
![]() | facBlockingEntriesStatistics | The global statistics shows how many number of packets dropped due to each existing blocking entry. |
![]() | facCurrentblockingEntries | The status command shows all current blocking entries. |
![]() | facTotalBlockCountStats | The stats shows total number of packets dropped due to all blocking entries. This count will be reset on restart of the SBC. |
![]() | facFaultRecords | The current list of fault |
Records in the SBC. | ||
![]() | ipGeneralGroupStatistics | The collection of IP General Group information for the specified instance. |
![]() | icmpGeneralGroupStatistics | The collection of ICMP General Group information for the specified instance. |
![]() | tcpGeneralGroupStatistics | The collection of TCP General Group information for the specified instance. |
![]() | udpGeneralGroupStatistics | The collection of UDP General Group information for the specified instance. |
![]() | callSummaryStatus | Call Summary status table. |
![]() | callDetailStatus | Call Detail status table. |
![]() | callMediaStatus | Call Media status table. |
![]() | callResourceDetailStatus | Call Resource Detail Status Table. |
![]() | callRemoteMediaStatus | Call Remote Media Status Table. |
![]() | callCountStatus | Call count statistics for the server. |
![]() | ocsCallCountStatus | Call count statistics for the server. |
![]() | srvccCallCountStatus | srvcc Call count statistics for the server. |
![]() | callTraceStatus | Call Trace detail status. |
![]() | globalTrunkGroupStatus | Status for IP trunk groups in this zone. |
![]() | dtlsSrtpStatistics | DTLS SRTP Handshake statistics. |
![]() | monitorEndpointStatus | The status of the MCT setting. |
![]() | monitorTargetStatus | the status of the monitor target |
![]() | SipRecStatus | List of calls which are being recorded through siprec. |
![]() | script | Default scripts for call control. |
Operation Name | Description |
---|---|
callCountReset | set operation on this object resets all the statistics counts to zero |
terminateCall | terminates the call based on the gcid supplied |
dnsClearCache | Clear the Full Cache. |
deleteAllFaultRecords | delete all fault records. |
dumpActiveRegistration | Dump the active SIP registration status |
dumpDeletedRegistration | Dump the Deleted Registrations status |
dumpGeneratedSubscription | Dump the Generated Subscription status |
REST API: GET Example |
---|
curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/global |