SBC 1000/2000 API User's Guide
The concepts every developer should know before interacting with the API. (Clicking on this link will take you back to the latest SBC 1000/2000 customer documentation space).
Application Error Codes
Cause Codes - Reference
- Q.850 Cause Codes - Reference — This page lists the Q.850 Cause Codes and their associated definition configurable on the SBC 1000/2000 (UX) system via the SIP to Q.850 Cause Code Mapping and Q.850 Cause Code to SIP Mapping resources.
- SIP Response Codes - Reference — This page lists the SIP Response Codes and their associated definition configurable on the SBC 1000/2000 (UX) system via the SIP to Q.850 Cause Code Mapping and Q.850 Cause Code to SIP Mapping resources.
Names of Ethernet Ports and Logical Interfaces
Table reference to associate the 'ifName' attribute of an Ethernet port or Logical Interface to the common / user-friendly name.
TimeZoneGeoName - Reference
Table reference for associating the timezone name with a location.
Resource - aclrule
Defines an Access Control Rule managed object.
- DELETE acltable id - aclrule id
- GET acltable id - aclrule
- GET acltable id - aclrule id
- POST acltable id - aclrule id
- PUT acltable id - aclrule id
Resource - acltable
Defines an Access Control List managed object.
Resource - actionconfig
Defines an Action Configuration Table to be used in an Action Set Table Entry.
Resource - actionsetentry
Defines an Action Set Entry resource to describe a given Action Set Table. Action Set Entries can be configured to use one or more Action Configurations
- DELETE actionsettable id - actionsetentry id
- GET actionsettable id - actionsetentry
- GET actionsettable id - actionsetentry id
- POST actionsettable id - actionsetentry id
- PUT actionsettable id - actionsetentry id
Resource - actionsettable
Defines an Action Set Table to be used in a Signaling Group.
- DELETE actionsettable id
- GET actionsettable
- GET actionsettable id
- POST actionsettable id
- PUT actionsettable id
Resource - activealarm
The Active Alarm resource defines all active alarms present on the SBC Edge.
- GET activealarm
- GET activealarm id
- POST activealarm - action ack
- POST activealarm - action clear
- POST activealarm - action unack
Resource - adconfig
Defines the Active Directory Config resource controls the SBC Edge system's Active Directory configuration settings. Settings related to specific AD Controllers are controlled through the Domain Controller Resource
Resource - applylogprofile
This action retrieves subsystems present in the selected log profile and applies on logger subsystem configuration with given log destination.
Resource - arpcache
Defines a ARP Cache runtime managed object.
Resource - asmaclrule
Defines a Windows Firewall Rule on ASM
Resource - asmfactoryimage
Defines Managed Object for the ASM Factory Images. These images are used to re-initialize the ASM.
Resource - asmlyncevent
Defines Managed Object for Lync Events on ASM
- POST asmlyncevent - action clearlog
- POST asmlyncevent - action exportlog
- POST asmlyncevent - action exportlogrange
Resource - asmsystemevent
Defines Managed Object for System Events on ASM
- POST asmsystemevent - action clearlog
- POST asmsystemevent - action exportlog
- POST asmsystemevent - action exportlogrange
Resource - asmvirtualmachine
Defines a Virtual Machine on ASM
- GET asmvirtualmachine
- GET asmvirtualmachine id
- POST asmvirtualmachine - action vmaction
- POST asmvirtualmachine - action vmupdate
Resource - bricard
Defines a Basic Rate Interface (BRI) Line Card Managed Object
Resource - bridge
The Bridge Group Table resource controls the SBC 2000 system's bridge group and MST Instance configuration settings.
Resource - cacprofile
Defines the Lync CAC Profile Managed Object
Resource - cassg
Defines an CAS Signaling Group Table for an CAS protocol connection (digital or analog) on the SBC Edge system.
- DELETE cassg id
- GET cassg
- GET cassg historicalstatistics
- GET cassg historicalstatistics id
- GET cassg id
- POST cassg - action resetcounters
- POST cassg id
- PUT cassg id
Resource - cceactionstatus
The CCE Action Status allows the user to query the status of an action performed on the CCE. Some of the actions on the CCE take some time, so this resource helps to query the status of the action performed while it is going on till it is completed or fails.
Resource - certificate
Defines the Certificates resource containing the certificate configuration settings on the SBC Edge system.
- DELETE certificate id
- GET certificate
- GET certificate id
- POST certificate - action download
- POST certificate - action export12
- POST certificate - action import
- POST certificate - action import12
Resource - chassis
Defines Chassis Managed Object
Resource - checkport
Defines Connectivity Check Managed Object.
Resource - compandinglaw
Defines the CompandingLaw resource for SBC 1000 TDM and analog Telco interfaces.
Resource - corefile
This resource defines the core files on the SBC Edge system.
Resource - csr
Defines a Certificate Signing Request resource allowing you to generate certificates via the SBC Edge system.
Resource - decodelicense
Defines the Decode License resource allowing you to decode a License Key and viewing its available feature licenses and their state.
Resource - dhcpleaseclient
Defines a DHCP Lease Client runtime managed object.
Resource - dhcppool
Defines a DHCP Pool managed object.
Resource - dhcpstaticclient
Defines a DHCP Static Client managed object.
- DELETE dhcpstaticclient id
- GET dhcpstaticclient
- GET dhcpstaticclient id
- POST dhcpstaticclient id
- PUT dhcpstaticclient id
Resource - diskpartition
Defines Disk Partition runtime managed object.
Resource - domaincontroller
The Acive Directory Domain Controller resource contains settings for the domain controllers used by the Active Directory Configuration.
- DELETE domaincontroller id
- GET domaincontroller
- GET domaincontroller id
- POST domaincontroller id
- PUT domaincontroller id
Resource - ds1callinfo
Defines DS1 Call Info Managed Object
Resource - ds1channel
Defines DS1 Channel Managed Object
- GET linecard id - telcods1port id - ds1channel
- GET linecard id - telcods1port id - ds1channel id
- POST ds1channel - action block
- POST ds1channel - action reset
- POST ds1channel - action unblock
Resource - ds1portgroup
The DS1 Port Group resource allows the user to configure the SBC Edge system's DS1 port types. It is only applicable on systems which include DS1 interfaces.
Resource - dspcard
Defines DSP Card Managed Object
Resource - dtlsprofile
Defines a DTLS-SRTP Profile used by the Media List Profile Table.
Resource - emergencysvccallbktable
Defines a Callback Number List Table resource to be used for emergency services.
- DELETE emergencysvccallbktable id
- GET emergencysvccallbktable
- GET emergencysvccallbktable id
- POST emergencysvccallbktable id
- PUT emergencysvccallbktable id
Resource - emergencysvccallstats
Defines an Emergency Call Statistics resource to be used to get emergency calls statistics.
Resource - emergencysvccallstatus
Defines an Emergency Call Status Table resource to be used to get emergency calls status.
Resource - emergencysvcconfig
Defines an Emergency Services Config resource to be used for emergency services configuration.
Resource - enmsignalingprofile
Defines a CAS E and M Signaling Profile to be used in a CAS Signaling Group
- DELETE enmsignalingprofile id
- GET enmsignalingprofile
- GET enmsignalingprofile id
- POST enmsignalingprofile id
- PUT enmsignalingprofile id
Resource - ethernetport
The Ethernet Port Table resource controls the SBC Edge system's ethernet port configuration settings.
- DELETE ethernetport id
- GET ethernetport
- GET ethernetport historicalstatistics
- GET ethernetport historicalstatistics id
- GET ethernetport id
- POST ethernetport id
Resource - eventhistory
The Event History resource defines the chronological list of the last 500 alarms and events in the SBC Edge.
Resource - fan
Defines a Fan resource in the SBC system.
Resource - faxcodecprofile
Defines a FAX Codec Profile used by the Media List Profile Table.
- DELETE faxcodecprofile id
- GET faxcodecprofile
- GET faxcodecprofile id
- POST faxcodecprofile id
- PUT faxcodecprofile id
Resource - fxocard
Defines a Foreign Exchange Office (FXO) Line Card Managed Object
Resource - fxosignalingprofile
Defines a CAS FXO Signaling Profile to be used in a CAS Signaling Group
- DELETE fxosignalingprofile id
- GET fxosignalingprofile
- GET fxosignalingprofile id
- POST fxosignalingprofile id
- PUT fxosignalingprofile id
Resource - fxscard
Defines a Foreign Exchange Subscriber (FXS) Line Card Managed Object
Resource - fxschannel
Defines FXS Channel Managed Object
Resource - fxslocallooptype
The FXS Local Loop Type resource allows the user to set the SBC Edge system's FXS ports to support long local loop. It is only applicable to systems with FXS interfaces.
Resource - fxsport
Defines a FXS Port resource which controls the FXS Port
- GET fxscard id - fxsport
- GET fxscard id - fxsport id
- POST fxscard id - fxsport id
- POST fxsport - action resetcounters
Resource - fxssignalingprofile
Defines a CAS FXS Signaling Profile to be used in a CAS Signaling Group
- DELETE fxssignalingprofile id
- GET fxssignalingprofile
- GET fxssignalingprofile id
- POST fxssignalingprofile id
- PUT fxssignalingprofile id
Resource - globalsecurityoptions
Defines the Global User Security Options which defines password complexity requirements and password lifetime.
Resource - highestalarm
The Highest Alarm resource defines the highest severity alarm present on the SBC Edge.
Resource - hosts
Defines Hosts resource for configuring local map of host names and their IP addresses
Resource - ipsecstatistics
IPsec connection statistics
Resource - ipsectunnel
Defines the IPsec Tunnel Managed Object
Resource - ipv6aclrule
Defines an IPv6 Access Control Rule managed object.
- DELETE ipv6acltable id - ipv6aclrule id
- GET ipv6acltable id - ipv6aclrule
- GET ipv6acltable id - ipv6aclrule id
- POST ipv6acltable id - ipv6aclrule id
- PUT ipv6acltable id - ipv6aclrule id
Resource - ipv6acltable
Defines an IPv6 Access Control List managed object.
Resource - isdnsg
Defines an ISDN Signaling Group Table for an ISDN protocol connection on the SBC Edge system.
- DELETE isdnsg id
- GET isdnsg
- GET isdnsg historicalstatistics
- GET isdnsg historicalstatistics id
- GET isdnsg id
- POST isdnsg - action resetcounters
- POST isdnsg id
- PUT isdnsg id
Resource - license
Defines the License resource containing information about the feature licenses on the SBC Edge system and their availability.
Resource - licensekey
The License Key resource allows you to install and retrieve the licenses keys installed on the SBC Edge system.
Resource - linecard
Defines a Telco DS1 Line Card Managed Object
Resource - linkmonitor
Defines the Link Monitor Managed Object
- DELETE linkmonitor id
- GET linkmonitor
- GET linkmonitor id
- POST linkmonitor - action resetlinkmonitorcounters
- POST linkmonitor id
- PUT linkmonitor id
Resource - linkmonitorcounters
Displays a Link Monitor Counters for a given parent Link Monitor.
Resource - locallogfile
This resource defines the local log files on the SBC 2000 system.
Resource - localuser
Defines the Local Users Table resource containing local user credentials and access rights on the SBC Edge system.
Resource - logger
Defines Subsystem Logger Managed Object
Resource - logicalinterface
Defines Logical Interface Managed Object
Resource - login
Defines the Login resource used to login to the SBC Edge REST API. This is the first request that needs to be made before you can access any of the other REST Resources on the SBC Edge system.
Resource - logout
Defines the Logout resource used to logout from the SBC Edge REST service. Once a logout request is successfully made, the SBC Edge REST session terminates and becomes invalid.
Resource - logprofilestable
Defines Log Profile Managed Object.
- DELETE id
- DELETE logprofilestable id
- GET
- GET id
- GET logprofilestable
- GET logprofilestable id
- POST id
- POST logprofilestable id
- PUT id
- PUT logprofilestable id
Resource - logsubsystemsentry
Defines a Log Profile Subsystems resource to describe a given Log Profile Table.
- DELETE logprofilestable id - logsubsystemsentry id
- GET logprofilestable id - logsubsystemsentry
- GET logprofilestable id - logsubsystemsentry id
- POST logprofilestable id - logsubsystemsentry id
- PUT logprofilestable id - logsubsystemsentry id
Resource - media
Defines the Media System Configuration resource controlling the RTP/RTCP Port Range, Packet Latency settings on the SBC Edge system, NLP control, and MOH service configuration.
- GET media
- GET media historicalstatistics
- GET media historicalstatistics id
- POST media
- POST media - action uploadmusicfile
Resource - mediacryptoprofile
Defines a SDES-SRTP Profile used by the Media List Profile Table.
- DELETE mediacryptoprofile id
- GET mediacryptoprofile
- GET mediacryptoprofile id
- POST mediacryptoprofile id
- PUT mediacryptoprofile id
Resource - medialistprofile
Defines a Media List Profile Table resource to be used in a Signaling Group.
- DELETE medialistprofile id
- GET medialistprofile
- GET medialistprofile id
- POST medialistprofile id
- PUT medialistprofile id
Resource - messagetransentry
Defines a Message Translation Entry resource to describe a given [Message Translation Table.
- DELETE messagetranstable id - messagetransentry id
- GET messagetranstable id - messagetransentry
- GET messagetranstable id - messagetransentry id
- POST messagetranstable id - messagetransentry id
- PUT messagetranstable id - messagetransentry id
Resource - messagetranstable
Defines a Message Translation Table resource to be used in a Call Routing Entry.
- DELETE messagetranstable id
- GET messagetranstable
- GET messagetranstable id
- POST messagetranstable id
- PUT messagetranstable id
Resource - mstiportstats
Status and statistics of a port associated with the MST Instance.
- GET bridge id - mstiportstats
- GET bridge id - mstiportstats id
- POST mstiportstats - action resetcounters
Resource - mstp
Defines the MST Instance Managed Object.
- DELETE bridge id - mstp id
- GET bridge id - mstp
- GET bridge id - mstp id
- POST bridge id - mstp id
- PUT bridge id - mstp id
Resource - natinterface
The NAT Interface resource controls the SBC Edge system's NAT Interface configuration settings.
Resource - natportforward
The NAT Port Forward resource controls the SBC Edge system's NAT Port Forward configuration settings.
- DELETE natportforward id
- GET natportforward
- GET natportforward id
- POST natportforward id
- PUT natportforward id
Resource - ospfconfig
The OSPF Config allows the user to configure OSPF protocol on selected network address
Resource - packetcapture
Defines packet capture managed object.
- GET packetcapture
- POST packetcapture - action enablecapture
- POST packetcapture - action startcapture
- POST packetcapture - action stopcapture
Resource - partition
Defines Partition Managed Object
Resource - pcapfiles
This resource defines the PCAP files on the SBC Edge system.
Resource - portmembership
Defines Port Membership (tagged VLAN) Managed Object.
Resource - portmirror
Defines Port Mirror Config resource for configuring port mirror feature.
Resource - postlogcontent
This resource defines the hardware POST(Power On Self Test) results log file in the SBC Edge system.
Resource - postloginmessage
Defines the Post-Login Message used to configure the SBC Edge system's message to be displayed after logging in to the Web User Interface.
Resource - powersupply
Defines a Power Supply resource in the SBC system.
Resource - preloginmessage
Defines the Pre-Login Message resource allowing you to configure the SBC Edge system's message displayed before logging into the Web User Interface
Resource - processstats
Defines Process Statistics runtime managed object.
Resource - q850tosipmapping
Defines a Q.850 Cause Code to SIP Mapping Entry respource to describe a given Q.850 to SIP Override Table.
- DELETE q850tosipmappingtable id - q850tosipmapping id
- GET q850tosipmappingtable id - q850tosipmapping
- GET q850tosipmappingtable id - q850tosipmapping id
- POST q850tosipmappingtable id - q850tosipmapping id
- PUT q850tosipmappingtable id - q850tosipmapping id
Resource - q850tosipmappingtable
Defines a Q.850 to SIP Override Table to be used in a SIP Signaling Group.
- DELETE q850tosipmappingtable id
- GET q850tosipmappingtable
- GET q850tosipmappingtable id
- POST q850tosipmappingtable id
- PUT q850tosipmappingtable id
Resource - qoe
Defines QoE Managed Object
Resource - r2signalingprofile
Defines a CAS R2 Signaling Profile to be used in a CAS Signaling Group
- DELETE r2signalingprofile id
- GET r2signalingprofile
- GET r2signalingprofile id
- POST r2signalingprofile id
- PUT r2signalingprofile id
Resource - radiusconfig
The Radius Configuration resource controls the SBC Edge system's Radius configuration settings.
Resource - radiusserver
The Radius Server resource contains settings for the radius servers used by the Radius Configuration.
- DELETE radiusserver id
- GET radiusserver
- GET radiusserver id
- POST radiusserver - action resetcounters
- POST radiusserver id
- PUT radiusserver id
Resource - registrantstatus
Defines SIP Contact Registration Status Managed Object
- GET sipcontactregistrant id - sipregistrantentry id - registrantstatus
- GET sipcontactregistrant id - sipregistrantentry id - registrantstatus id
Resource - relay
Defines the resource for Digital (DS1) Relay that controls the DS1 port pair relay capability on the SBC Edge system.
Resource - remotelog
Defines The Remote Log Configuration Table resource contains the SBC Edge system's remote log servers configuration settings.
Resource - reroutetable
Defines the Cause Code Reroute Table resource to be used in a Call Routing Entry.
Resource - restarthistory
This resource defines the restart history log file on the SBC Edge system.
Resource - ribbonprotectbadactors
Defines Ribbon Protect Bad Actors managed object.
- DELETE ribbonprotectbadactors id
- GET ribbonprotectbadactors
- GET ribbonprotectbadactors id
- POST ribbonprotectbadactors id
- PUT ribbonprotectbadactors id
Resource - ripconfig
The RIP Config allows the user to configure RIP protocol on selected interfaces
Resource - routingentry
Defines a telephony Routing Entry resource to describe a given Routing Table.
- DELETE routingtable id - routingentry id
- GET routingentry historicalstatistics
- GET routingentry historicalstatistics id
- GET routingtable id - routingentry
- GET routingtable id - routingentry id
- POST routingtable id - routingentry id
- PUT routingtable id - routingentry id
Resource - routingtable
Defines telephony Routing Table to be used in a Signaling Group.
Resource - savelogprofile
This action saves the subsystems from the logger configuration as a new log profile.
Resource - sbaactionstatus
The SBA Action Status allows the user to query the status of an action performed on the SBA. Many of the actions on the SBA take some time, so this resource helps to query the status of the action performed while it is going on till it is completed or fails.
Resource - sbaconfig
Defines SBA or CCE Singleton Managed Object.
- GET sbaconfig
- POST sbaconfig
- POST sbaconfig - action activatewithlync
- POST sbaconfig - action applysectemplate
- POST sbaconfig - action asmpoweron
- POST sbaconfig - action asmreboot
- POST sbaconfig - action asmreinitialize
- POST sbaconfig - action asmreset
- POST sbaconfig - action asmshutdown
- POST sbaconfig - action asmupdaterecoverypartition
- POST sbaconfig - action configurecce
- POST sbaconfig - action deploy
- POST sbaconfig - action deploycce
- POST sbaconfig - action disablesvc
- POST sbaconfig - action downloadcceconfig
- POST sbaconfig - action enablesvc
- POST sbaconfig - action exportccep12key
- POST sbaconfig - action exportp12key
- POST sbaconfig - action importccep12key
- POST sbaconfig - action importp12key
- POST sbaconfig - action installccecert
- POST sbaconfig - action installcert
- POST sbaconfig - action installwindowsupdates
- POST sbaconfig - action joindomain
- POST sbaconfig - action sbaupgrade
- POST sbaconfig - action startreplication
- POST sbaconfig - action unjoindomain
- POST sbaconfig - action uploadcceconfig
Resource - sbacsr
Defines a SBA Certificate Signing Request resource allowing you to generate certificate via the SBC Edge system for the SBA.
Resource - sbainstalledpackage
Defines Managed Object for Installed Packages on SBA/ASM
Resource - securitylogfile
This resource defines the security log files on the SBC 2000 system.
Resource - session
The Active User Sessions Table resource contains the user sessions existing on the SBC Edge system. The sessions are created when users log in.
Resource - sgpeer
Defines a Linked Signaling Group Table.
Resource - sipcallinfo
Defines SIP Call Info Managed Object
Resource - sipcfgcacprofile
Defines globally-applicable SIP Settings: CAC Admin Status and Lync Presence.
Resource - sipchannel
Defines SIP Channel Managed Object
- GET sipsg id - sipchannel
- GET sipsg id - sipchannel id
- POST sipchannel - action block
- POST sipchannel - action reset
- POST sipchannel - action unblock
Resource - sipcontactregistrant
Defines SIP Contact Registrant Table Managed Object
- DELETE sipcontactregistrant id
- GET sipcontactregistrant
- GET sipcontactregistrant id
- POST sipcontactregistrant id
- PUT sipcontactregistrant id
Resource - siplocalauthentry
Defines a SIP Local Passthrough Authorization Entry resource to describe a given SIP Local Passthrough Authorization Table.
- DELETE siplocalauthtable id - siplocalauthentry id
- GET siplocalauthtable id - siplocalauthentry
- GET siplocalauthtable id - siplocalauthentry id
- POST siplocalauthtable id - siplocalauthentry id
- PUT siplocalauthtable id - siplocalauthentry id
Resource - siplocalauthtable
Defines a SIP Local Passthrough Authorization Table to be used in a SIP Signaling Group.
- DELETE siplocalauthtable id
- GET siplocalauthtable
- GET siplocalauthtable id
- POST siplocalauthtable id
- PUT siplocalauthtable id
Resource - siplocalregistrarentry
Defines SIP Registrar User Managed Object
- GET siplocalregistrartable id - siplocalregistrarentry
- GET siplocalregistrartable id - siplocalregistrarentry id
Resource - siplocalregistrartable
Defines a SIP Local Registrar Table to be used in a SIP Signaling Group.
- DELETE siplocalregistrartable id
- GET siplocalregistrartable
- GET siplocalregistrartable historicalstatistics
- GET siplocalregistrartable historicalstatistics id
- GET siplocalregistrartable id
- POST siplocalregistrartable - action resetcounters
- POST siplocalregistrartable id
- PUT siplocalregistrartable id
Resource - sipnatprefix
Defines a SIP Qualified NAT Prefix Entry resource to describe a given SIP Qualified NAT Prefix Table.
- DELETE sipnatprefixtable id - sipnatprefix id
- GET sipnatprefixtable id - sipnatprefix
- GET sipnatprefixtable id - sipnatprefix id
- POST sipnatprefixtable id - sipnatprefix id
- PUT sipnatprefixtable id - sipnatprefix id
Resource - sipnatprefixtable
Defines a SIP Qualified NAT Prefix Table to be used in a SIP Signaling Group.
- DELETE sipnatprefixtable id
- GET sipnatprefixtable
- GET sipnatprefixtable id
- POST sipnatprefixtable id
- PUT sipnatprefixtable id
Resource - sipprofile
Defines a SIP Profile Table to be used in a SIP Signaling Group.
Resource - sipregistrantentry
Defines SIP Contact Registrant Entry Managed Object
- DELETE sipcontactregistrant id - sipregistrantentry id
- GET sipcontactregistrant id - sipregistrantentry
- GET sipcontactregistrant id - sipregistrantentry id
- POST sipcontactregistrant id - sipregistrantentry id
- PUT sipcontactregistrant id - sipregistrantentry id
Resource - sipremoteauthentry
Defines a SIP Remote Authorization Entry resource to describe a given SIP Remote Authorization Table.
- DELETE sipremoteauthtable id - sipremoteauthentry id
- GET sipremoteauthtable id - sipremoteauthentry
- GET sipremoteauthtable id - sipremoteauthentry id
- POST sipremoteauthtable id - sipremoteauthentry id
- PUT sipremoteauthtable id - sipremoteauthentry id
Resource - sipremoteauthtable
Defines a SIP Remote Authorization Table to be used in a SIP Signaling Group.
- DELETE sipremoteauthtable id
- GET sipremoteauthtable
- GET sipremoteauthtable id
- POST sipremoteauthtable id
- PUT sipremoteauthtable id
Resource - sipserver
Defines a SIP Server Entry resource to describe a given SIP Server Table.
- DELETE sipservertable id - sipserver id
- GET sipservertable id - sipserver
- GET sipservertable id - sipserver id
- POST sipserver - action resetcounters
- POST sipservertable id - sipserver id
- PUT sipservertable id - sipserver id
Resource - sipservertable
Defines a SIP Server Table to be used in a SIP Signaling Group.
- DELETE sipservertable id
- GET sipservertable
- GET sipservertable id
- POST sipservertable id
- PUT sipservertable id
Resource - sipsettings
Defines globally-applicable SIP Settings: CAC Admin Status, Lync Presence, Untrusted INVITE Alarm and Lync Edge Server.
Resource - sipsg
Defines a SIP Signaling Group Table for a SIP protocol connection on the SBC Edge system.
- DELETE sipsg id
- GET sipsg
- GET sipsg id
- POST sipsg - action resetcounters
- POST sipsg - action sipadupdate
- POST sipsg id
- PUT sipsg id
Resource - sipsgsession
Defines the SIP SG Sessions Data Managed Object
Resource - sipsgsubscriberdata
Defines the SIP SG Subscriber Data Managed Object
Resource - siptlsprofile
Defines a TLS Profile Table to be used in a SIP Signaling Group.
- DELETE siptlsprofile id
- GET siptlsprofile
- GET siptlsprofile id
- POST siptlsprofile id
- PUT siptlsprofile id
Resource - siptoq850mapping
Defines a SIP to Q.850 Cause Code Mapping Entry respource to describe a given SIP to Q.850 Override Table.
- DELETE siptoq850mappingtable id - siptoq850mapping id
- GET siptoq850mappingtable id - siptoq850mapping
- GET siptoq850mappingtable id - siptoq850mapping id
- POST siptoq850mappingtable id - siptoq850mapping id
- PUT siptoq850mappingtable id - siptoq850mapping id
Resource - siptoq850mappingtable
Defines a SIP to Q.850 Override Table to be used in a SIP Signaling Group.
- DELETE siptoq850mappingtable id
- GET siptoq850mappingtable
- GET siptoq850mappingtable id
- POST siptoq850mappingtable id
- PUT siptoq850mappingtable id
Resource - siptrunkgroup
Defines a SIP Trunk Group Managed Object
- DELETE siptrunkgroup id
- GET siptrunkgroup
- GET siptrunkgroup id
- POST siptrunkgroup id
- PUT siptrunkgroup id
Resource - sipvoicequalityserver
Defines a SIP Voice Quality Server.
- GET sipvoicequalityserver
- POST sipvoicequalityserver
- POST sipvoicequalityserver - action resetvoicequalitycounters
Resource - snmptargetaddress
The SNMP Management Addresses Table resource configures SNMP host systems and their associated community strings to communicate with the SBC Edge, and controls whether it will send the traps to each host.
- DELETE snmptargetaddress id
- GET snmptargetaddress
- GET snmptargetaddress id
- POST snmptargetaddress id
- PUT snmptargetaddress id
Resource - splitdns
Defines SplitDns resource for configuring local map of domain names and DNS servers for resolving queries in those domains
- DELETE splitdnslist id - splitdns id
- GET splitdnslist id - splitdns
- GET splitdnslist id - splitdns id
- PUT splitdnslist id - splitdns id
Resource - splitdnslist
Defines a Split DNS List, for Split DNS Entries on the SBC Edge system.
Resource - spmconditionrule
Defines a Protocol Repair Condition Rule to be used in a Header Rule, a Request Line Rule, a Status Line Rule or a Raw Message Rule.
- DELETE spmconditionrule id
- GET spmconditionrule
- GET spmconditionrule id
- POST spmconditionrule id
- PUT spmconditionrule id
Resource - spmelementdescriptor
Defines a Protocol Repair Element Descriptor to be used in a Header Rule, a Request Line Rule, or a Status Line Rule. Each of these resources defines an action to be made in a rule to a particular component of the rule.
- DELETE spmelementdescriptor id
- GET spmelementdescriptor
- GET spmelementdescriptor id
- PUT spmelementdescriptor id
Resource - spmheaderrule
Defines a Header Rule resource as an entry within a given Protocol Repair Message Table. Protocol Repair Message Tables contain Header Rules, Request Line Rules, and Status Line Rules. These are maintained within a Message Table by segregated ID ranges. Header Rule resources must have IDs within the range 1 through 1000.
- DELETE spmmessagetable id - spmheaderrule id
- GET spmmessagetable id - spmheaderrule
- GET spmmessagetable id - spmheaderrule id
- POST spmmessagetable id - spmheaderrule id
- PUT spmmessagetable id - spmheaderrule id
Resource - spmmessagetable
Defines a Protocol Repair Message Table to be used in a SIP Signaling Group. Protocol Repair Message Tables contain Header Rules, Request Line Rules, Status Line Rules and Raw Message Rules. These are maintained within a Message Table by segregated ID ranges.
- DELETE spmmessagetable id
- GET spmmessagetable
- GET spmmessagetable id
- POST spmmessagetable id
- PUT spmmessagetable id
Resource - spmrawmessagerule
Defines a Raw Message Rule resource as an entry within a given Protocol Repair Message Table. This resource acts upon the raw SIP Message stream, and only supports regular expression replacement. Protocol Repair Message Tables contain Header Rules, Request Line Rules, Status Line Rules, and Raw Message Rules. These are maintained within a Message Table by segregated ID ranges. Raw Message Rule resources must have IDs within the range 4001 through 5000.
- DELETE spmmessagetable id - spmrawmessagerule id
- GET spmmessagetable id - spmrawmessagerule
- GET spmmessagetable id - spmrawmessagerule id
- POST spmmessagetable id - spmrawmessagerule id
- PUT spmmessagetable id - spmrawmessagerule id
Resource - spmrequestlinerule
Defines a Request Line Rule resource as an entry within a given Protocol Repair Message Table. Protocol Repair Message Tables contain Header Rules, Request Line Rules, and Status Line Rules. These are maintained within a Message Table by segregated ID ranges. Request Line Rule resources must have IDs within the range 2001 through 3000.
- DELETE spmmessagetable id - spmrequestlinerule id
- GET spmmessagetable id - spmrequestlinerule
- GET spmmessagetable id - spmrequestlinerule id
- POST spmmessagetable id - spmrequestlinerule id
- PUT spmmessagetable id - spmrequestlinerule id
Resource - spmstatuslinerule
Defines a Status Line Rule resource as an entry within a given Protocol Repair Message Table. Protocol Repair Message Tables contain Header Rules, Request Line Rules, and Status Line Rules. These are maintained within a Message Table by segregated ID ranges. Status Line Rule resources must have IDs within the range 3001 through 4000.
- DELETE spmmessagetable id - spmstatuslinerule id
- GET spmmessagetable id - spmstatuslinerule
- GET spmmessagetable id - spmstatuslinerule id
- POST spmmessagetable id - spmstatuslinerule id
- PUT spmmessagetable id - spmstatuslinerule id
Resource - staticarp
Defines Static ARP Managed Object
Resource - staticiproute
Defines Static Route Managed Object.
Resource - staticipv6neighbor
Defines the Static IPv6 Neighbor Managed Object
- DELETE staticipv6neighbor id
- GET staticipv6neighbor
- GET staticipv6neighbor id
- PUT staticipv6neighbor id
Resource - staticipv6route
Defines the IPv6 Static Route Managed Object.
Resource - supplementarycertificate
Defines Supplementary Certificate managed object.
- DELETE supplementarycertificate id
- GET supplementarycertificate
- GET supplementarycertificate id
- POST supplementarycertificate - action download
- POST supplementarycertificate - action export12
- POST supplementarycertificate - action import
- POST supplementarycertificate - action import12
Resource - supplementarysvcprofile
Defines a CAS Supplementary Service Profile to be used in a CAS Signaling Group
- DELETE supplementarysvcprofile id
- GET supplementarysvcprofile
- GET supplementarysvcprofile id
- POST supplementarysvcprofile id
- PUT supplementarysvcprofile id
Resource - system
Defines The System resource that controls node-level configuration settings on the SBC Edge system.
- GET system
- GET system historicalstatistics
- GET system historicalstatistics id
- POST system
- POST system - action backup
- POST system - action exportconfig
- POST system - action exporttranstable
- POST system - action factorydefault
- POST system - action factorydefaultpartial
- POST system - action importconfig
- POST system - action importtranstable
- POST system - action ipsecrestartservice
- POST system - action reboot
- POST system - action restore
- POST system - action runsystemvitalsscript
- POST system - action setdatetime
Resource - systemcallstats
Defines System Call Statistics Managed Object
Resource - systemlog
The Local Log resource defines the logging level setting for the local log.
Resource - systemvitalslogfile
This resource defines the system vitals log files on the SBC Edge system.
Resource - tca
Defines a Threshold Crossing Alert defined in the SBC Edge system.
Resource - telcobriport
Defines a remote BRI Port resource on the SBC Edge system.
- DELETE bricard id - telcobriport id
- GET bricard id - telcobriport
- GET bricard id - telcobriport id
- POST bricard id - telcobriport id
- POST telcobriport - action resetcounters
Resource - telcods1port
Defines a remote DS1 Port resource that controls the SBC Edge system's T1/E1 ports.
- DELETE linecard id - telcods1port id
- GET linecard id - telcods1port
- GET linecard id - telcods1port id
- POST linecard id - telcods1port id
- POST telcods1port - action assertalarm
- POST telcods1port - action resetcounters
Resource - telcofxoport
Defines a FXO Port resource which controls the FXO Port
- GET fxocard id - telcofxoport
- GET fxocard id - telcofxoport id
- POST fxocard id - telcofxoport id
- POST telcofxoport - action resetcounters
Resource - timing
Defines the Timing resource that controls the system timing on the SBC Edge system.
Resource - toneprofile
Defines a Tone Profile resource to be used in a Tone Table.
Resource - tonetable
Defines a Tone Table resource to be used in a Signaling Group.
Resource - transformationentry
Defines a Transformation Entry resource to describe a given Transformation Table.
- DELETE transformationtable id - transformationentry id
- GET transformationtable id - transformationentry
- GET transformationtable id - transformationentry id
- POST transformationtable id - transformationentry id
- PUT transformationtable id - transformationentry id
Resource - transformationtable
Defines a Transformation Table to be used in a Call Routing Entry.
- DELETE transformationtable id
- GET transformationtable
- GET transformationtable id
- POST transformationtable id
- PUT transformationtable id
Resource - usergroup
The Active Directory Group to Access Level Mapping Table resource controls the way users in Active Directory can access the SBC Edge system based on their group membership.
Resource - vlan
Defines VLAN Managed Object.
- DELETE bridge id - vlan id
- GET bridge id - vlan
- GET bridge id - vlan id
- POST bridge id - vlan id
- POST vlan - action resetcounters
- PUT bridge id - vlan id
Resource - voicecodecprofile
Defines a Voice Codec Profile used by the Media List Profile Table.
- DELETE voicecodecprofile id
- GET voicecodecprofile
- GET voicecodecprofile id
- POST voicecodecprofile id
- PUT voicecodecprofile id
Resource - webaccesslogfile
This resource defines the web access log files on the SBC Edge system.
Resource - weberrorlogfile
This resource defines the web error log files on the SBC Edge system.
Resource - autoconfigtask
The Auto Configuration Task allows the user to configure settings for provisioning SBC Edge system from a BroadSoft Server.
Resource - initialsetup
Defines an initial setup resource in the SBC system. This is a unique one-time resource used to create an initial configuration for the node, after which the resource becomes unavailable.
Resource - modifydefaultvlan
The Modify Default VLAN allows the user to modify the Default Untagged VLAN of Ethernet Ports.