 |
Ribbon Documentation Portal will be unavailable Thursday February 2nd 2023 between 2:00 PM EST ~ 12:00 PM. More Info |
|
Ribbon Documentation Portal will be unavailable Thursday February 2nd 2023 between 2:00 PM EST ~ 12:00 PM. More Info |
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).
Table reference to associate the 'ifName' attribute of an Ethernet port or Logical Interface to the common / user-friendly name.
Table reference for associating the timezone name with a location.
Defines an Access Control Rule managed object.
Defines an Access Control List managed object.
Defines an Action Configuration Table to be used in an Action Set Table Entry.
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
Defines an Action Set Table to be used in a Signaling Group.
The Active Alarm resource defines all active alarms present on the SBC.
Defines the Active Directory Config resource controls the SBC's Active Directory configuration settings. Settings related to specific AD Controllers are controlled through the Domain Controller Resource
This action retrieves subsystems present in the selected log profile and applies on logger subsystem configuration with given log destination.
Defines a ARP Cache runtime managed object.
Defines a Windows Firewall Rule on ASM
Defines Managed Object for the ASM Factory Images. These images are used to re-initialize the ASM.
Defines Managed Object for Lync Events on ASM
This resource defines the ASM SBA log files on the SBC.
Defines Managed Object for System Events on ASM
Defines a Virtual Machine on ASM
Defines a Basic Rate Interface (BRI) Line Card Managed Object
The Bridge Group Table resource controls the SBC 2000 system's bridge group and MST Instance configuration settings.
Defines the Lync CAC Profile Managed Object
Defines an CAS Signaling Group Table for an CAS protocol connection (digital or analog) on the SBC.
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.
Defines the Certificates resource containing the certificate configuration settings on the SBC.
Defines Chassis Managed Object
Defines Connectivity Check Managed Object.
Defines the CompandingLaw resource for SBC 1000 TDM and analog Telco interfaces.
This resource defines the core files on the SBC.
Defines a Certificate Signing Request resource allowing you to generate certificates via the SBC.
Defines the Decode License resource allowing you to decode a License Key and viewing its available feature licenses and their state.
Defines a DHCP Lease Client runtime managed object.
Defines a DHCP Pool managed object.
Defines a DHCP Static Client managed object.
Defines Disk Partition runtime managed object.
The Acive Directory Domain Controller resource contains settings for the domain controllers used by the Active Directory Configuration.
Defines DS1 Call Info Managed Object
Defines DS1 Channel Managed Object
The DS1 Port Group resource allows the user to configure the SBC's DS1 port types. It is only applicable on systems which include DS1 interfaces.
Defines DSP Card Managed Object
Defines a DTLS-SRTP Profile used by the Media List Profile Table.
Defines a Callback Number List Table resource to be used for emergency services.
Defines an Emergency Call Statistics resource to be used to get emergency calls statistics.
Defines an Emergency Call Status Table resource to be used to get emergency calls status.
Defines an Emergency Services Config resource to be used for emergency services configuration.
Defines a CAS E and M Signaling Profile to be used in a CAS Signaling Group
The Ethernet Port Table resource controls the SBC's ethernet port configuration settings.
The Event History resource defines the chronological list of the last 500 alarms and events in the SBC.
Defines a Fan resource in the SBC system.
Defines a FAX Codec Profile used by the Media List Profile Table.
Defines a Foreign Exchange Office (FXO) Line Card Managed Object
Defines a CAS FXO Signaling Profile to be used in a CAS Signaling Group
Defines a Foreign Exchange Subscriber (FXS) Line Card Managed Object
Defines FXS Channel Managed Object
The FXS Local Loop Type resource allows the user to set the SBC's FXS ports to support long local loop. It is only applicable to systems with FXS interfaces.
Defines a FXS Port resource which controls the FXS Port
Defines a CAS FXS Signaling Profile to be used in a CAS Signaling Group
Defines the Global User Security Options which defines password complexity requirements and password lifetime.
The Highest Alarm resource defines the highest severity alarm present on the SBC.
Defines Hosts resource for configuring local map of host names and their IP addresses
IPsec connection statistics
Defines the IPsec Tunnel Managed Object
Defines an IPv6 Access Control Rule managed object.
Defines an IPv6 Access Control List managed object.
Defines an ISDN Signaling Group Table for an ISDN protocol connection on the SBC.
Defines the License resource containing information about the feature licenses on the SBC and their availability.
The License Key resource allows you to install and retrieve the licenses keys installed on the SBC.
Defines a Telco DS1 Line Card Managed Object
Defines the Link Monitor Managed Object
Displays a Link Monitor Counters for a given parent Link Monitor.
This resource defines the local log files on the SBC 2000 system.
Defines the Local Users Table resource containing local user credentials and access rights on the SBC.
Defines Subsystem Logger Managed Object
Defines Logical Interface Managed Object
Defines the Login resource used to login to the SBC 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.
Defines the Logout resource used to logout from the SBC's REST service. Once a logout request is successfully made, the SBC's REST session terminates and becomes invalid.
Defines Log Profile Managed Object.
Defines a Log Profile Subsystems resource to describe a given Log Profile Table.
Defines the Media System Configuration resource controlling the RTP/RTCP Port Range, Packet Latency settings on the SBC, NLP control, and MOH service configuration.
Defines a SDES-SRTP Profile used by the Media List Profile Table.
Defines a Media List Profile Table resource to be used in a Signaling Group.
Defines a Message Translation Entry resource to describe a given [Message Translation Table.
Defines a Message Translation Table resource to be used in a Call Routing Entry.
Status and statistics of a port associated with the MST Instance.
Defines the MST Instance Managed Object.
The NAT Interface resource controls the SBC's NAT Interface configuration settings.
The NAT Port Forward resource controls the SBC's NAT Port Forward configuration settings.
The OSPF Config allows the user to configure OSPF protocol on selected network address
Defines packet capture managed object.
Defines Partition Managed Object
This resource defines the PCAP files on the SBC.
Defines Port Membership (tagged VLAN) Managed Object.
Defines Port Mirror Config resource for configuring port mirror feature.
This resource defines the hardware POST(Power On Self Test) results log file in the SBC.
Defines the Post-Login Message used to configure the SBC's message to be displayed after logging in to the Web User Interface.
Defines a Power Supply resource in the SBC system.
Defines the Pre-Login Message resource allowing you to configure the SBC's message displayed before logging into the Web User Interface
Defines Process Statistics runtime managed object.
Defines a Q.850 Cause Code to SIP Mapping Entry respource to describe a given Q.850 to SIP Override Table.
Defines a Q.850 to SIP Override Table to be used in a SIP Signaling Group.
Defines QoE Managed Object
Defines a CAS R2 Signaling Profile to be used in a CAS Signaling Group
The Radius Configuration resource controls the SBC's Radius configuration settings.
The Radius Server resource contains settings for the radius servers used by the Radius Configuration.
Defines SIP Contact Registration Status Managed Object
Defines the resource for Digital (DS1) Relay that controls the DS1 port pair relay capability on the SBC.
Defines The Remote Log Configuration Table resource contains the SBC's remote log servers configuration settings.
Defines the Cause Code Reroute Table resource to be used in a Call Routing Entry.
This resource defines the restart history log file on the SBC.
Defines Ribbon Protect Bad Actors managed object.
The RIP Config allows the user to configure RIP protocol on selected interfaces
Defines a telephony Routing Entry resource to describe a given Routing Table.
Defines telephony Routing Table to be used in a Signaling Group.
This action saves the subsystems from the logger configuration as a new log profile.
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.
Defines SBA or CCE Singleton Managed Object.
Defines a SBA Certificate Signing Request resource allowing you to generate certificate via the SBC for the SBA.
Defines Managed Object for Installed Packages on SBA/ASM
This resource defines the security log files on the SBC 2000 system.
The Active User Sessions Table resource contains the user sessions existing on the SBC. The sessions are created when users log in.
Defines a Linked Signaling Group Table.
Defines SIP Call Info Managed Object
Defines globally-applicable SIP Settings: CAC Admin Status and Lync Presence.
Defines SIP Channel Managed Object
Defines SIP Contact Registrant Table Managed Object
Defines a SIP Local Passthrough Authorization Entry resource to describe a given SIP Local Passthrough Authorization Table.
Defines a SIP Local Passthrough Authorization Table to be used in a SIP Signaling Group.
Defines SIP Registrar User Managed Object
Defines a SIP Local Registrar Table to be used in a SIP Signaling Group.
Defines a SIP Qualified NAT Prefix Entry resource to describe a given SIP Qualified NAT Prefix Table.
Defines a SIP Qualified NAT Prefix Table to be used in a SIP Signaling Group.
Defines a SIP Profile Table to be used in a SIP Signaling Group.
Defines SIP Contact Registrant Entry Managed Object
Defines a SIP Remote Authorization Entry resource to describe a given SIP Remote Authorization Table.
Defines a SIP Remote Authorization Table to be used in a SIP Signaling Group.
Defines a SIP Server Entry resource to describe a given SIP Server Table.
Defines a SIP Server Table to be used in a SIP Signaling Group.
Defines globally-applicable SIP Settings: CAC Admin Status, Lync Presence, Untrusted INVITE Alarm and Lync Edge Server.
Defines a SIP Signaling Group Table for a SIP protocol connection on the SBC.
Defines the SIP SG Sessions Data Managed Object
Defines the SIP SG Subscriber Data Managed Object
Defines a TLS Profile Table to be used in a SIP Signaling Group.
Defines a SIP to Q.850 Cause Code Mapping Entry respource to describe a given SIP to Q.850 Override Table.
Defines a SIP to Q.850 Override Table to be used in a SIP Signaling Group.
Defines a SIP Trunk Group Managed Object
Defines a SIP Voice Quality Server.
The SNMP Management Addresses Table resource configures SNMP host systems and their associated community strings to communicate with the SBC, and controls whether it will send the traps to each host.
Defines SplitDns resource for configuring local map of domain names and DNS servers for resolving queries in those domains
Defines a Split DNS List, for Split DNS Entries on the SBC.
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.
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.
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.
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.
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.
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.
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.
Defines Static ARP Managed Object
Defines Static Route Managed Object.
Defines the Static IPv6 Neighbor Managed Object
Defines the IPv6 Static Route Managed Object.
Defines Supplementary Certificate managed object.
Defines a CAS Supplementary Service Profile to be used in a CAS Signaling Group
Defines The System resource that controls node-level configuration settings on the SBC.
Defines System Call Statistics Managed Object
The Local Log resource defines the logging level setting for the local log.
This resource defines the system vitals log files on the SBC.
Defines a Threshold Crossing Alert defined in the SBC.
Defines a remote BRI Port resource on the SBC.
Defines a remote DS1 Port resource that controls the SBC's T1/E1 ports.
Defines a FXO Port resource which controls the FXO Port
Defines the Timing resource that controls the system timing on the SBC.
Defines a Tone Profile resource to be used in a Tone Table.
Defines a Tone Table resource to be used in a Signaling Group.
Defines a Transformation Entry resource to describe a given Transformation Table.
Defines a Transformation Table to be used in a Call Routing Entry.
The Active Directory Group to Access Level Mapping Table resource controls the way users in Active Directory can access the SBC based on their group membership.
Defines VLAN Managed Object.
Defines a Voice Codec Profile used by the Media List Profile Table.
This resource defines the web access log files on the SBC.
This resource defines the web error log files on the SBC.
The Auto Configuration Task allows the user to configure settings for provisioning the SBC from a BroadSoft Server.
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.
The Modify Default VLAN allows the user to modify the Default Untagged VLAN of Ethernet Ports.