7 Nodes
7.1 Get Nodes
GET https://<HOST>:<PORT>/api/nodes/get?version=0
Returns all configured nodes.
Required Permissions
-
API
-
Configuration Mode Read Access
Response Body Structure
The response body is strutured as an array. The array consists of GetNodesNode JSON objects. A description for its fields is at section 30.53.1. For the JSON schema refer to section 30.53.2.
Example
7.2 Enable Node
POST https://<HOST>:<PORT>/api/nodes/enable?version=0
Enables a node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or display name of the node that will be enabled.
Example
7.3 Disable Node
POST https://<HOST>:<PORT>/api/nodes/disable?version=0
Disables a node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or display name of the node that will be disabled.
Example
7.4 Get System Profiles
GET https://<HOST>:<PORT>/api/nodes/systemProfiles/get?version=0
Retrieves a list of all possible system profiles that can be used to add a PBX or Voice over IP System.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
completeData
Type: Boolean
Indicates if additional data for each node should be included.
Response Body Structure
The response body is strutured as an array. The array consists of GetSystemsProfilesProfile JSON objects. A description for its fields is at section 30.54.1. For the JSON schema refer to section 30.54.2.
Example
7.5 Get Microsoft teams carrier nodes.
GET https://<HOST>:<PORT>/api/nodes/msTeamsCarriers/get?version=0
Retrieves a list of all configured Nodes using Microsoft Teams Carrier Nodes.
Required Permissions
-
API
-
Configuration Mode Read Access
Response Body Structure
The response body is strutured as an array. The array consists of GetNodesNode JSON objects. A description for its fields is at section 30.53.1. For the JSON schema refer to section 30.53.2.
Example
7.6 Add PBX or Voice over IP System
POST https://<HOST>:<PORT>/api/nodes/addSystem?version=3
Adds a new PBX or Voice over IP System node to the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
profile
The id of the profile, that should be used. To get a list of availabled profiles use section 7.4.
-
version
3
Request Body Structure
The request body is structured as AddSystemProfile JSON object. A description for its fields is at section 30.8.1. For the JSON schema refer to section 30.8.2.
Response Body Structure
The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 30.60.1. For the JSON schema refer to section 30.60.2.
Example
7.7 Get Provider Profiles
GET https://<HOST>:<PORT>/api/nodes/providerProfiles/get?version=0
Retrieves a list of all possible provider profiles that can be used to add a provider.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
completeData
Type: Boolean
Indicates if additional data for each node should be included.
Response Body Structure
The response body is strutured as an array. The array consists of GetProviderProfilesProfile JSON objects. A description for its fields is at section 30.61.1. For the JSON schema refer to section 30.61.2.
Example
7.8 Add Provider
POST https://<HOST>:<PORT>/api/nodes/addProvider?version=2
Adds a Provider Node to the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
profile
The id of the profile, that should be used. To get a list of availabled profiles use section 7.7.
-
version
2
Request Body Structure
The request body is structured as AddProviderProfile JSON object. A description for its fields is at section 30.9.1. For the JSON schema refer to section 30.9.2.
Response Body Structure
The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 30.60.1. For the JSON schema refer to section 30.60.2.
Example
7.9 Add SIP Phones Registrar
POST https://<HOST>:<PORT>/api/nodes/addSipPhoneRegistrar?version=0
Adds a new SIP phones registrar to the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request Body Structure
The request body is structured as AddSipPhoneRegistrarProfile JSON object. A description for its fields is at section 30.10.1. For the JSON schema refer to section 30.10.2.
Response Body Structure
The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 30.60.1. For the JSON schema refer to section 30.60.2.
Example
7.10 Remove Node
DELETE https://<HOST>:<PORT>/api/nodes/remove?version=0
Removes a node from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or display name of the node that should be removed
-
force
Type: Boolean
If this is true, objects will be deleted even if they have other references than this node. This can cause errors inside the configuration.
Example
7.11 Get Object from Node Graph
GET https://<HOST>:<PORT>/api/nodes/subTreeObject/get?version=0
Returns one of the objects in the nodes graph.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the node which objects will be returned
-
objectType
This parameter determines which object from the node will be returned.
Possible values:
-
sipNode
-
sipUserAgent
-
mediaNegotiation
-
mediaNegotiationNetworkController
-
mediaNegotiationNetworkSecurityProfile
-
mediaNegotiationDigitalIdentitiyAndTrust
-
mediaNegotiationNetworkMapping
-
mediaNegotiationNetworkStaticMapping
-
mediaNegotiationNetworkPeerWhitelist
-
mediaNegotiationQosProfile
-
sipTransport
-
sipTransportNetworkController
-
sipTransportNetworkSecurityProfile
-
sipTransportDigitalIdentitiyAndTrust
-
sipTransportNetworkMapping
-
sipTransportNetworkStaticMapping
-
sipTransportNetworkPeerWhitelist
-
sipTransportQosProfile
-
msTeamsTenant
-
msTeamsConnectivity
-
msTeamsSbaSipNode
-
msTeamsSbaSipUserAgent
-
msTeamsSbaMediaNegotiation
-
msTeamsSbaMediaNegotiationNetworkController
-
msTeamsSbaMediaNegotiationNetworkSecurityProfile
-
msTeamsSbaMediaNegotiationDigitalIdentitiyAndTrust
-
msTeamsSbaMediaNegotiationNetworkMapping
-
msTeamsSbaMediaNegotiationNetworkStaticMapping
-
msTeamsSbaMediaNegotiationNetworkPeerWhitelist
-
msTeamsSbaMediaNegotiationQosProfile
-
msTeamsSbaSipTransport
-
msTeamsSbaSipTransportNetworkController
-
msTeamsSbaSipTransportNetworkSecurityProfile
-
msTeamsSbaSipTransportDigitalIdentitiyAndTrust
-
msTeamsSbaSipTransportNetworkMapping
-
msTeamsSbaSipTransportNetworkStaticMapping
-
msTeamsSbaSipTransportNetworkPeerWhitelist
-
msTeamsSbaSipTransportQosProfile
-
msTeamsCloudTransportConnection
-
msTeamsSbaTransportConnection
-
websocket
-
webrtcServer
-
webrtcNode
-
sfbUcmaNode
-
ipcClient
-
ipcClientNetworkController
-
ipcClientNetworkSecurityProfile
-
ipcClientDigitalIdentitiyAndTrust
-
ipcClientNetworkStaticMapping
-
ipcClientNetworkPeerWhitelist
-
ipcClientQosProfile
-
Example
7.12 Get Port
GET https://<HOST>:<PORT>/api/nodes/port/get?version=0
Returns the UDP/TCP port of the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the node that should be removed
Example
7.13 Set Port
PUT https://<HOST>:<PORT>/api/nodes/port/set?version=0
Modifies the UDP/TCP port of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node which port should be modified.
Request Body Structure
The body must contain the new UDP/TCP port for the given node.
Example
7.14 Get TlsPort
GET https://<HOST>:<PORT>/api/nodes/tlsPort/get?version=0
Returns the TLS port of the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the node that should be removed
Example
7.15 Set TlsPort
PUT https://<HOST>:<PORT>/api/nodes/tlsPort/set?version=0
Modifies the TLS port of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node which port should be modified.
Request Body Structure
The body must contain the new TLS port for the given node.
Example
7.16 Get Teams FQDN
GET https://<HOST>:<PORT>/api/nodes/tenants/fqdn/get?version=0
Returns the FQDN of the requested Teams node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the Teams node which FQDN should be returned.
Example
7.17 Set Teams FQDN
PUT https://<HOST>:<PORT>/api/nodes/tenants/fqdn/set?version=0
Modifies the FQDN of the requested Teams node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or display name of the Teams node which FQDN should be returned.
Request Body Structure
The body must contain the new FQDN for the Teams node.
Example
7.18 Get Hostname/FQDN
GET https://<HOST>:<PORT>/api/nodes/overrideHostname/get?version=0
Returns the hostname/FQDN of the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the node which hostname/FQDN should be returned.
Example
7.19 Set Hostname/FQDN
PUT https://<HOST>:<PORT>/api/nodes/overrideHostname/set?version=0
Modifies the hostname/FQDN of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or display name of the node which hostname/FQDN should be modified.
Request Body Structure
The body must contain the new hostname/FQDN for the requested node.
Example
7.20 Get Network Security Profile Name
GET https://<HOST>:<PORT>/api/nodes/networkSecurityProfileName/get?version=0
Returns the id of the current network security profile for the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the node which network security profile name will be returned
Example
7.21 Set Network Security Profile Name
PUT https://<HOST>:<PORT>/api/nodes/networkSecurityProfileName/set?version=0
Modifies the network security profile for the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node which network security profile should be modified.
Request Body Structure
The body must contain the new network security profile id.
Example
7.22 Get Certificate
GET https://<HOST>:<PORT>/api/nodes/certificates/get?version=0
Returns the certificate of the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or display name of the node which certificate should be returned.
7.23 Set Certificate
PUT https://<HOST>:<PORT>/api/nodes/certificates/set?version=0
Modifies the certificate of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
mode
Determines which items will be modified with the uploaded file.
Type: mode
Possible Values:
-
CERTIFICATES_AND_PRIVATE_KEY
-
CERTIFICATES_ONLY
-
PRIVATE_KEY_ONLY
-
-
node
The id or displayName of the Node to be modified.
-
password
The password of the certificate file.
Request Body Structure
The body must contain the certificate file as "multipart/form-data".
Example
7.24 Get Transport Connections
GET https://<HOST>:<PORT>/api/nodes/transportConnections/get?version=0
Returns the transport connection of the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or displayName of the Node whose transport connections should be returned.
Response Body Structure
The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 30.11.1. For the JSON schema refer to section 30.11.2.
Example
7.25 Add Transport Connection
POST https://<HOST>:<PORT>/api/nodes/transportConnections/add?version=0
Adds a transport connection to the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node where the Transport Connection will be added..
Request Body Structure
The request body is structured as SipNodeTransportConnection JSON object. A description for its fields is at section 30.11.1. For the JSON schema refer to section 30.11.2.
Response Body Structure
The response body is structured as SipNodeTransportConnection JSON object. A description for its fields is at section 30.11.1. For the JSON schema refer to section 30.11.2.
Example
7.26 Clear Transport Connections
DELETE https://<HOST>:<PORT>/api/nodes/transportConnections/clear?version=0
Removes all transport connections of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node whose transport connections should be returned.
-
removeRoutes
Decide if the routes should be removed or not.
Example
7.27 Set Transport Connections
POST https://<HOST>:<PORT>/api/nodes/transportConnections/set?version=0
Replaces the Transport Connections of the requested Node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node whose Transport Connections will be modified.
Request Body Structure
The request body is strutured as JSON array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 30.11.1. For the JSON schema refer to section 30.11.2.
Response Body Structure
The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 30.11.1. For the JSON schema refer to section 30.11.2.
Example
7.28 Remove Transport Connection
DELETE https://<HOST>:<PORT>/api/nodes/transportConnections/remove?version=0
Removes a Transport Connection and it's matching condition from the requested Node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
-
index
The index of the Transport Connection that will be removed.
Response Body Structure
The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 30.11.1. For the JSON schema refer to section 30.11.2.
Example
7.29 Add Trusted Certificates
PUT https://<HOST>:<PORT>/api/nodes/trustedCertificates/add?version=0
Adds a new certificate to the list of trusted certificates for the requested node.
Required Permissions
-
API
-
Administration
Request parameters
-
node
The id or displayName of the Node to be modified.
-
password
The password of the certificate file.
Request Body Structure
The body must contain the certificate file.
7.30 Clear Trusted Certificates
DELETE https://<HOST>:<PORT>/api/nodes/trustedCertificates/clear?version=0
Removes all trusted certificates from the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node to be modified.
7.31 Get Incoming Dial String Rewrite Rules
GET https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/get?version=0
Returns the incoming dial string rewrite rules of the requested node
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or displayName of the Node
-
includeDefaults
Whether default values should be displayed or not.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Example
7.32 Set Incoming Dial String Rewrite Rules
PUT https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/set?version=0
Modifies the incoming dial string rewrite rules of the requested node
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
Request Body Structure
The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Example
7.33 Add Incoming Dial String Rewrite Rules
POST https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/add?version=0
Adds additional dial string rewrite rules to the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node
Request Body Structure
The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Example
7.34 Remove Incoming Dial String Rewrite Rules
DELETE https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/remove?version=0
Removes incoming dial string rewrite rules to the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
-
displayName
The displayName or id of the incoming dial string rewrite rule to be removed.
-
index
The index of the incoming dial string rewrite rule to be removed.
Example
7.35 Get Outgoing Dial String Rewrite Rules
GET https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/get?version=0
Returns the outgoing dial string rewrite rules of the requested node
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or displayName of the Node.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Example
7.36 Set Outgoing Dial String Rewrite Rules
PUT https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/set?version=0
Modifies the outgoing dial string rewrite rules of the requested node
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
Request Body Structure
The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Example
7.37 Add Outgoing Dial String Rewrite Rules
POST https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/add?version=0
Adds additional dial string rewrite rules to the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
Request Body Structure
The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 30.15.1. For the JSON schema refer to section 30.15.2.
Example
7.38 Remove Outgoing Dial String Rewrite Rules
DELETE https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/remove?version=0
Removes outgoing dial string rewrite rules to the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
-
displayName
The displayName or id of the incoming dial string rewrite rule to be removed.
-
index
The index of the incoming dial string rewrite rule to be removed.
Example
7.39 Get Network Peer Whitelist
GET https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/get?version=0
Returns the network peer whitelist of the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or displayName of the Node.
Response Body Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 30.12.1. For the JSON schema refer to section 30.12.2.
Example
7.40 Set Network Peer Whitelist
PUT https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/set?version=0
Modifies the network peer whitelist of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
Request Body Structure
The request body is strutured as JSON array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 30.12.1. For the JSON schema refer to section 30.12.2.
Response Body Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 30.12.1. For the JSON schema refer to section 30.12.2.
Example
7.41 Add Network Peer Whitelist Entry
PUT https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/add?version=0
Adds a new entry to the network peer whitelist of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node
Request Body Structure
The request body is structured as NetworkPeerWhitelistEntry JSON object. A description for its fields is at section 30.12.1. For the JSON schema refer to section 30.12.2.
Response Body Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 30.12.1. For the JSON schema refer to section 30.12.2.
Example
7.42 Remove Network Peer Whitelist Entry
DELETE https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/remove?version=0
Removes a entry from the network peer whitelist of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node.
-
hostname
Type: String
The host of the network peer whitelist entry to be removed.
-
index
The index of the network peer whitelist entry to be removed.
Response Body Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 30.12.1. For the JSON schema refer to section 30.12.2.
Example
7.43 Get Certificate Chain
GET https://<HOST>:<PORT>/api/nodes/certificateChain/get?version=0
Returns the chain certificate information for the requested node.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
node
The id or displayName of the Node whose certificate chain should be returned.
Response Body Structure
The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 30.65.1. For the JSON schema refer to section 30.65.2.
7.44 Add Chain Certificate
POST https://<HOST>:<PORT>/api/nodes/certificateChain/add?version=0
Adds Certificates to the certificate chain of the requested node.
Required Permissions
-
API
-
Administration
Request parameters
-
node
The id or displayName of the Node to be modified.
Request Body Structure
The body must contain the certificate file as "multipart/form-data".
Response Body Structure
The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 30.65.1. For the JSON schema refer to section 30.65.2.
Example
7.45 Remove Chain Certificate
DELETE https://<HOST>:<PORT>/api/nodes/certificateChain/remove?version=0
Removes a certificate from the certificate chain of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Response Body Structure
The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 30.65.1. For the JSON schema refer to section 30.65.2.
7.46 Clear Certificate Chain
DELETE https://<HOST>:<PORT>/api/nodes/certificateChain/clear?version=0
Removes all certificates from the certificate chain of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node to be modified.
7.47 Request Certificate Chain
POST https://<HOST>:<PORT>/api/nodes/certificateChain/request?version=0
Requests the certificate chain for the configured certificate of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
node
The id or displayName of the Node to be modified.