SBC 1000/2000 API
Space shortcuts

Search

Page tree
Skip to end of metadata
Go to start of metadata


Welcome to the SBC 1000/2000 REST API Reference documentation space. In addition to the SBC Edge API User's Guide, this space contains a listing of all supported API resources exposed by the SBC 1000/2000 (UX) system along with their associated REST methods and schema definitions. To help you on your way, each resource method provides a usage example (using cURL), a listing of required/optional parameters, and the expected SBC 1000/2000 response.  This reference is also available as a PDF  (October 21, 2020).


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.

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

Resource - actionsettable

Defines an Action Set Table to be used in a Signaling Group.

Resource - activealarm

The Active Alarm resource defines all active alarms present on the SBC Edge.

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

Resource - asmsystemevent

Defines Managed Object for System Events on ASM

Resource - asmvirtualmachine

Defines a Virtual Machine on ASM

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.

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.

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.

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.

Resource - ds1callinfo

Defines DS1 Call Info Managed Object

Resource - ds1channel

Defines DS1 Channel Managed Object

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.

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

Resource - ethernetport

The Ethernet Port Table resource controls the SBC Edge system's ethernet port configuration settings.

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.

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

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

Resource - fxssignalingprofile

Defines a CAS FXS Signaling Profile to be used in a CAS Signaling Group

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.

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.

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

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.

Resource - logsubsystemsentry

Defines a Log Profile Subsystems resource to describe a given Log Profile Table.

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.

Resource - mediacryptoprofile

Defines a SDES-SRTP Profile used by the Media List Profile Table.

Resource - medialistprofile

Defines a Media List Profile Table resource to be used in a Signaling Group.

Resource - messagetransentry

Defines a Message Translation Entry resource to describe a given [Message Translation Table.

Resource - messagetranstable

Defines a Message Translation Table resource to be used in a Call Routing Entry.

Resource - mstiportstats

Status and statistics of a port associated with the MST Instance.

Resource - mstp

Defines the MST Instance Managed Object.

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.

Resource - ospfconfig

The OSPF Config allows the user to configure OSPF protocol on selected network address

Resource - packetcapture

Defines packet capture managed object.

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.

Resource - q850tosipmappingtable

Defines a Q.850 to SIP Override Table to be used in a SIP Signaling Group.

Resource - qoe

Defines QoE Managed Object

Resource - r2signalingprofile

Defines a CAS R2 Signaling Profile to be used in a CAS Signaling Group

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.

Resource - registrantstatus

Defines SIP Contact Registration Status Managed Object

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.

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.

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.

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

Resource - sipcontactregistrant

Defines SIP Contact Registrant Table Managed Object

Resource - siplocalauthentry

Defines a SIP Local Passthrough Authorization Entry resource to describe a given SIP Local Passthrough Authorization Table.

Resource - siplocalauthtable

Defines a SIP Local Passthrough Authorization Table to be used in a SIP Signaling Group.

Resource - siplocalregistrarentry

Defines SIP Registrar User Managed Object

Resource - siplocalregistrartable

Defines a SIP Local Registrar Table to be used in a SIP Signaling Group.

Resource - sipnatprefix

Defines a SIP Qualified NAT Prefix Entry resource to describe a given SIP Qualified NAT Prefix Table.

Resource - sipnatprefixtable

Defines a SIP Qualified NAT Prefix Table to be used in a SIP Signaling Group.

Resource - sipprofile

Defines a SIP Profile Table to be used in a SIP Signaling Group.

Resource - sipregistrantentry

Defines SIP Contact Registrant Entry Managed Object

Resource - sipremoteauthentry

Defines a SIP Remote Authorization Entry resource to describe a given SIP Remote Authorization Table.

Resource - sipremoteauthtable

Defines a SIP Remote Authorization Table to be used in a SIP Signaling Group.

Resource - sipserver

Defines a SIP Server Entry resource to describe a given SIP Server Table.

Resource - sipservertable

Defines a SIP Server Table to be used in a SIP Signaling Group.

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.

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.

Resource - siptoq850mapping

Defines a SIP to Q.850 Cause Code Mapping Entry respource to describe a given SIP to Q.850 Override Table.

Resource - siptoq850mappingtable

Defines a SIP to Q.850 Override Table to be used in a SIP Signaling Group.

Resource - siptrunkgroup

Defines a SIP Trunk Group Managed Object

Resource - sipvoicequalityserver

Defines a SIP Voice Quality Server.

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.

Resource - splitdns

Defines SplitDns resource for configuring local map of domain names and DNS servers for resolving queries in those domains

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.

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.

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.

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.

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.

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.

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.

Resource - staticarp

Defines Static ARP Managed Object

Resource - staticiproute

Defines Static Route Managed Object.

Resource - staticipv6neighbor

Defines the Static IPv6 Neighbor Managed Object

Resource - staticipv6route

Defines the IPv6 Static Route Managed Object.

Resource - supplementarycertificate

Defines Supplementary Certificate managed object.

Resource - supplementarysvcprofile

Defines a CAS Supplementary Service Profile to be used in a CAS Signaling Group

Resource - system

Defines The System resource that controls node-level configuration settings on the SBC Edge system.

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.

Resource - telcods1port

Defines a remote DS1 Port resource that controls the SBC Edge system's T1/E1 ports.

Resource - telcofxoport

Defines a FXO Port resource which controls the FXO Port

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.

Resource - transformationtable

Defines a Transformation Table to be used in a Call Routing Entry.

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.

Resource - voicecodecprofile

Defines a Voice Codec Profile used by the Media List Profile Table.

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.

  • No labels