Configuration API for Avaya Session Border Controller for Enterprise (Release 10.2.0.0 / Spec Revision 1.0)

Download OpenAPI specification:Download

This is the Configuration API definition for the Avaya Session Border Controller for Enterprise.

Each supported endpoint is defined in this file along with a description of the endpoint, any required parameters, permissions, and the expected responses with examples. Detailed information on how to fully configure a system from start to finish can be found in the Administering Avaya Session Border Controller for Enterprise document available on the Avaya Support site (see https://support.avaya.com/products/P0997/avaya-session-border-controller-for-enterprise/).

Note that each endpoint definition also includes an embedded x-required-capability property which contains the required permissions for the endpoint (this is also included in the description).

Maintenance Mode

APIs for managing maintenance windows.

Get Maintenance Mode Status

Get the current Maintenance Mode configuration.

User must have the maintenance-mode:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "startTime": "2023-09-27T00:00:00Z",
  • "endTime": "2023-09-28T06:00:00Z",
  • "terminateCallsAfter": "PT5M"
}

Configure Maintenance Mode Status

Update the current Maintenance Mode configuration.

User must have the maintenance-mode:update capability to perform this action.

Request Body schema: application/json
required

Updated maintenance mode configuration.

enabled
boolean

Enable/disable maintenance window.

startTime
string

Time the maintenance window will start.

Note: If provided as null (or omitted), the current time will be used. This value will never be returned as null.

Accepted formats:

  • Int/Long -> Unix Timestamp
  • String: ISO-8601 Date/Time

Output format: ISO-8601 Date/Time

endTime
string

Time the maintenance window will end.

Note: If provided as null (or omitted), the maintenance window will never stop and must be manually stopped (by setting a time or disabling the maintenance window).

Accepted formats:

  • Int/Long -> Unix Timestamp
  • String: ISO-8601 Date/Time

Output format: ISO-8601 Date/Time

terminateCallsAfter
string

Interval after which existing calls will be terminated.

Note: If provided as null (or omitted), calls will be terminated immediately when the maintenance window starts.

Accepted formats:

  • Int/Long -> Duration in Seconds
  • String: ISO-8601 Duration

Output format: ISO-8601 Duration

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "startTime": "2023-09-27T00:00:00Z",
  • "endTime": "2023-09-28T06:00:00Z",
  • "terminateCallsAfter": "PT5M"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "startTime": "2023-09-27T00:00:00Z",
  • "endTime": "2023-09-28T06:00:00Z",
  • "terminateCallsAfter": "PT5M"
}

Network Management

APIs for managing networks and interfaces.

Update the state of a network interface (excluding VLANs)

Set the status of a network interface to the UP or DOWN state for this system.

Note: This operation is not supported for VLANs.

User must have the network-interface:update capability.

path Parameters
interfaceName
required
string

The name of the interface to modify

status
required
string
Enum: "UP" "DOWN"

The state to set the interface to

Responses

Response samples

Content type
application/json
{
  • "A1": "UP",
  • "A2": "UP",
  • "B1": "UP",
  • "B2": "UP"
}

List all network interfaces (excluding VLANs)

Retrieve a mapping of network interfaces to their current state for this system.

Note: This operation is not supported for VLANs.

User must have the network-interface:read capability.

Responses

Response samples

Content type
application/json
{
  • "A1": "UP",
  • "A2": "UP",
  • "B1": "UP",
  • "B2": "UP"
}

Create a new network

Create a new network for this system.

User must have the network-configuration:create capability.

Request Body schema: application/json
networkName
string

Name for the network

gatewayIp
string

Gateway IP of the network

subnetMask
string

Subnet Mask of the network

interface
string
Enum: "A1" "A2" "B1" "B2"

Select interface of the network

Array of objects (NetworkAddress) >= 1

Responses

Request samples

Content type
application/json
{
  • "networkName": "Private",
  • "gatewayIp": "192.168.5.1",
  • "subnetMask": "255.255.255.0",
  • "interface": "A1",
  • "networkAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/network-management/networks/1",
  • "networkId": 1,
  • "networkName": "Private",
  • "gatewayIp": "192.168.5.1",
  • "subnetMask": "255.255.255.0",
  • "interface": "A1",
  • "networkAddresses": [
    ]
}

List all networks

Retrieve a list of all configured networks from this system.

User must have the network-configuration:read capability.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a network

Retrieve an existing network from this system.

User must have the network-configuration:read capability.

path Parameters
networkId
required
integer

ID of the network

Responses

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/network-management/networks/1",
  • "networkId": 1,
  • "networkName": "Private",
  • "gatewayIp": "192.168.5.1",
  • "subnetMask": "255.255.255.0",
  • "interface": "A1",
  • "networkAddresses": [
    ]
}

Delete an existing network

Delete an existing network from this system.

User must have the network-configuration:delete capability.

path Parameters
networkId
required
integer

ID of the network

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Retrieve all network addresses from existing network.

Retrieve all network addresses from existing network.

User must have the network-configuration:read capability.

path Parameters
networkId
required
integer
Example: 3

ID of the network

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new network address to network

Add a new network address to network.

User must have the network-configuration:update capability.

path Parameters
networkId
required
integer
Example: 3

ID of the network

Request Body schema: application/json
ipAddress
string

IP address given to the network

publicIp
string

Public IP of the network

gatewayOverride
string

Gateway override IP of the network

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "192.168.5.157",
  • "publicIp": "",
  • "gatewayOverride": ""
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/network-management/networks/3/network-addresses/2",
  • "networkAddressId": 2,
  • "ipAddress": "192.168.5.157",
  • "publicIp": "",
  • "gatewayOverride": ""
}

Get the network address details from network

Get the network address details from network

User must have the network-configuration:read capability.

path Parameters
networkId
required
integer
Example: 3

ID of the network

networkAddressId
required
integer
Example: 2

ID of the network address

Responses

Response samples

Content type
application/json
{
  • "networkAddressId": 2,
  • "ipAddress": "192.168.5.157",
  • "publicIp": "",
  • "gatewayOverride": ""
}

Edit the network address details in the network

Modify the network address details in the network.

User must have the network-configuration:update capability.

path Parameters
networkId
required
integer
Example: 3

ID of the network

networkAddressId
required
integer
Example: 2

ID of the network address

Request Body schema: application/json
ipAddress
string

IP address given to the network

publicIp
string

Public IP of the network

gatewayOverride
string

Gateway override IP of the network

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "192.168.5.157",
  • "publicIp": "",
  • "gatewayOverride": ""
}

Response samples

Content type
application/json
{
  • "networkAddressId": 2,
  • "ipAddress": "192.168.5.157",
  • "publicIp": "",
  • "gatewayOverride": ""
}

Delete the network address details from the network

Delete the network address details from the network

User must have the network-configuration:delete capability.

path Parameters
networkId
required
integer
Example: 3

ID of the network

networkAddressId
required
integer
Example: 2

ID of the network address

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Certificates

APIs for managing certificates.

List all installed certificates.

List all installed certificates.

User must have the certificate:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "cert": [
    ],
  • "ca": [
    ],
  • "crl": [
    ],
  • "csr": [
    ],
  • "key": [
    ]
}

List all installed certificates of a particular type.

List all installed certificates of a particular type.

User must have the certificate:read capability to perform this action.

path Parameters
certificateType
required
string (CertificateType)
Enum: "cert" "ca" "crl" "key" "csr"

The type of the certificate to list.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Install a new certificate.

Install a new certificate.

Note: Only certificates of type cert, ca, or crl can be installed via the API.

User must have the certificate:install capability to perform this action.

path Parameters
certificateType
required
string (CertificateTypeRestricted)
Enum: "cert" "ca" "crl"

The type of the certificate to list.

Request Body schema: multipart/form-data
required
certificatePayload
string <base64>

The primary certificate payload. This part is always required.

For a certificate or CA certificate, this should be a PEM encoded X.509 certificate. For a CRL, this should be a PEM encoded X.509 CRL.

Private key or CSR uploads are not supported.

Note: This part MUST contain a Content-Disposition header with a filename parameter. Any requests missing this parameter will be rejected.

allowWeakPayload
string

Specify if weak certificate or keys are allowed. This part should be a string of either true or false. Omitting this part will default to false.

existingPrivateKey
string

The existing private key to use. This part is only used if certificateType is cert and is required if privateKeyPayload is not specified.

If specified, this part should contain the name of a private key that is already installed on the system.

privateKeyPayload
string <base64>

The private key payload. This part is only used if certificateType is cert and is required if existingPrivateKey is not specified.

If specified, this part should be an unencrypted, PEM encoded RSA private key.

Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored.

trustChainPayload
string <base64>

The trust chain payload. This part is only used if certificateType is cert.

If specified, this part should be one or more this PEM encoded X.509 certificates concatenated together.

Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get an existing certificate's contents.

Get an existing certificate's contents.

Note: Only certificates of type cert, ca, or crl can be read via the API.

User must have the certificate:read capability to perform this action.

path Parameters
certificateType
required
string (CertificateTypeRestricted)
Enum: "cert" "ca" "crl"

The type of the certificate to list.

certificateName
required
string

The name of the certificate.

Responses

Response samples

Content type
application/json
{
  • "payload": "string"
}

Overwrite an existing certificate.

Overwrite an existing certificate.

Note: Only certificates of type cert, ca, or crl can be installed via the API.

User must have the certificate:install capability to perform this action.

path Parameters
certificateType
required
string (CertificateTypeRestricted)
Enum: "cert" "ca" "crl"

The type of the certificate to list.

certificateName
required
string

The name of the certificate.

Request Body schema: multipart/form-data
required
certificatePayload
string <base64>

The primary certificate payload. This part is always required.

For a certificate or CA certificate, this should be a PEM encoded X.509 certificate. For a CRL, this should be a PEM encoded X.509 CRL.

Private key or CSR uploads are not supported.

Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored.

allowWeakPayload
string

Specify if weak certificate or keys are allowed. This part should be a string of either true or false. Omitting this part will default to false.

existingPrivateKey
string

The existing private key to use. This part is only used if certificateType is cert and is required if privateKeyPayload is not specified.

If specified, this part should contain the name of a private key that is already installed on the system.

privateKeyPayload
string <base64>

The private key payload. This part is only used if certificateType is cert and is required if existingPrivateKey is not specified.

If specified, this part should be an unencrypted, PEM encoded RSA private key.

Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored.

trustChainPayload
string <base64>

The trust chain payload. This part is only used if certificateType is cert.

If specified, this part should be one or more this PEM encoded X.509 certificates concatenated together.

Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete an existing certificate.

path Parameters
certificateType
required
string (CertificateType)
Enum: "cert" "ca" "crl" "key" "csr"

The type of the certificate to list.

certificateName
required
string

The name of the certificate.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create certificate signing request (CSR).

Create certificate signing request (CSR) for the requested data.

User must have the certificate:create capability to perform this action.

Request Body schema: application/json
country
required
string = 2 characters

The name of the country within which the certificate is being created. This value should be the two-letter ISO code for the country.

state
required
string <= 64 characters

This value should be the state/province where the certificate is being created.

locality
required
string <= 64 characters

This value should be the locality (city) where the certificate is being created.

organization
required
string <= 128 characters

This value should be the name of the company or organization creating the certificate.

organizationalUnit
required
string <= 128 characters

This value should be the group within the company or organization creating the certificate.

commonName
required
string <= 64 characters

This value should be the name used to refer to or identify the company or group creating the certificate. You cannot provide wildcard (*) characters in this field. This value will be used as part of the file name.

keySize
required
number
Enum: 2048 4096

This value should be the certificate key length 2048 or 4096 in bits.

The hash algorithms SHA256 to be used with the RSA signature algorithm.

keyUsageExtensionList
required
Array of strings
Items Enum: "KEY_ENCIPHERMENT" "NON_REPUDIATION" "DIGITAL_SIGNATURE"

The purpose for which the public key might be used: KEY_ENCIPHERMENT, NON_REPUDIATION, DIGITAL_SIGNATURE.

extendedKeyUsageExtensionList
required
Array of strings
Items Enum: "SERVER_AUTH" "CLIENT_AUTH"

The purpose for which the public key might be used in addition to keyUsageExtensionList

subjectAltNameList
required
Array of strings [ 1 .. 10 ] items

An optional text field that can be used to further identify this certificate.

You can make maximum of 10 Subject Alt Name entries. Wildcard characters (*) are not supported in this field.

Avaya SBCE supports DNS hostname, IP address and SIP domain name as the valid entries for Subject Alt Name field. Avaya SBCE does not support SIP URI as a valid value for the Subject Alt Name field.

passphrase
required
string <= 32 characters

The passphrase used when encrypting the private key.

contactName
required
string <= 128 characters

The name of the individual within the issuing organization acting as the point-of-contact for issues relating to this certificate.

contactEmail
required
string <= 256 characters

The e-mail address of the contact.

Responses

Request samples

Content type
application/json
{
  • "country": "st",
  • "state": "string",
  • "locality": "string",
  • "organization": "string",
  • "organizationalUnit": "string",
  • "commonName": "string",
  • "keySize": 2048,
  • "keyUsageExtensionList": [
    ],
  • "extendedKeyUsageExtensionList": [
    ],
  • "subjectAltNameList": [
    ],
  • "passphrase": "string",
  • "contactName": "string",
  • "contactEmail": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

TLS Client Profiles

APIs for managing Transport Layer Security (TLS) client profiles.

Add new TLS client profile in SBCE

Add new TLS client profile in SBCE

User must have the tls-client-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string
certificateFileName
string
object or object or object

Cipher suite to use when negotiating a TLS handshake.

peerCaList
Array of strings
peerCrlList
Array of strings
verificationDepth
integer

The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified.

renegotiationTimeInSeconds
integer

Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

renegotiationByteCount
integer

Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

tlsProtocol
Array of strings (TLSProfileProtocols)
Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0"
sni
boolean
extendedHostnameVerification
boolean
hostOverride
string

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerCaList": [
    ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/tls-client-profiles/1",
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerCaList": [
    ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Get all TLS client profiles

Get all TLS client profiles

User must have the tls-client-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Edits existing TLS client profile in SBCE

Edits existing TLS client profile in SBCE

User must have the tls-client-profile:update capability to perform this action.

path Parameters
profileId
required
integer >= 1
Request Body schema: application/json
profileId
integer
profileName
string
certificateFileName
string
object or object or object

Cipher suite to use when negotiating a TLS handshake.

peerCaList
Array of strings
peerCrlList
Array of strings
verificationDepth
integer

The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified.

renegotiationTimeInSeconds
integer

Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

renegotiationByteCount
integer

Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

tlsProtocol
Array of strings (TLSProfileProtocols)
Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0"
sni
boolean
extendedHostnameVerification
boolean
hostOverride
string

Responses

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerCaList": [
    ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerCaList": [
    ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Get the TLS client profile for given ID

Get the TLS client Profile for given ID

User must have the tls-client-profile:read capability to perform this action.

path Parameters
profileId
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerCaList": [
    ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Delete the TLS client profile for given ID

Delete the TLS client profile for given ID

User must have the tls-client-profile:delete capability to perform this action.

path Parameters
profileId
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

TLS Server Profiles

APIs for managing Transport Layer Security (TLS) server profiles.

Add new TLS server profile in SBCE

Add new TLS server profile in SBCE

User must have the tls-server-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string
certificateFileName
string
object or object or object

Cipher suite to use when negotiating a TLS handshake.

peerVerification
string
Enum: "NONE" "OPTIONAL" "REQUIRED"

Determine if the peer certificate requires verification.

peerCaList
Array of strings
peerCrlList
Array of strings
verificationDepth
integer

The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified if peerVerification is not NONE.

renegotiationTimeInSeconds
integer

Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

renegotiationByteCount
integer

Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

tlsProtocol
Array of strings (TLSProfileProtocols)
Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0"
object

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerVerification": "NONE",
  • "peerCaList": [ ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/tls-server-profiles/1",
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerVerification": "NONE",
  • "peerCaList": [ ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Get all TLS server profiles

Get all TLS server profiles

User must have the tls-server-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Edit an existing TLS server profile in SBCE

Edit an existing TLS server profile in SBCE

User must have the tls-server-profile:update capability to perform this action.

path Parameters
profileId
required
integer >= 1
Request Body schema: application/json
profileId
integer
profileName
string
certificateFileName
string
object or object or object

Cipher suite to use when negotiating a TLS handshake.

peerVerification
string
Enum: "NONE" "OPTIONAL" "REQUIRED"

Determine if the peer certificate requires verification.

peerCaList
Array of strings
peerCrlList
Array of strings
verificationDepth
integer

The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified if peerVerification is not NONE.

renegotiationTimeInSeconds
integer

Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

renegotiationByteCount
integer

Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable.

tlsProtocol
Array of strings (TLSProfileProtocols)
Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0"
object

Responses

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerVerification": "NONE",
  • "peerCaList": [ ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerVerification": "NONE",
  • "peerCaList": [ ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Get the TLS server profile for given ID

Get the TLS server profile for given ID

User must have the tls-server-profile:read capability to perform this action.

path Parameters
profileId
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "certificateFileName": "avaya.crt",
  • "cipherSuite": {
    },
  • "peerVerification": "NONE",
  • "peerCaList": [ ],
  • "peerCrlList": [ ],
  • "verificationDepth": 5,
  • "renegotiationTimeInSeconds": 30,
  • "renegotiationByteCount": 0,
  • "tlsProtocol": "TLS_1_2"
}

Delete the TLS server profile for given ID

Delete the TLS server profile for given ID

User must have the tls-server-profile:delete capability to perform this action.

path Parameters
profileId
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Signaling Interfaces

APIs for managing signaling interfaces.

Add new signaling interface in SBCE

Add new signaling interface in SBCE

User must have the signaling-interface:delete capability to perform this action.

Request Body schema: application/json
signalingName
string

Name of Signaling Interface

networkId
integer

ID of IP Address to listen on

udpPort
integer

UDP port to listen on

tcpPort
integer

TCP port to listen on

tlsPort
integer

TLS port to listen on

tlsProfileId
integer

ID of TLS Server Profile if TLS Port is provided.

Responses

Request samples

Content type
application/json
{
  • "signalingName": "Sig_int",
  • "networkId": 1,
  • "udpPort": 5060,
  • "tcpPort": 5060,
  • "tlsPort": 5061,
  • "tlsProfileId": 1
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/signaling-interfaces/1",
  • "signalingId": 1,
  • "signalingName": "Sig_int",
  • "networkId": 1,
  • "udpPort": 5060,
  • "tcpPort": 5060,
  • "tlsPort": 5061,
  • "tlsProfileId": 1
}

Get all signaling interfaces

Get all signaling interfaces

User must have the signaling-interface:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit signaling interface in SBCE

Edit signaling interface in SBCE

User must have the signaling-interface:update capability to perform this action.

path Parameters
signalingId
required
integer

ID of the profile

Request Body schema: application/json
signalingId
integer <int64>

ID of signaling interface

signalingName
string

Name of Signaling Interface

networkId
integer

ID of IP Address to listen on

udpPort
integer

UDP port to listen on

tcpPort
integer

TCP port to listen on

tlsPort
integer

TLS port to listen on

tlsProfileId
integer

ID of TLS Server Profile if TLS Port is provided.

Responses

Request samples

Content type
application/json
{
  • "signalingId": 1,
  • "signalingName": "Sig_int",
  • "networkId": 1,
  • "udpPort": 5060,
  • "tcpPort": 5060,
  • "tlsPort": 5061,
  • "tlsProfileId": 1
}

Response samples

Content type
application/json
{
  • "signalingId": 1,
  • "signalingName": "Sig_int",
  • "networkId": 1,
  • "udpPort": 5060,
  • "tcpPort": 5060,
  • "tlsPort": 5061,
  • "tlsProfileId": 1
}

Get signaling interface for given ID

Get signaling interface for given ID

User must have the signaling-interface:read capability to perform this action.

path Parameters
signalingId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "signalingId": 1,
  • "signalingName": "Sig_int",
  • "networkId": 1,
  • "udpPort": 5060,
  • "tcpPort": 5060,
  • "tlsPort": 5061,
  • "tlsProfileId": 1
}

Delete signaling interface for given ID

Delete signaling interface for given ID

User must have the signaling-interface:delete capability to perform this action.

path Parameters
signalingId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Media Interfaces

APIs for managing media interfaces.

Add new media interface in SBCE

Add new media interface in SBCE

User must have the media-interface:create capability to perform this action.

Request Body schema: application/json
mediaName
string

Name of the media interface

networkId
integer

ID of IP address to listen on

startPortRange
integer

Start port of the media interface port range

endPortRange
integer

End port of the media interface port range

tlsProfileId
integer

TLS Profile ID used to listen for incoming requests

bufferSize
integer

Buffer Size of the buffer

Responses

Request samples

Content type
application/json
{
  • "mediaName": "Med_int",
  • "networkId": 1,
  • "startPortRange": 35000,
  • "endPortRange": 40000,
  • "tlsProfileId": 1,
  • "bufferSize": 500
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/media-interfaces/1",
  • "mediaId": 1,
  • "mediaName": "Med_int",
  • "networkId": 1,
  • "startPortRange": 35000,
  • "endPortRange": 40000,
  • "tlsProfileId": 1,
  • "bufferSize": 500
}

Get all media interfaces

Get all media interfaces

User must have the media-interface:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit media interface in SBCE

Edit media interface in SBCE

User must have the media-interface:update capability to perform this action.

path Parameters
mediaId
required
integer

ID of the profile

Request Body schema: application/json
mediaId
integer <int64>

ID of media interface

mediaName
string

Name of the media interface

networkId
integer

ID of IP address to listen on

startPortRange
integer

Start port of the media interface port range

endPortRange
integer

End port of the media interface port range

tlsProfileId
integer

TLS Profile ID used to listen for incoming requests

bufferSize
integer

Buffer Size of the buffer

Responses

Request samples

Content type
application/json
{
  • "mediaId": 1,
  • "mediaName": "Med_int",
  • "networkId": 1,
  • "startPortRange": 35000,
  • "endPortRange": 40000,
  • "tlsProfileId": 1,
  • "bufferSize": 500
}

Response samples

Content type
application/json
{
  • "mediaId": 1,
  • "mediaName": "Med_int",
  • "networkId": 1,
  • "startPortRange": 35000,
  • "endPortRange": 40000,
  • "tlsProfileId": 1,
  • "bufferSize": 500
}

Get media interface for given ID

Get media interface for given ID

User must have the media-interface:read capability to perform this action.

path Parameters
mediaId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "mediaId": 1,
  • "mediaName": "Med_int",
  • "networkId": 1,
  • "startPortRange": 35000,
  • "endPortRange": 40000,
  • "tlsProfileId": 1,
  • "bufferSize": 500
}

Delete media interface for given ID

Delete media interface for given ID

User must have the media-interface:delete capability to perform this action.

path Parameters
mediaId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

SIP Servers

APIs for managing Session Initialization Protocol (SIP) servers.

Add new SIP server profile in SBCE

Add new SIP server profile in SBCE

User must have the sip-server-profile:create capability to perform this action.

Request Body schema: application/json
required

SIP Server Profile object that needs to be added in SBCE.

serverName
string

Name for the server

sipDomain
string

Domain of the SIP server

serverType
string
Enum: "CALL_SERVER" "TRUNK_SERVER" "MEDIA_SERVER" "REMOTE_BRANCH_OFFICE" "RECORDING_SERVER"

Type of Sip Server

tlsClientProfileId
integer

Valid Tls client profile

dnsQueryType
string
Enum: "NONE/A" "SRV" "NAPTR"

This value is valid when serverType is either CALL_SERVER, TRUNK_SERVER, or RECORDING_SERVER.

inboundConnectionReusePolicy
string
Enum: "NONE" "DEFAULT" "RFC_5923"

This value is considered valid when serverType is either CALL_SERVER, TRUNK_SERVER, or RECORDING_SERVER. The default setting is NONE, and when this value is set to DEFAULT or RFC_5923, grooming within the advanced configuration must be set to false.

Array of objects (SipServerAddress) >= 1
object (SipServerProfile_authentication)

enable or disable Authentication of sip server using this object

object (SipServerProfile_heartbeat)

enable or disable heartbeat of sip server using this object

object (SipServerProfile_registration)

registration options

object (SipServerProfile_ping)

ping option

object (SipServerProfile_advanced)
object (SipServerProfile_dos)

Responses

Request samples

Content type
application/json
Example
{
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "serverAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/sip-server-profiles/1",
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Get all SIP server profiles

Get all SIP server profiles

User must have the sip-server-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit SIP server profile in SBCE

Edit SIP server profile in SBCE

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the server

Request Body schema: application/json
required

SIP Server Profile object that needs to be added in SBCE.

serverName
string

Name for the server

sipDomain
string

Domain of the SIP server

serverType
string
Enum: "CALL_SERVER" "TRUNK_SERVER" "MEDIA_SERVER" "REMOTE_BRANCH_OFFICE" "RECORDING_SERVER"

Type of Sip Server

tlsClientProfileId
integer

Valid Tls client profile

dnsQueryType
string
Enum: "NONE/A" "SRV" "NAPTR"

This value is valid when serverType is either CALL_SERVER, TRUNK_SERVER, or RECORDING_SERVER.

inboundConnectionReusePolicy
string
Enum: "NONE" "DEFAULT" "RFC_5923"

This value is considered valid when serverType is either CALL_SERVER, TRUNK_SERVER, or RECORDING_SERVER. The default setting is NONE, and when this value is set to DEFAULT or RFC_5923, grooming within the advanced configuration must be set to false.

Responses

Request samples

Content type
application/json
{
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE"
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Get the SIP server profile for given ID

Get the SIP server profile for given ID

User must have the sip-server-profile:read capability to perform this action.

path Parameters
serverId
required
integer

ID of the server

Responses

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Delete the SIP server profile for given ID

Delete the SIP server profile for given ID

User must have the sip-server-profile:delete capability to perform this action.

path Parameters
serverId
required
integer

ID of the server

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new SIP server address to SIP server profile with serverId in SBCE.

Add new SIP server address to SIP server profile with serverId in SBCE.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server Address object that needs to be added to SIP Server in SBCE.

ipAddress
string

IP address for the server

port
integer <int64>

Port of the server

transport
string
Enum: "TCP" "TLS" "UDP"

Transport type of the server

whitelist
boolean
Default: false

The call is not blocked if the call originator exists in the Whitelist.

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "192.168.5.4",
  • "port": 5060,
  • "transport": "TLS",
  • "whitelist": false
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Get the SIP Server Addresses associated to SIP server profile for given ID

Get the SIP Server Addresses associated to SIP server profile for given ID

User must have the sip-server-profile:read capability to perform this action.

path Parameters
serverId
required
integer

ID of the server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit SIP server Address associated to SIP Server profile in SBCE

Edit SIP server Address associated to SIP Server profile in SBCE

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the server

serverAddressId
required
integer

ID of the serverAddress

Request Body schema: application/json
required

SIP Server Address object that needs to be added to SIP Server Profile in SBCE.

ipAddress
string

IP address for the server

port
integer <int64>

Port of the server

transport
string
Enum: "TCP" "TLS" "UDP"

Transport type of the server

whitelist
boolean
Default: false

The call is not blocked if the call originator exists in the Whitelist.

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "192.168.5.4",
  • "port": 5060,
  • "transport": "TLS",
  • "whitelist": false
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Delete the SIP server Address associated to SIP Server profile for given ID

Delete the SIP server Address associated to SIP Server profile for given ID

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the server

serverAddressId
required
integer

ID of the serverAddress

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Edit authentication details of SIP server profile with serverId in SBCE.

Edit authentication details of SIP server profile with serverId in SBCE.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server Authentication object that needs to be edit to SIP Server in SBCE.

enabled
boolean

enable or disable

userName
string
password
string
realm
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "userName": "test-user",
  • "password": "string",
  • "realm": "string"
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Edit heartbeat details of SIP server profile with serverId in SBCE.

Edit heartbeat details of SIP server profile with serverId in SBCE.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server Heartbeat object that needs to be edit to SIP Server in SBCE.

enabled
boolean
method
string
Enum: "OPTIONS" "PING"
retryTimeoutOnConnectionFailure
integer [ 2 .. 7200 ]
description
any
frequency
integer [ 30 .. 7200 ]
fromUri
string
toUri
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "method": "OPTIONS",
  • "retryTimeoutOnConnectionFailure": 2,
  • "description": null,
  • "frequency": 30,
  • "fromUri": "abc@def.com",
  • "toUri": "bcd@def.com"
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Edit registration details of SIP server profile with serverId in SBCE.

Edit registration details of SIP server profile with serverId in SBCE.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server Registration object that needs to be edit to SIP Server in SBCE.

registerWithAllServers
boolean
registerWithPriorityServer
boolean

this option is allowed when serverType is CALL_SERVER and dnsQueryType is NAPTR otherwise it will be false.

refreshInterval
integer
fromUri
string
toUri
string

Responses

Request samples

Content type
application/json
{
  • "registerWithAllServers": true,
  • "registerWithPriorityServer": false,
  • "refreshInterval": 0,
  • "fromUri": "abc@def.com",
  • "toUri": "bcd@def.com"
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Edit ping details of SIP server profile with serverId in SBCE.

Edit ping details of SIP server profile with serverId in SBCE.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server Ping object that needs to be edit to SIP Server in SBCE.

enabled
boolean
pingInterval
integer [ 1 .. 99999 ]
responseTime
integer [ 1 .. 99999 ]

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "pingInterval": 100,
  • "responseTime": 100
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Edit advanced details of SIP server profile with serverId in SBCE.

Edit advanced details of SIP server profile with serverId in SBCE.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server Advanced object that needs to be edit to SIP Server in SBCE.

enableGrooming
boolean

This value must be set to false when inboundConnectionReusePolicy in general configuration is DEFAULT or RFC_5923

interworkingProfileId
integer
securable
boolean
tolerant
boolean
uriGroupId
integer
ng911Support
boolean
object

Responses

Request samples

Content type
application/json
{
  • "enableGrooming": true,
  • "interworkingProfileId": 0,
  • "securable": false,
  • "tolerant": false,
  • "uriGroupId": 0,
  • "ng911Support": false,
  • "fgdn": {
    }
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Edit DoS protection settings for a specific SIP server

Edit the DoS protection settings for the specified a SIP server.

User must have the sip-server-profile:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the SIP Server

Request Body schema: application/json
required

SIP Server dos object that needs to be edit to SIP Server in SBCE.

enabled
boolean
object

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "dosProtection": {
    }
}

Response samples

Content type
application/json
{
  • "serverId": 1,
  • "serverName": "SM",
  • "sipDomain": "sbcdev4.com",
  • "serverType": "CALL_SERVER",
  • "tlsClientProfileId": 1,
  • "dnsQueryType": "NONE/A",
  • "inboundConnectionReusePolicy": "NONE",
  • "serverAddresses": [
    ],
  • "authentication": {
    },
  • "heartbeat": {
    },
  • "registration": {
    },
  • "ping": {
    },
  • "advanced": {
    },
  • "dos": {
    }
}

Server Flows

APIs for managing server flows.

Add new server flow in SBCE

Add new server flow in SBCE

Request Body schema: application/json
flowName
string

Name for the server flow

sipServerProfileId
integer

SIP server profile

transport
string
Enum: "ANY" "TCP" "TLS" "UDP"

Transport type

receivedInterfaceId
integer

id of Received Interface

signalingInterfaceId
integer

id of signaling Interface

mediaInterfaceId
integer

id of Media Interface

endPointPolicyGroupId
integer

Id of Endpoint Policy group

topologyHidingProfileId
integer

Id of Topology Hiding profile

routingProfileId
integer

Id of Routing profile

fqdnSupport
boolean
Default: false

value should be true to enable the fqdn support.

fqdn
string <fqdn>
Default: null

The value should be present when fqdnSupport is true.

uriGroupId
integer
Default: 1

Profile id of the Uri Group. Below are the list of default profiles.

  • 0 - None
  • 1 - *
  • 2000 - Emergency

Responses

Request samples

Content type
application/json
{
  • "flowName": "Server_flow1",
  • "sipServerProfileId": 1,
  • "transport": "TCP",
  • "receivedInterfaceId": 1,
  • "signalingInterfaceId": 1,
  • "mediaInterfaceId": 1,
  • "endPointPolicyGroupId": 1,
  • "topologyHidingProfileId": 1,
  • "routingProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "uriGroupId": 1
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/sip-server-flows/2/priorities/1",
  • "priority": 1,
  • "flowName": "Server_flow1",
  • "sipServerProfileId": 1,
  • "transport": "TCP",
  • "receivedInterfaceId": 1,
  • "signalingInterfaceId": 1,
  • "mediaInterfaceId": 1,
  • "endPointPolicyGroupId": 1,
  • "topologyHidingProfileId": 1,
  • "routingProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "uriGroupId": 1
}

Get all server flows

Get all server flows

User must have the server-interworking:read capability to perform this action.

Note: This is a bug and will be changed to server-flow:read in a future release.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all server flows associated with sip server profile.

Get all server flows

User must have the server-interworking:read capability to perform this action.

Note: This is a bug and will be changed to server-flow:read in a future release.

path Parameters
sipServerProfileId
required
integer

ID of sip server profile.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit server flow in SBCE

Edit server flow in SBCE

User must have the server-interworking:update capability to perform this action.

Note: This is a bug and will be changed to server-flow:update in a future release.

path Parameters
sipServerProfileId
required
integer

ID of the Sip server profile associated to flow

priority
required
integer

priority of flow

Request Body schema: application/json
priority
integer <int64>

The new priority to update. This value can be negative priority. that means that the priority value -1 will be the least priority, and -2 will be the second least priority. The negative priority starts from where the priorities ends. This means that the last priority of the server flows is the first element in the negative indexing which is -1.

For Example, if there are 5 sip server flows associated with sip server profile. and the least priority is 5. So -1 priority indicates priority 5 and -5 indicates priority 1.

flowName
string

Name for the server flow

sipServerProfileId
integer

SIP server profile

transport
string
Enum: "ANY" "TCP" "TLS" "UDP"

Transport type

receivedInterfaceId
integer

id of Received Interface

signalingInterfaceId
integer

id of signaling Interface

mediaInterfaceId
integer

id of Media Interface

endPointPolicyGroupId
integer

Id of Endpoint Policy group

topologyHidingProfileId
integer

Id of Topology Hiding profile

routingProfileId
integer

Id of Routing profile

fqdnSupport
boolean
Default: false

value should be true to enable the fqdn support.

fqdn
string <fqdn>
Default: null

The value should be present when fqdnSupport is true.

uriGroupId
integer
Default: 1

Profile id of the Uri Group. Below are the list of default profiles.

  • 0 - None
  • 1 - *
  • 2000 - Emergency

Responses

Request samples

Content type
application/json
{
  • "priority": 1,
  • "flowName": "Server_flow1",
  • "sipServerProfileId": 1,
  • "transport": "TCP",
  • "receivedInterfaceId": 1,
  • "signalingInterfaceId": 1,
  • "mediaInterfaceId": 1,
  • "endPointPolicyGroupId": 1,
  • "topologyHidingProfileId": 1,
  • "routingProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "uriGroupId": 1
}

Response samples

Content type
application/json
[
  • {
    }
]

Get server flow for given ID

Get server flow for given ID

User must have the server-interworking:read capability to perform this action.

Note: This is a bug and will be changed to server-flow:read in a future release.

path Parameters
sipServerProfileId
required
integer

ID of the Sip server profile associated to flow

priority
required
integer

priority of flow

Responses

Response samples

Content type
application/json
{
  • "priority": 1,
  • "flowName": "Server_flow1",
  • "sipServerProfileId": 1,
  • "transport": "TCP",
  • "receivedInterfaceId": 1,
  • "signalingInterfaceId": 1,
  • "mediaInterfaceId": 1,
  • "endPointPolicyGroupId": 1,
  • "topologyHidingProfileId": 1,
  • "routingProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "uriGroupId": 1
}

Delete server flow for given ID

Delete server flow for given ID

User must have the server-interworking:delete capability to perform this action.

Note: This is a bug and will be changed to server-flow:delete in a future release.

path Parameters
sipServerProfileId
required
integer

ID of the Sip server profile associated to flow

priority
required
integer

priority of flow

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Subscriber Flows

APIs for managing subscriber flows.

Add new subscriber flow in SBCE

Add new subscriber flow in SBCE

User must have the sip-subscriber-flow:create capability to perform this action.

Request Body schema: application/json
flowName
string

Name for the subscriber flow

uriGroupId
integer

URI group

userAgentId
integer

User agent

viaHost
string
Default: "*"
contactHost
string
Default: "*"
sourceSubnet
string
Default: "*"
signalingInterfaceId
integer

Signaling interface

source
string
Default: "SUBSCRIBER"
Enum: "SUBSCRIBER" "CLICK2CALL"
methodsAllowed
Array of strings
Items Enum: "INFO" "MESSAGE" "NOTIFY" "OPTIONS" "PING" "PUBLISH" "SUBSCRIBE"

This field is accepted when the source is SUBSCRIBER.

mediaInterfaceId
integer

Media interface

receivingInterfaceId
integer

Receiving interface - This field is accepted when the source is CLICKTOCALL.

endPointPolicyGroupId
integer

Endpoint policy group

routingProfileId
integer

Routing profile

tlsClientProfileId
integer

TLS client profile

sigmaProfileId
integer

Sigma Profile

fqdnSupport
boolean
Default: false

value should be true to enable the fqdn support.

fqdn
string <fqdn>
Default: null

The value should be present when fqdnSupport is true.

ipUriBlocklistProfileId
integer
Default: 0

Control IP / URI Blocklist feature for this flow.

Using the default value will disable this feature for this flow.

ipUriBlocklistTrustedAddress
string

Trusted IP address for IP / URI Blocklist Profile (will not be blocked)

Responses

Request samples

Content type
application/json
{
  • "flowName": "Sig_int",
  • "uriGroupId": 1,
  • "userAgentId": 1,
  • "viaHost": "*",
  • "contactHost": "*",
  • "sourceSubnet": "*",
  • "signalingInterfaceId": 1,
  • "source": "SUBSCRIBER",
  • "methodsAllowed": [
    ],
  • "mediaInterfaceId": 2,
  • "receivingInterfaceId": -1,
  • "endPointPolicyGroupId": 1,
  • "routingProfileId": 1,
  • "tlsClientProfileId": 1,
  • "sigmaProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/sip-subscriber-flows/1",
  • "flowId": 1,
  • "flowName": "Sig_int",
  • "uriGroupId": 1,
  • "userAgentId": 1,
  • "viaHost": "*",
  • "contactHost": "*",
  • "sourceSubnet": "*",
  • "signalingInterfaceId": 1,
  • "source": "SUBSCRIBER",
  • "methodsAllowed": [
    ],
  • "mediaInterfaceId": 2,
  • "receivingInterfaceId": -1,
  • "endPointPolicyGroupId": 1,
  • "routingProfileId": 1,
  • "tlsClientProfileId": 1,
  • "sigmaProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1"
}

Get all subscriber flows

Get all subscriber flows

User must have the sip-subscriber-flow:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit subscriber flow in SBCE

Edit subscriber flow in SBCE User must have the sip-subscriber-flow:update capability to perform this action.

path Parameters
flowId
required
integer

ID of the flow

Request Body schema: application/json
flowId
integer <int64>

ID of the flow

flowName
string

Name for the subscriber flow

uriGroupId
integer

URI group

userAgentId
integer

User agent

viaHost
string
Default: "*"
contactHost
string
Default: "*"
sourceSubnet
string
Default: "*"
signalingInterfaceId
integer

Signaling interface

source
string
Default: "SUBSCRIBER"
Enum: "SUBSCRIBER" "CLICK2CALL"
methodsAllowed
Array of strings
Items Enum: "INFO" "MESSAGE" "NOTIFY" "OPTIONS" "PING" "PUBLISH" "SUBSCRIBE"

This field is accepted when the source is SUBSCRIBER.

mediaInterfaceId
integer

Media interface

receivingInterfaceId
integer

Receiving interface - This field is accepted when the source is CLICKTOCALL.

endPointPolicyGroupId
integer

Endpoint policy group

routingProfileId
integer

Routing profile

tlsClientProfileId
integer

TLS client profile

sigmaProfileId
integer

Sigma Profile

fqdnSupport
boolean
Default: false

value should be true to enable the fqdn support.

fqdn
string <fqdn>
Default: null

The value should be present when fqdnSupport is true.

ipUriBlocklistProfileId
integer
Default: 0

Control IP / URI Blocklist feature for this flow.

Using the default value will disable this feature for this flow.

ipUriBlocklistTrustedAddress
string

Trusted IP address for IP / URI Blocklist Profile (will not be blocked)

Responses

Request samples

Content type
application/json
{
  • "flowId": 1,
  • "flowName": "Sig_int",
  • "uriGroupId": 1,
  • "userAgentId": 1,
  • "viaHost": "*",
  • "contactHost": "*",
  • "sourceSubnet": "*",
  • "signalingInterfaceId": 1,
  • "source": "SUBSCRIBER",
  • "methodsAllowed": [
    ],
  • "mediaInterfaceId": 2,
  • "receivingInterfaceId": -1,
  • "endPointPolicyGroupId": 1,
  • "routingProfileId": 1,
  • "tlsClientProfileId": 1,
  • "sigmaProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1"
}

Response samples

Content type
application/json
{
  • "flowId": 1,
  • "flowName": "Sig_int",
  • "uriGroupId": 1,
  • "userAgentId": 1,
  • "viaHost": "*",
  • "contactHost": "*",
  • "sourceSubnet": "*",
  • "signalingInterfaceId": 1,
  • "source": "SUBSCRIBER",
  • "methodsAllowed": [
    ],
  • "mediaInterfaceId": 2,
  • "receivingInterfaceId": -1,
  • "endPointPolicyGroupId": 1,
  • "routingProfileId": 1,
  • "tlsClientProfileId": 1,
  • "sigmaProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1"
}

Get subscriber flow for given ID

Get subscriber flow for given ID User must have the sip-subscriber-flow:read capability to perform this action.

path Parameters
flowId
required
integer

ID of the flow

Responses

Response samples

Content type
application/json
{
  • "flowId": 1,
  • "flowName": "Sig_int",
  • "uriGroupId": 1,
  • "userAgentId": 1,
  • "viaHost": "*",
  • "contactHost": "*",
  • "sourceSubnet": "*",
  • "signalingInterfaceId": 1,
  • "source": "SUBSCRIBER",
  • "methodsAllowed": [
    ],
  • "mediaInterfaceId": 2,
  • "receivingInterfaceId": -1,
  • "endPointPolicyGroupId": 1,
  • "routingProfileId": 1,
  • "tlsClientProfileId": 1,
  • "sigmaProfileId": 1,
  • "fqdnSupport": true,
  • "fqdn": "some-fqdn.com",
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1"
}

Delete subscriber flow for given ID

Delete subscriber flow for given ID User must have the sip-subscriber-flow:delete capability to perform this action.

path Parameters
flowId
required
integer

ID of the flow

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Reverse Proxy Profiles

APIs for managing reverse proxy profiles.

Add new reverse proxy profile data in SBCE

Add new reverse proxy profile data in SBCE

User must have the reverse-proxy-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string

Name of the reverse proxy profile

allowWebSocket
boolean

Enable/Disable web socket

httpVersion
string
Default: "HTTP_1"
Value: "HTTP_1"

HTTP version to use

clientMaxBodySizeInMB
integer

Request max body size

clientBodyTimeoutInSeconds
integer

Client body timeout

clientHeaderTimeoutInSeconds
integer

Client header timeout

dnsResolverTimeoutInSeconds
integer

DNS resolver timeout

sslSessionTimeoutInSeconds
integer

TLS/SSL session timeout

serverReadTimeoutInSeconds
integer

Server read timeout

enableRateLimiting
boolean

Enable/Disable rate limiting

totalClientCount
integer

Total number of clients

maxConnPerClient
integer

Max simultaneous connections

avgRequestRate
integer

Average request rate

rateUnitPerClient
string
Default: "SECONDS"
Enum: "SECONDS" "MINUTES"

Rate unit

burstPerClient
integer

Burst per client

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "allowWebSocket": true,
  • "httpVersion": "HTTP_1",
  • "clientMaxBodySizeInMB": 10,
  • "clientBodyTimeoutInSeconds": 30,
  • "clientHeaderTimeoutInSeconds": 30,
  • "dnsResolverTimeoutInSeconds": 30,
  • "sslSessionTimeoutInSeconds": 300,
  • "serverReadTimeoutInSeconds": 300,
  • "enableRateLimiting": true,
  • "totalClientCount": 30,
  • "maxConnPerClient": 5,
  • "avgRequestRate": 20,
  • "rateUnitPerClient": "SECONDS",
  • "burstPerClient": 20
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/reverse-proxy-profiles/1",
  • "profileId": 1,
  • "profileName": "test",
  • "allowWebSocket": true,
  • "httpVersion": "HTTP_1",
  • "clientMaxBodySizeInMB": 10,
  • "clientBodyTimeoutInSeconds": 30,
  • "clientHeaderTimeoutInSeconds": 30,
  • "dnsResolverTimeoutInSeconds": 30,
  • "sslSessionTimeoutInSeconds": 300,
  • "serverReadTimeoutInSeconds": 300,
  • "enableRateLimiting": true,
  • "totalClientCount": 30,
  • "maxConnPerClient": 5,
  • "avgRequestRate": 20,
  • "rateUnitPerClient": "SECONDS",
  • "burstPerClient": 20
}

Get all reverse proxy profiles

Get all reverse proxy profiles

User must have the reverse-proxy-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit reverse proxy profile for given ID

Edit reverse proxy profile for given ID

User must have the reverse-proxy-profile:update capability to perform this action.

path Parameters
profileId
required
integer >= 1

ID of the profile

Request Body schema: application/json
profileId
integer

ID of the reverse proxy profile

profileName
string

Name of the reverse proxy profile

allowWebSocket
boolean

Enable/Disable web socket

httpVersion
string
Default: "HTTP_1"
Value: "HTTP_1"

HTTP version to use

clientMaxBodySizeInMB
integer

Request max body size

clientBodyTimeoutInSeconds
integer

Client body timeout

clientHeaderTimeoutInSeconds
integer

Client header timeout

dnsResolverTimeoutInSeconds
integer

DNS resolver timeout

sslSessionTimeoutInSeconds
integer

TLS/SSL session timeout

serverReadTimeoutInSeconds
integer

Server read timeout

enableRateLimiting
boolean

Enable/Disable rate limiting

totalClientCount
integer

Total number of clients

maxConnPerClient
integer

Max simultaneous connections

avgRequestRate
integer

Average request rate

rateUnitPerClient
string
Default: "SECONDS"
Enum: "SECONDS" "MINUTES"

Rate unit

burstPerClient
integer

Burst per client

Responses

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "allowWebSocket": true,
  • "httpVersion": "HTTP_1",
  • "clientMaxBodySizeInMB": 10,
  • "clientBodyTimeoutInSeconds": 30,
  • "clientHeaderTimeoutInSeconds": 30,
  • "dnsResolverTimeoutInSeconds": 30,
  • "sslSessionTimeoutInSeconds": 300,
  • "serverReadTimeoutInSeconds": 300,
  • "enableRateLimiting": true,
  • "totalClientCount": 30,
  • "maxConnPerClient": 5,
  • "avgRequestRate": 20,
  • "rateUnitPerClient": "SECONDS",
  • "burstPerClient": 20
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "allowWebSocket": true,
  • "httpVersion": "HTTP_1",
  • "clientMaxBodySizeInMB": 10,
  • "clientBodyTimeoutInSeconds": 30,
  • "clientHeaderTimeoutInSeconds": 30,
  • "dnsResolverTimeoutInSeconds": 30,
  • "sslSessionTimeoutInSeconds": 300,
  • "serverReadTimeoutInSeconds": 300,
  • "enableRateLimiting": true,
  • "totalClientCount": 30,
  • "maxConnPerClient": 5,
  • "avgRequestRate": 20,
  • "rateUnitPerClient": "SECONDS",
  • "burstPerClient": 20
}

Get reverse proxy profile for given ID

Get reverse proxy profile for given ID

User must have the reverse-proxy-profile:read capability to perform this action.

path Parameters
profileId
required
integer >= 1

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "allowWebSocket": true,
  • "httpVersion": "HTTP_1",
  • "clientMaxBodySizeInMB": 10,
  • "clientBodyTimeoutInSeconds": 30,
  • "clientHeaderTimeoutInSeconds": 30,
  • "dnsResolverTimeoutInSeconds": 30,
  • "sslSessionTimeoutInSeconds": 300,
  • "serverReadTimeoutInSeconds": 300,
  • "enableRateLimiting": true,
  • "totalClientCount": 30,
  • "maxConnPerClient": 5,
  • "avgRequestRate": 20,
  • "rateUnitPerClient": "SECONDS",
  • "burstPerClient": 20
}

Delete reverse proxy profile for given ID

Delete reverse proxy profile for given ID

User must have the reverse-proxy-profile:delete capability to perform this action.

path Parameters
profileId
required
integer >= 1

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

PPM Mapping Profiles

APIs for managing Personal Profile Manager (PPM) mapping profiles.

Create new PPM Mapping Profile in SBCE

Adds new PPM Mapping Profile in SBCE.

User must have the ppm-mapping-profile:create capability to perform this action.

Request Body schema: application/json
ppmName
string
Array of objects (PostPPMEntry)

Responses

Request samples

Content type
application/json
{
  • "ppmName": "ppm-profile-1",
  • "ppmEntryList": [
    ]
}

Response samples

Content type
application/json
{
  • "ppmProfileId": 1,
  • "ppmName": "ppm-profile-1",
  • "resourcePath": "/api/config/v1/ppm-mapping-profiles/1",
  • "ppmEntryList": [
    ]
}

Get all PPM Mapping Profiles configured in SBCE

Retrieve all PPM Mapping Profiles configured in SBCE.

User must have the ppm-mapping-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get PPM Mapping Profile by ppmProfileId configured in SBCE

Get PPM Mapping Profile by ppmProfileId configured in SBCE.

User must have the ppm-mapping-profile:read capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the PPM Mapping Profile

Responses

Response samples

Content type
application/json
{
  • "ppmProfileId": 1,
  • "ppmName": "ppm-profile-1",
  • "ppmEntryList": [
    ]
}

Delete PPM Mapping Profile by ppmProfileId in SBCE

Delete PPM Mapping Profile by ppmProfileId in SBCE

User must have the ppm-mapping-profile:delete capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new PPM Entry to PPM Mapping Profile by ppmProfileId in SBCE

Add new PPM Entry to PPM Mapping Profile by ppmProfileId in SBCE

User must have the ppm-mapping-profile:create capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the PPM Mapping Profile

Request Body schema: application/json
serverType
string
Enum: "PRESENCE" "SM" "BRANCH_SM"
customValues
boolean
serverAddressId
integer
serverAddress
string
serverPort
number [ 1 .. 65534 ]
serverTransport
string
Enum: "TCP" "UDP" "TLS"
signalingInterfaceId
number
mappedIp
string
mappedPort
number [ 1 .. 65534 ]
mappedTransport
string
Enum: "TCP" "UDP" "TLS"

Responses

Request samples

Content type
application/json
Example
{
  • "serverType": "PRESENCE",
  • "customValues": true,
  • "serverAddress": "www.test.com",
  • "mappedIp": "www.test2.com"
}

Response samples

Content type
application/json
Example
{
  • "resourcePath": "/api/config/v1/ppm-mapping-profiles/1/ppm-entries/14",
  • "ppmEntryId": 14,
  • "serverType": "PRESENCE",
  • "customValues": true,
  • "serverAddress": "www.test.com",
  • "mappedIp": "www.test2.com"
}

Get all PPM Entries associated to PPM Mapping Profile by ppmProfileId in SBCE

Get all PPM Entries associated to PPM Mapping Profile by ppmProfileId in SBCE

User must have the ppm-mapping-profile:read capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the PPM Mapping Profile

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Edit PPMEntry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE

Edit PPMEntry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE

User must have the ppm-mapping-profile:update capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the PPM Mapping Profile

ppmEntryId
required
integer

ID of the PPM Entry

Request Body schema: application/json
serverType
string
Enum: "PRESENCE" "SM" "BRANCH_SM"
customValues
boolean
serverAddressId
integer
serverAddress
string
serverPort
number [ 1 .. 65534 ]
serverTransport
string
Enum: "TCP" "UDP" "TLS"
signalingInterfaceId
number
mappedIp
string
mappedPort
number [ 1 .. 65534 ]
mappedTransport
string
Enum: "TCP" "UDP" "TLS"

Responses

Request samples

Content type
application/json
Example
{
  • "serverType": "PRESENCE",
  • "customValues": true,
  • "serverAddress": "www.test.com",
  • "mappedIp": "www.test2.com"
}

Response samples

Content type
application/json
Example
{
  • "ppmEntryId": 14,
  • "serverType": "PRESENCE",
  • "customValues": true,
  • "serverAddress": "www.test.com",
  • "mappedIp": "www.test2.com"
}

Get PPM Entry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE

Get PPM Entry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE

User must have the ppm-mapping-profile:read capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the PPM Mapping Profile

ppmEntryId
required
integer

ID of the PPM Entry

Responses

Response samples

Content type
application/json
Example
{
  • "ppmEntryId": 14,
  • "serverType": "PRESENCE",
  • "customValues": true,
  • "serverAddress": "www.test.com",
  • "mappedIp": "www.test2.com"
}

Delete PPM Entry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE

Delete PPM Entry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE

User must have the ppm-mapping-profile:delete capability to perform this action.

path Parameters
ppmProfileId
required
integer

ID of the PPM Mapping Profile

ppmEntryId
required
integer

ID of the PPM Entry

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Reverse Proxy Relays

APIs for managing Hypertext Transfer Protocol (HTTP) reverse proxy relays.

Add new reverse proxy relay in SBCE

Add new reverse proxy relay in SBCE

User must have the reverse-proxy-relay:create capability to perform this action.

Request Body schema: application/json
relayName
string

Name of the reverse proxy relay

listenIp
string

Listen IP

listenPort
integer

Listen port

connectIp
string

Connect IP

serverTlsProfile
string

TLS profile

listenDomain
string

Listen domain

rewriteUrl
boolean

Rewrite URLs

ppmMappingProfileId
integer

ID of PPM Mapping profile

reverseProxyProfileId
integer
ipUriBlocklistProfileId
integer
Default: 0

Control IP / URI Blocklist feature for this flow.

Using the default value will disable this feature for this flow.

ipUriBlocklistTrustedAddress
string

Trusted IP address for IP / URI Blocklist Profile (will not be blocked)

whitelistedIps
Array of strings

Whitelisted IPs (comma separated)

Array of objects (ReverseProxyServerAddress)

Responses

Request samples

Content type
application/json
{
  • "relayName": "test",
  • "listenIp": "10.133.39.171",
  • "listenPort": 1235,
  • "connectIp": "10.133.73.46",
  • "serverTlsProfile": "None",
  • "listenDomain": "abc.com",
  • "rewriteUrl": true,
  • "ppmMappingProfileId": 1,
  • "reverseProxyProfileId": 1,
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1",
  • "whitelistedIps": [
    ],
  • "serverAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/reverse-proxy-relays/1",
  • "relayId": 1,
  • "relayName": "test",
  • "listenIp": "10.133.39.171",
  • "listenPort": 1235,
  • "connectIp": "10.133.73.46",
  • "serverTlsProfile": "None",
  • "listenDomain": "abc.com",
  • "rewriteUrl": true,
  • "ppmMappingProfileId": 1,
  • "reverseProxyProfileId": 1,
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1",
  • "whitelistedIps": [
    ],
  • "serverAddresses": [
    ]
}

Get all reverse proxy relay services

Get all reverse proxy relay services

User must have the reverse-proxy-relay:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit reverse proxy relay in SBCE

Edit reverse proxy relay in SBCE

User must have the reverse-proxy-relay:update capability to perform this action.

path Parameters
relayId
required
integer >= 1

ID of the server

Request Body schema: application/json
relayId
integer

ID of the reverse proxy relay

relayName
string

Name of the reverse proxy relay

listenIp
string

Listen IP

listenPort
integer

Listen port

connectIp
string

Connect IP

serverTlsProfile
string

TLS profile

listenDomain
string

Listen domain

rewriteUrl
boolean

Rewrite URLs

ppmMappingProfileId
integer

ID of PPM Mapping profile

reverseProxyProfileId
integer
ipUriBlocklistProfileId
integer
Default: 0

Control IP / URI Blocklist feature for this flow.

Using the default value will disable this feature for this flow.

ipUriBlocklistTrustedAddress
string

Trusted IP address for IP / URI Blocklist Profile (will not be blocked)

whitelistedIps
Array of strings

Whitelisted IPs (comma separated)

Array of objects (ReverseProxyServerAddress)

Responses

Request samples

Content type
application/json
{
  • "relayId": 1,
  • "relayName": "test",
  • "listenIp": "10.133.39.171",
  • "listenPort": 1235,
  • "connectIp": "10.133.73.46",
  • "serverTlsProfile": "None",
  • "listenDomain": "abc.com",
  • "rewriteUrl": true,
  • "ppmMappingProfileId": 1,
  • "reverseProxyProfileId": 1,
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1",
  • "whitelistedIps": [
    ],
  • "serverAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "relayId": 1,
  • "relayName": "test",
  • "listenIp": "10.133.39.171",
  • "listenPort": 1235,
  • "connectIp": "10.133.73.46",
  • "serverTlsProfile": "None",
  • "listenDomain": "abc.com",
  • "rewriteUrl": true,
  • "ppmMappingProfileId": 1,
  • "reverseProxyProfileId": 1,
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1",
  • "whitelistedIps": [
    ],
  • "serverAddresses": [
    ]
}

Get reverse proxy relay for given ID

Get reverse proxy relay for given ID

User must have the reverse-proxy-relay:read capability to perform this action.

path Parameters
relayId
required
integer >= 1

ID of the server

Responses

Response samples

Content type
application/json
{
  • "relayId": 1,
  • "relayName": "test",
  • "listenIp": "10.133.39.171",
  • "listenPort": 1235,
  • "connectIp": "10.133.73.46",
  • "serverTlsProfile": "None",
  • "listenDomain": "abc.com",
  • "rewriteUrl": true,
  • "ppmMappingProfileId": 1,
  • "reverseProxyProfileId": 1,
  • "ipUriBlocklistProfileId": 1,
  • "ipUriBlocklistTrustedAddress": "10.0.0.1",
  • "whitelistedIps": [
    ],
  • "serverAddresses": [
    ]
}

Delete the reverse proxy relay for given ID

Delete the reverse proxy relay for given ID

User must have the reverse-proxy-relay:delete capability to perform this action.

path Parameters
relayId
required
integer >= 1

ID of the server

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Application Relays

APIs for managing application relays.

List all application relays

Retrieve a list of all application relays for this system.

User must have the application-relay:read capability.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new application relay

Create a new application relay for this system.

User must have the application-relay:create capability.

Request Body schema: application/json
relayName
string

The name of this application relay.

serviceType
string
Enum: "XMPP" "RTCP" "LDAP" "SCEP" "HTTP" "CES_PROXY" "OTHER"

The type of service that will be relayed.

Notes:

  • Relaying HTTP traffic may be better served with a Reverse Proxy Relay.
  • CES_PROXY relays require one CES license per active connection.
listenIpId
integer

The ID of the IP address that will be used to listen for incoming connections.

This cannot be the same ID as the connect IP ID.

listenPort
integer

The port to listen on.

listenTransport
string
Enum: "TCP" "UDP" "TLS"
listenTlsProfileId
integer

This field must be specified if listenTransport is TLS.

The ID of the TLS server profile to use when establishing TLS connections while listening for traffic on for this relay.

listenConnectIpId
integer

The ID of the IP address that will be used to connect to the remote address.

This cannot be the same ID as the listen IP ID.

remoteAddress
string

The remote IP address or FQDN to send relayed traffic to.

remotePort
integer

The remote port to send relayed traffic to.

remoteTransport
string
Enum: "TCP" "UDP" "TLS"

The transport to use when determining how to send traffic to the remote address.

remoteTlsProfileId
integer

This field must be specified if remoteTransport is TLS.

The ID of the TLS client profile to use when establishing TLS connections to the remote address.

whitelistedFlows
boolean

Whitelist flows for CES_PROXY.

Responses

Request samples

Content type
application/json
{
  • "relayName": "LDAPS Relay",
  • "serviceType": "LDAP",
  • "listenIpId": 1,
  • "listenPort": 636,
  • "listenTransport": "TLS",
  • "listenTlsProfileId": 2,
  • "listenConnectIpId": 2,
  • "remoteAddress": "ldaps.test.com",
  • "remotePort": 636,
  • "remoteTransport": "TLS",
  • "remoteTlsProfileId": 3,
  • "whitelistedFlows": false
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "relayName": "LDAPS Relay",
  • "serviceType": "LDAP",
  • "listenIpId": 1,
  • "listenPort": 636,
  • "listenTransport": "TLS",
  • "listenTlsProfileId": 2,
  • "listenConnectIpId": 2,
  • "remoteAddress": "ldaps.test.com",
  • "remotePort": 636,
  • "remoteTransport": "TLS",
  • "remoteTlsProfileId": 3,
  • "whitelistedFlows": false
}

Get an application relay

Retrieve an application relay for this system.

User must have the application-relay:read capability.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "relayId": 0,
  • "relayName": "LDAPS Relay",
  • "serviceType": "LDAP",
  • "listenIpId": 1,
  • "listenPort": 636,
  • "listenTransport": "TLS",
  • "listenTlsProfileId": 2,
  • "listenConnectIpId": 2,
  • "remoteAddress": "ldaps.test.com",
  • "remotePort": 636,
  • "remoteTransport": "TLS",
  • "remoteTlsProfileId": 3,
  • "whitelistedFlows": false
}

Modify an existing application relay

Modify an application relay for this system.

User must have the application-relay:update capability.

path Parameters
id
required
integer
Request Body schema: application/json
relayName
string

The name of this application relay.

serviceType
string
Enum: "XMPP" "RTCP" "LDAP" "SCEP" "HTTP" "CES_PROXY" "OTHER"

The type of service that will be relayed.

Notes:

  • Relaying HTTP traffic may be better served with a Reverse Proxy Relay.
  • CES_PROXY relays require one CES license per active connection.
listenIpId
integer

The ID of the IP address that will be used to listen for incoming connections.

This cannot be the same ID as the connect IP ID.

listenPort
integer

The port to listen on.

listenTransport
string
Enum: "TCP" "UDP" "TLS"
listenTlsProfileId
integer

This field must be specified if listenTransport is TLS.

The ID of the TLS server profile to use when establishing TLS connections while listening for traffic on for this relay.

listenConnectIpId
integer

The ID of the IP address that will be used to connect to the remote address.

This cannot be the same ID as the listen IP ID.

remoteAddress
string

The remote IP address or FQDN to send relayed traffic to.

remotePort
integer

The remote port to send relayed traffic to.

remoteTransport
string
Enum: "TCP" "UDP" "TLS"

The transport to use when determining how to send traffic to the remote address.

remoteTlsProfileId
integer

This field must be specified if remoteTransport is TLS.

The ID of the TLS client profile to use when establishing TLS connections to the remote address.

whitelistedFlows
boolean

Whitelist flows for CES_PROXY.

Responses

Request samples

Content type
application/json
{
  • "relayName": "LDAPS Relay",
  • "serviceType": "LDAP",
  • "listenIpId": 1,
  • "listenPort": 636,
  • "listenTransport": "TLS",
  • "listenTlsProfileId": 2,
  • "listenConnectIpId": 2,
  • "remoteAddress": "ldaps.test.com",
  • "remotePort": 636,
  • "remoteTransport": "TLS",
  • "remoteTlsProfileId": 3,
  • "whitelistedFlows": false
}

Response samples

Content type
application/json
{
  • "relayName": "LDAPS Relay",
  • "serviceType": "LDAP",
  • "listenIpId": 1,
  • "listenPort": 636,
  • "listenTransport": "TLS",
  • "listenTlsProfileId": 2,
  • "listenConnectIpId": 2,
  • "remoteAddress": "ldaps.test.com",
  • "remotePort": 636,
  • "remoteTransport": "TLS",
  • "remoteTlsProfileId": 3,
  • "whitelistedFlows": false
}

Delete an existing application relay

Delete an application relay for this system.

User must have the application-relay:delete capability.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Turn Stun Profiles

APIs for managing Traversal Using Relays around NAT (TURN) / Session Traversal Utilities for NAT (STUN) profiles.

Add new turn stun profile data in SBCE

Add new turn stun profile data in SBCE

User must have the turn-stun-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string

Name of the turn stun profile

udpListenPort
integer

UDP listen port

tcpTlsListenPort
integer

TCP/TLS listen port

tlsServerProfileName
string

TLS server profile

mediaRelayMinPort
integer

Media relay minimum port

mediaRelayMaxPort
integer

Media relay maximum port

object or object
fingerPrint
boolean

Fingerprint enabled/disabled

tcpRelay
boolean

TCP relay enabled/disabled

udpRelay
boolean

UDP Relay enabled/disabled

dtls
boolean

DTLS enabled/disabled

mediaLearning
boolean

Media learning enabled/disabled

alternateServer1
string <ipv4>
alternateServer2
string <ipv4>
alternateServer3
string <ipv4>

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "udpListenPort": 5060,
  • "tcpTlsListenPort": 1111,
  • "tlsServerProfileName": null,
  • "mediaRelayMinPort": 50000,
  • "mediaRelayMaxPort": 55000,
  • "authentication": {
    },
  • "fingerPrint": "Y",
  • "tcpRelay": "Y",
  • "udpRelay": "Y",
  • "dtls": "N",
  • "mediaLearning": "Y",
  • "alternateServer1": "1.1.1.1",
  • "alternateServer2": "1.1.1.1",
  • "alternateServer3": "1.1.1.1"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/turn-stun-profiles/1",
  • "profileId": 1,
  • "profileName": "test",
  • "udpListenPort": 5060,
  • "tcpTlsListenPort": 1111,
  • "tlsServerProfileName": null,
  • "mediaRelayMinPort": 50000,
  • "mediaRelayMaxPort": 55000,
  • "authentication": {
    },
  • "fingerPrint": "Y",
  • "tcpRelay": "Y",
  • "udpRelay": "Y",
  • "dtls": "N",
  • "mediaLearning": "Y",
  • "alternateServer1": "1.1.1.1",
  • "alternateServer2": "1.1.1.1",
  • "alternateServer3": "1.1.1.1"
}

Get all turn stun profiles

Get all turn stun profiles

User must have the turn-stun-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Edit turn stun profile data in SBCE

Edit new turn stun profile data in SBCE

User must have the turn-stun-profile:update capability to perform this action.

path Parameters
profileId
required
integer >= 1

ID of the profile

Request Body schema: application/json
profileId
integer

ID of turn stun profile

profileName
string

Name of the turn stun profile

udpListenPort
integer

UDP listen port

tcpTlsListenPort
integer

TCP/TLS listen port

tlsServerProfileName
string

TLS server profile

mediaRelayMinPort
integer

Media relay minimum port

mediaRelayMaxPort
integer

Media relay maximum port

object or object
fingerPrint
boolean

Fingerprint enabled/disabled

tcpRelay
boolean

TCP relay enabled/disabled

udpRelay
boolean

UDP Relay enabled/disabled

dtls
boolean

DTLS enabled/disabled

mediaLearning
boolean

Media learning enabled/disabled

alternateServer1
string <ipv4>
alternateServer2
string <ipv4>
alternateServer3
string <ipv4>

Responses

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "udpListenPort": 5060,
  • "tcpTlsListenPort": 1111,
  • "tlsServerProfileName": null,
  • "mediaRelayMinPort": 50000,
  • "mediaRelayMaxPort": 55000,
  • "authentication": {
    },
  • "fingerPrint": "Y",
  • "tcpRelay": "Y",
  • "udpRelay": "Y",
  • "dtls": "N",
  • "mediaLearning": "Y",
  • "alternateServer1": "1.1.1.1",
  • "alternateServer2": "1.1.1.1",
  • "alternateServer3": "1.1.1.1"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "udpListenPort": 5060,
  • "tcpTlsListenPort": 1111,
  • "tlsServerProfileName": null,
  • "mediaRelayMinPort": 50000,
  • "mediaRelayMaxPort": 55000,
  • "authentication": {
    },
  • "fingerPrint": "Y",
  • "tcpRelay": "Y",
  • "udpRelay": "Y",
  • "dtls": "N",
  • "mediaLearning": "Y",
  • "alternateServer1": "1.1.1.1",
  • "alternateServer2": "1.1.1.1",
  • "alternateServer3": "1.1.1.1"
}

Get stun turn profile for given ID

Get stun turn profile for given ID

User must have the turn-stun-profile:read capability to perform this action.

path Parameters
profileId
required
integer >= 1

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "udpListenPort": 5060,
  • "tcpTlsListenPort": 1111,
  • "tlsServerProfileName": null,
  • "mediaRelayMinPort": 50000,
  • "mediaRelayMaxPort": 55000,
  • "authentication": {
    },
  • "fingerPrint": "Y",
  • "tcpRelay": "Y",
  • "udpRelay": "Y",
  • "dtls": "N",
  • "mediaLearning": "Y",
  • "alternateServer1": "1.1.1.1",
  • "alternateServer2": "1.1.1.1",
  • "alternateServer3": "1.1.1.1"
}

Delete the turn stun profile for given ID

Delete the turn stun profile for given ID

User must have the turn-stun-profile:delete capability to perform this action.

path Parameters
profileId
required
integer >= 1

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Turn Stun Relays

APIs for managing Traversal Using Relays around NAT (TURN) relays.

Add new turn stun relay data in SBCE

Add new turn stun relay data in SBCE

User must have the turn-stun-relay:create capability to perform this action.

Request Body schema: application/json
listenIpId
string <ipv4>
mediaRelayIpId
string <ipv4>
serviceFqdn
string <fqdn>

Responses

Request samples

Content type
application/json
{
  • "listenIpId": 1,
  • "mediaRelayIpId": 2,
  • "serviceFqdn": "test.com"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/turn-stun-relays/1",
  • "turnStunProfileId": 1,
  • "listenIpId": 1,
  • "mediaRelayIpId": 2,
  • "serviceFqdn": "test.com"
}

Get all turn stun relays

Get all turn stun relays

User must have the turn-stun-relay:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit turn stun relay data in SBCE

Edit turn stun relay data in SBCE

User must have the turn-stun-relay:update capability to perform this action.

path Parameters
relayId
required
integer >= 1

ID of the Turn Stun Relay

Request Body schema: application/json
turnStunProfileId
integer
listenIpId
string <ipv4>
mediaRelayIpId
string <ipv4>
serviceFqdn
string <fqdn>

Responses

Request samples

Content type
application/json
{
  • "turnStunProfileId": 1,
  • "listenIpId": 1,
  • "mediaRelayIpId": 2,
  • "serviceFqdn": "test.com"
}

Response samples

Content type
application/json
{
  • "turnStunProfileId": 1,
  • "listenIpId": 1,
  • "mediaRelayIpId": 2,
  • "serviceFqdn": "test.com"
}

Get turn stun relay service for given ID

Get turn stun relay service for given ID

User must have the turn-stun-relay:read capability to perform this action.

path Parameters
relayId
required
integer >= 1

ID of the Turn Stun Relay

Responses

Response samples

Content type
application/json
{
  • "turnStunProfileId": 1,
  • "listenIpId": 1,
  • "mediaRelayIpId": 2,
  • "serviceFqdn": "test.com"
}

Delete the turn stun relay service for given ID

Delete the turn stun relay service for given ID

User must have the turn-stun-relay:delete capability to perform this action.

path Parameters
relayId
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Load Monitoring Profiles

APIs for managing load monitoring profiles.

Add new load monitoring profile in SBCE

Add new load monitoring profile in SBCE

User must have the load-monitoring-profile:create capability to perform this action.

Request Body schema: application/json
loadBalancerType
string
Enum: "INTERNAL" "EXTERNAL"

Load Balancer Type

listenIpId
string

Listen IP

listenProtocol
string
Enum: "TCP" "TLS"

Transport type

listenTlsProfileId
integer

TLS profile if transport selected is TLS

serviceType
string
Enum: "TURN" "MEDIA TYPE"

Service type

Responses

Request samples

Content type
application/json
{
  • "loadBalancerType": "INTERNAL",
  • "listenIpId": 1,
  • "listenProtocol": "TCP",
  • "listenTlsProfileId": 0,
  • "serviceType": "TURN"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/load-monitoring-profiles/1",
  • "profileId": 1,
  • "loadBalancerType": "INTERNAL",
  • "listenIpId": 1,
  • "listenProtocol": "TCP",
  • "listenTlsProfileId": 0,
  • "serviceType": "TURN"
}

Get all load monitoring profiles

Get all load monitoring profiles

User must have the load-monitoring-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit existing load monitoring profile for given ID

Edit existing load monitoring profile for given ID

User must have the load-monitoring-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Request Body schema: application/json
profileId
integer <int64>

ID of the profile

loadBalancerType
string
Enum: "INTERNAL" "EXTERNAL"

Load Balancer Type

listenIpId
string

Listen IP

listenProtocol
string
Enum: "TCP" "TLS"

Transport type

listenTlsProfileId
integer

TLS profile if transport selected is TLS

serviceType
string
Enum: "TURN" "MEDIA TYPE"

Service type

Responses

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "loadBalancerType": "INTERNAL",
  • "listenIpId": 1,
  • "listenProtocol": "TCP",
  • "listenTlsProfileId": 0,
  • "serviceType": "TURN"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "loadBalancerType": "INTERNAL",
  • "listenIpId": 1,
  • "listenProtocol": "TCP",
  • "listenTlsProfileId": 0,
  • "serviceType": "TURN"
}

Get load monitoring profile for given ID

Get load monitoring profile for given ID

User must have the load-monitoring-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "loadBalancerType": "INTERNAL",
  • "listenIpId": 1,
  • "listenProtocol": "TCP",
  • "listenTlsProfileId": 0,
  • "serviceType": "TURN"
}

Delete load monitoring profile for given ID

Delete load monitoring profile for given ID

User must have the load-monitoring-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Routing Profiles

APIs for managing routing profiles.

Add new routing profile in SBCE

Add new routing profile in SBCE

User must have the routing-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string

Name for the profile

Array of objects (PostRoutingRule)

Responses

Request samples

Content type
application/json
{
  • "profileName": "sm-route",
  • "profileRules": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/routing-profiles/1",
  • "profileId": 1,
  • "profileName": "sm-route",
  • "profileRules": [
    ]
}

Get all routing profiles configured in SBCE

Get all routing profiles configured in SBCE

User must have the routing-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get routing profile details for given ID

Get routing profile for given ID

User must have the routing-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "sm-route",
  • "profileRules": [
    ]
}

Delete the routing profile for given ID

Delete routing profile for given ID

User must have the routing-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new routing rule in SBCE

Add new routing rule in SBCE

User must have the routing-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Request Body schema: application/json
priority
integer
uriGroupId
integer

ID of the URI Group to be used

timeOfDayId
integer
outgoingTransport
string
Enum: "TCP" "TLS" "UDP"
loadBalancing
string
Enum: "PRIORITY" "DNS_SRV" "LOAD_FACTOR" "WEIGHTED_ROUND_ROBIN" "ROUND_ROBIN"

Load balancing selection:

  • PRIORITY - Priority
  • DNS_SRV - DNS/SRV
  • ROUND_ROBIN - Round-Robin
  • LOAD_FACTOR - Load Factor
  • WEIGHTED_ROUND_ROBIN - Weighted Round-Robin
nextHopInDialog
boolean
Default: false
sniServerName
string
sniEnabled
boolean
Array of objects (BaseNextHopAddress)

Responses

Request samples

Content type
application/json
{
  • "priority": 0,
  • "uriGroupId": 1,
  • "timeOfDayId": 1,
  • "outgoingTransport": "TCP",
  • "loadBalancing": "PRIORITY",
  • "nextHopInDialog": true,
  • "sniServerName": "string",
  • "sniEnabled": true,
  • "nextHopAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/routing-profiles/1/routing-rules/1",
  • "ruleId": 1,
  • "nextHopAddresses": [
    ],
  • "priority": 0,
  • "uriGroupId": 1,
  • "timeOfDayId": 1,
  • "outgoingTransport": "TCP",
  • "loadBalancing": "PRIORITY",
  • "nextHopInDialog": true,
  • "sniServerName": "string",
  • "sniEnabled": true
}

Get all routing rules in a routing profile

Get all routing rules configured in a routing profile

User must have the routing-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit existing routing rule in routing profile

Edit existing routing rule in routing profile

User must have the routing-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

Request Body schema: application/json
ruleId
integer

ID of the rule generated by system

Array of objects (BaseNextHopAddress)
priority
integer
uriGroupId
integer

ID of the URI Group to be used

timeOfDayId
integer
outgoingTransport
string
Enum: "TCP" "TLS" "UDP"
loadBalancing
string
Enum: "PRIORITY" "DNS_SRV" "LOAD_FACTOR" "WEIGHTED_ROUND_ROBIN" "ROUND_ROBIN"

Load balancing selection:

  • PRIORITY - Priority
  • DNS_SRV - DNS/SRV
  • ROUND_ROBIN - Round-Robin
  • LOAD_FACTOR - Load Factor
  • WEIGHTED_ROUND_ROBIN - Weighted Round-Robin
nextHopInDialog
boolean
Default: false
sniServerName
string
sniEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "ruleId": 1,
  • "nextHopAddresses": [
    ],
  • "priority": 0,
  • "uriGroupId": 1,
  • "timeOfDayId": 1,
  • "outgoingTransport": "TCP",
  • "loadBalancing": "PRIORITY",
  • "nextHopInDialog": true,
  • "sniServerName": "string",
  • "sniEnabled": true
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "nextHopAddresses": [
    ],
  • "priority": 0,
  • "uriGroupId": 1,
  • "timeOfDayId": 1,
  • "outgoingTransport": "TCP",
  • "loadBalancing": "PRIORITY",
  • "nextHopInDialog": true,
  • "sniServerName": "string",
  • "sniEnabled": true
}

Get routing rule for given ID

Get routing rule for given ID

User must have the routing-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "nextHopAddresses": [
    ],
  • "priority": 0,
  • "uriGroupId": 1,
  • "timeOfDayId": 1,
  • "outgoingTransport": "TCP",
  • "loadBalancing": "PRIORITY",
  • "nextHopInDialog": true,
  • "sniServerName": "string",
  • "sniEnabled": true
}

Delete the routing rule for given ID

Delete routing rule for given ID

User must have the routing-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new next hop address in routing rule on SBCE

Add new next hop address in routing rule on SBCE

User must have the routing-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

Request Body schema: application/json
priority
integer

Required for load balancing

serverConfigAddressId
integer
nextHopIpAddress
string <ipv4>
port
integer
transport
string
Enum: "TCP" "UDP" "TLS"

Transport type of the next-hop address

Responses

Request samples

Content type
application/json
{
  • "priority": 1,
  • "serverConfigAddressId": 1,
  • "nextHopIpAddress": "192.168.5.4",
  • "port": 111,
  • "transport": "TCP"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/routing-profiles/1/routing-rules/1/next-hop-addresses/1",
  • "nextHopId": 1,
  • "priority": 1,
  • "serverConfigAddressId": 1,
  • "nextHopIpAddress": "192.168.5.4",
  • "port": 111,
  • "transport": "TCP"
}

Get all next hop addresses for a specific routing rule

Get all next hop addresses for a specific routing rule

User must have the routing-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit next hop address to existing routing rule in SBCE

Edit next hop address to existing routing rule in SBCE

User must have the routing-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

nextHopId
required
integer

ID of the next hop address

Request Body schema: application/json
nextHopId
integer <int64>
priority
integer

Required for load balancing

serverConfigAddressId
integer
nextHopIpAddress
string <ipv4>
port
integer
transport
string
Enum: "TCP" "UDP" "TLS"

Transport type of the next-hop address

Responses

Request samples

Content type
application/json
{
  • "nextHopId": 1,
  • "priority": 1,
  • "serverConfigAddressId": 1,
  • "nextHopIpAddress": "192.168.5.4",
  • "port": 111,
  • "transport": "TCP"
}

Response samples

Content type
application/json
{
  • "nextHopId": 1,
  • "priority": 1,
  • "serverConfigAddressId": 1,
  • "nextHopIpAddress": "192.168.5.4",
  • "port": 111,
  • "transport": "TCP"
}

Get next hop address for given ID

Get next hop address for given ID

User must have the routing-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

nextHopId
required
integer

ID of the next hop address

Responses

Response samples

Content type
application/json
{
  • "nextHopId": 1,
  • "priority": 1,
  • "serverConfigAddressId": 1,
  • "nextHopIpAddress": "192.168.5.4",
  • "port": 111,
  • "transport": "TCP"
}

Delete the next hop address of routing rule for given ID

Delete the next hop address of routing rule for given ID

User must have the routing-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

ruleId
required
integer

ID of the rule

nextHopId
required
integer

ID of the next hop address

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Recording Profiles

APIs for managing recording profiles.

List all recording profiles

Retrieve a list of all configured recording profiles for this system.

User must have the recording-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new recording profile

Create a new recording profile for this system.

User must have the recording-profile:create capability to perform this action.

Request Body schema: application/json
recordingTerminationOnCallFailure
boolean

Terminate the call if recording can not be set up.

playRecordingTone
boolean

Play a tone if the call is being recorded.

Array of objects (RecordingProfileRouteMapping)

Apply a recording rule to a specific route.

Responses

Request samples

Content type
application/json
{
  • "recordingTerminationOnCallFailure": false,
  • "playRecordingTone": false,
  • "routeMappings": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "profileId": 0,
  • "recordingTerminationOnCallFailure": false,
  • "playRecordingTone": false,
  • "routeMappings": [
    ]
}

Get a recording profile

Retrieve an existing recording profile from this system.

User must have the recording-profile:read capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "profileId": 0,
  • "recordingTerminationOnCallFailure": false,
  • "playRecordingTone": false,
  • "routeMappings": [
    ]
}

Modify an existing recording profile

Modify an existing recording profile for this system. All fields are optional and any omitted field will use the value from the existing profile.

User must have the recording-profile:update capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
recordingTerminationOnCallFailure
boolean

Terminate the call if recording can not be set up.

playRecordingTone
boolean

Play a tone if the call is being recorded.

Responses

Request samples

Content type
application/json
{
  • "recordingTerminationOnCallFailure": false,
  • "playRecordingTone": false
}

Response samples

Content type
application/json
{
  • "profileId": 0,
  • "recordingTerminationOnCallFailure": false,
  • "playRecordingTone": false,
  • "routeMappings": [
    ]
}

Delete an existing recording profile

Delete an existing recording profile from this system.

User must have the recording-profile:delete capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create a route mapping on an existing recording profile

Create a route mapping on an existing recording profile on this system.

User must have the recording-profile:create capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
mappingId
integer

ID for the route mapping. This value will not be read during recording profile creation and will only be returned on a response.

routingProfileId
integer

The routing policy use for this mapping.

recordingType
string
Enum: "FULL_TIME" "SELECTIVE"

The type of the recording.

videoRecording
boolean

Responses

Request samples

Content type
application/json
{
  • "mappingId": 0,
  • "routingProfileId": 0,
  • "recordingType": "FULL_TIME",
  • "videoRecording": false
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "mappingId": 0,
  • "routingProfileId": 0,
  • "recordingType": "FULL_TIME",
  • "videoRecording": false
}

Update a route mapping on an existing recording profile

Update a route mapping on an existing recording profile on this system.

User must have the recording-profile:update capability to perform this action.

path Parameters
id
required
integer
mappingId
required
integer
Request Body schema: application/json
mappingId
integer

ID for the route mapping. This value will not be read during recording profile creation and will only be returned on a response.

routingProfileId
integer

The routing policy use for this mapping.

recordingType
string
Enum: "FULL_TIME" "SELECTIVE"

The type of the recording.

videoRecording
boolean

Responses

Request samples

Content type
application/json
{
  • "mappingId": 0,
  • "routingProfileId": 0,
  • "recordingType": "FULL_TIME",
  • "videoRecording": false
}

Response samples

Content type
application/json
{
  • "mappingId": 0,
  • "routingProfileId": 0,
  • "recordingType": "FULL_TIME",
  • "videoRecording": false
}

Remove a route mapping on an existing recording profile

Remove a route mapping from an existing recording profile on this system.

User must have the recording-profile:delete capability to perform this action.

path Parameters
id
required
integer
mappingId
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Endpoint Policy Groups

APIs for managing endpoint policy groups.

Add new endpoint policy group flow in SBCE

Add new endpoint policy group flow in SBCE

User must have the endpoint-policy-group:create capability to perform this action.

Request Body schema: application/json
policyName
string
applicationRuleId
integer
Default: 1

ID for the application rule associated with this policy group.

Defaults to the built-in "default" application rule.

mediaRuleId
integer
Default: 1

ID for the media rule associated with this policy group.

Defaults to the built-in "default-low-med" media rule.

signalingRuleId
integer
Default: 1

ID for the signaling rule associated with this policy group.

Defaults to the built-in "default" signaling rule.

securityRuleId
integer
Default: 1

ID for the security rule associated with this policy group.

Defaults to the built-in "default-low" security rule.

chargingPolicyId
integer
Default: -1

ID for the charging policy associated with this policy group.

Use -1 or omit to use no charging policy for this policy group.

rtcpMonitoringGeneration
string
Default: "OFF"
Enum: "OFF" "RTP" "RTP_WITH_RTCP"

Specifies the method of generating RTCP monitoring report for a specific policy group. The options are:

  • OFF: Does not generate the RTCP monitoring report for the endpoint policy group.
  • RTP: In absence of RTCP, generates the RTCP monitoring report based on received RTP packets.
  • RTP_WITH_RTCP: Generates the RTCP monitoring report based on the received RTCP packets on a SIP trunk.

Responses

Request samples

Content type
application/json
{
  • "policyName": "test",
  • "applicationRuleId": 1,
  • "mediaRuleId": 1,
  • "signalingRuleId": 2,
  • "securityRuleId": 3,
  • "chargingPolicyId": 4,
  • "rtcpMonitoringGeneration": "OFF"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/endpoint-policy-groups/1",
  • "policyId": 1,
  • "policyName": "test",
  • "applicationRuleId": 1,
  • "mediaRuleId": 1,
  • "signalingRuleId": 2,
  • "securityRuleId": 3,
  • "chargingPolicyId": 4,
  • "rtcpMonitoringGeneration": "OFF"
}

Get all endpoint group policies

Get all endpoint group policies

User must have the endpoint-policy-group:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit endpoint policy group flow in SBCE

Edit endpoint policy group flow in SBCE

User must have the endpoint-policy-group:update capability to perform this action.

path Parameters
policyId
required
integer

ID of the policy

Request Body schema: application/json
policyId
integer
policyName
string
applicationRuleId
integer
Default: 1

ID for the application rule associated with this policy group.

Defaults to the built-in "default" application rule.

mediaRuleId
integer
Default: 1

ID for the media rule associated with this policy group.

Defaults to the built-in "default-low-med" media rule.

signalingRuleId
integer
Default: 1

ID for the signaling rule associated with this policy group.

Defaults to the built-in "default" signaling rule.

securityRuleId
integer
Default: 1

ID for the security rule associated with this policy group.

Defaults to the built-in "default-low" security rule.

chargingPolicyId
integer
Default: -1

ID for the charging policy associated with this policy group.

Use -1 or omit to use no charging policy for this policy group.

rtcpMonitoringGeneration
string
Default: "OFF"
Enum: "OFF" "RTP" "RTP_WITH_RTCP"

Specifies the method of generating RTCP monitoring report for a specific policy group. The options are:

  • OFF: Does not generate the RTCP monitoring report for the endpoint policy group.
  • RTP: In absence of RTCP, generates the RTCP monitoring report based on received RTP packets.
  • RTP_WITH_RTCP: Generates the RTCP monitoring report based on the received RTCP packets on a SIP trunk.

Responses

Request samples

Content type
application/json
{
  • "policyId": 1,
  • "policyName": "test",
  • "applicationRuleId": 1,
  • "mediaRuleId": 1,
  • "signalingRuleId": 2,
  • "securityRuleId": 3,
  • "chargingPolicyId": 4,
  • "rtcpMonitoringGeneration": "OFF"
}

Response samples

Content type
application/json
{
  • "policyId": 1,
  • "policyName": "test",
  • "applicationRuleId": 1,
  • "mediaRuleId": 1,
  • "signalingRuleId": 2,
  • "securityRuleId": 3,
  • "chargingPolicyId": 4,
  • "rtcpMonitoringGeneration": "OFF"
}

Get the endpoint policy group details for given ID

Get the endpoint policy group details for given ID

User must have the endpoint-policy-group:read capability to perform this action.

path Parameters
policyId
required
integer

ID of the policy

Responses

Response samples

Content type
application/json
{
  • "policyId": 1,
  • "policyName": "test",
  • "applicationRuleId": 1,
  • "mediaRuleId": 1,
  • "signalingRuleId": 2,
  • "securityRuleId": 3,
  • "chargingPolicyId": 4,
  • "rtcpMonitoringGeneration": "OFF"
}

Delete the endpoint group policy for given ID

Delete the endpoint group policy for given ID

User must have the endpoint-policy-group:delete capability to perform this action.

path Parameters
policyId
required
integer

ID of the policy

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Application Rules

APIs for managing application rules.

Add new application rule in SBCE

Add new application rule in SBCE

User must have the application-rule:create capability to perform this action.

Request Body schema: application/json
ruleName
string
videoIn
boolean
Default: false

Denote this rule applies to video traffic entering the enterprise network.

videoOut
boolean
Default: false

Denote this rule applies to video traffic originating from within the enterprise network.

maxVideoSessionsPerEndpoint
integer
Default: null

The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded.

maxVideoConcurrentSessions
integer
Default: null

The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded.

audioIn
boolean
Default: false

Denote this rule applies to audio traffic entering the enterprise network.

audioOut
boolean
Default: false

Denote this rule applies to audio traffic originating from within the enterprise network.

maxAudioSessionPerEndpoint
integer
Default: null

The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded.

maxAudioConcurrentSessions
integer
Default: null

The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded.

radiusProfileId
integer
Default: null
cdrSupport
string
Default: "NONE"
Enum: "NONE" "RADIUS" "CDR_ADJUNCT"

CDR option type applicable for the application rule.

  • Off: Call detail records are not provided.
  • RADIUS: Call detail records are sent to the Radius server.
  • CDR_ADJUNCT: Call detail records are sent to the CDR Adjunct configured.
callDuration
string
Default: null
Enum: "SETUP" "CONNECT"

The options for call duration are:

  • SETUP: Stores data in the CDR file from the time Avaya SBCE sends an INVITE for connecting the call.
  • CONNECT: Stores data in the CDR file from the time Avaya SBCE receives a 200 OK message for connecting the call.
mediaStatisticsReport
boolean
Default: false

If true, the CDR file contains data about media statistics.

rtcpKeepAlive
boolean
Default: false

If true, RTCP Keep-Alive feature is enabled.

Responses

Request samples

Content type
application/json
{
  • "ruleName": "test",
  • "videoIn": true,
  • "videoOut": false,
  • "maxVideoSessionsPerEndpoint": 1,
  • "maxVideoConcurrentSessions": 1,
  • "audioIn": true,
  • "audioOut": false,
  • "maxAudioSessionPerEndpoint": 1,
  • "maxAudioConcurrentSessions": 1,
  • "radiusProfileId": 1,
  • "cdrSupport": "CDR_ADJUNCT",
  • "callDuration": "SETUP",
  • "mediaStatisticsReport": true,
  • "rtcpKeepAlive": false
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/application-rules/1",
  • "ruleId": 1,
  • "ruleName": "test",
  • "videoIn": true,
  • "videoOut": false,
  • "maxVideoSessionsPerEndpoint": 1,
  • "maxVideoConcurrentSessions": 1,
  • "audioIn": true,
  • "audioOut": false,
  • "maxAudioSessionPerEndpoint": 1,
  • "maxAudioConcurrentSessions": 1,
  • "radiusProfileId": 1,
  • "cdrSupport": "CDR_ADJUNCT",
  • "callDuration": "SETUP",
  • "mediaStatisticsReport": true,
  • "rtcpKeepAlive": false
}

Get all application rules

Get all application rules

User must have the application-rule:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit application rule in SBCE

Edit application rule in SBCE

User must have the application-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the rule

Request Body schema: application/json
ruleId
integer
ruleName
string
videoIn
boolean
Default: false

Denote this rule applies to video traffic entering the enterprise network.

videoOut
boolean
Default: false

Denote this rule applies to video traffic originating from within the enterprise network.

maxVideoSessionsPerEndpoint
integer
Default: null

The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded.

maxVideoConcurrentSessions
integer
Default: null

The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded.

audioIn
boolean
Default: false

Denote this rule applies to audio traffic entering the enterprise network.

audioOut
boolean
Default: false

Denote this rule applies to audio traffic originating from within the enterprise network.

maxAudioSessionPerEndpoint
integer
Default: null

The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded.

maxAudioConcurrentSessions
integer
Default: null

The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded.

radiusProfileId
integer
Default: null
cdrSupport
string
Default: "NONE"
Enum: "NONE" "RADIUS" "CDR_ADJUNCT"

CDR option type applicable for the application rule.

  • Off: Call detail records are not provided.
  • RADIUS: Call detail records are sent to the Radius server.
  • CDR_ADJUNCT: Call detail records are sent to the CDR Adjunct configured.
callDuration
string
Default: null
Enum: "SETUP" "CONNECT"

The options for call duration are:

  • SETUP: Stores data in the CDR file from the time Avaya SBCE sends an INVITE for connecting the call.
  • CONNECT: Stores data in the CDR file from the time Avaya SBCE receives a 200 OK message for connecting the call.
mediaStatisticsReport
boolean
Default: false

If true, the CDR file contains data about media statistics.

rtcpKeepAlive
boolean
Default: false

If true, RTCP Keep-Alive feature is enabled.

Responses

Request samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "test",
  • "videoIn": true,
  • "videoOut": false,
  • "maxVideoSessionsPerEndpoint": 1,
  • "maxVideoConcurrentSessions": 1,
  • "audioIn": true,
  • "audioOut": false,
  • "maxAudioSessionPerEndpoint": 1,
  • "maxAudioConcurrentSessions": 1,
  • "radiusProfileId": 1,
  • "cdrSupport": "CDR_ADJUNCT",
  • "callDuration": "SETUP",
  • "mediaStatisticsReport": true,
  • "rtcpKeepAlive": false
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "test",
  • "videoIn": true,
  • "videoOut": false,
  • "maxVideoSessionsPerEndpoint": 1,
  • "maxVideoConcurrentSessions": 1,
  • "audioIn": true,
  • "audioOut": false,
  • "maxAudioSessionPerEndpoint": 1,
  • "maxAudioConcurrentSessions": 1,
  • "radiusProfileId": 1,
  • "cdrSupport": "CDR_ADJUNCT",
  • "callDuration": "SETUP",
  • "mediaStatisticsReport": true,
  • "rtcpKeepAlive": false
}

Get the application rule for given ID

Get the application rule for given ID

User must have the application-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "test",
  • "videoIn": true,
  • "videoOut": false,
  • "maxVideoSessionsPerEndpoint": 1,
  • "maxVideoConcurrentSessions": 1,
  • "audioIn": true,
  • "audioOut": false,
  • "maxAudioSessionPerEndpoint": 1,
  • "maxAudioConcurrentSessions": 1,
  • "radiusProfileId": 1,
  • "cdrSupport": "CDR_ADJUNCT",
  • "callDuration": "SETUP",
  • "mediaStatisticsReport": true,
  • "rtcpKeepAlive": false
}

Delete the application rule for given ID

Delete the application rule for given ID

User must have the application-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Session Policies

APIs for managing session policies.

Add new session policy in SBCE

Add new session policy in SBCE

User must have the session-policy:create capability to perform this action.

Request Body schema: application/json
policyName
string
mediaAnchoringEnabled
boolean
mediaForkingProfileId
integer
callTypeMediaAnchoring
string
Enum: "ALL" "TROMBONE_ONLY"
recordingServerEnabled
boolean
recordingServerId
integer
optimizeHairpinCalls
boolean
convergedConferencingEnabled
boolean
mediaServerEnabled
boolean
mediaRoutingProfileId
integer
urnEnabled
boolean
urnProfileId
integer

Responses

Request samples

Content type
application/json
{
  • "policyName": "test",
  • "mediaAnchoringEnabled": true,
  • "mediaForkingProfileId": 1,
  • "callTypeMediaAnchoring": false,
  • "recordingServerEnabled": false,
  • "recordingServerId": 1,
  • "optimizeHairpinCalls": true,
  • "convergedConferencingEnabled": false,
  • "mediaServerEnabled": true,
  • "mediaRoutingProfileId": 1,
  • "urnEnabled": true,
  • "urnProfileId": 1
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/session-policies/1",
  • "policyId": 1,
  • "policyName": "test",
  • "mediaAnchoringEnabled": true,
  • "mediaForkingProfileId": 1,
  • "callTypeMediaAnchoring": false,
  • "recordingServerEnabled": false,
  • "recordingServerId": 1,
  • "optimizeHairpinCalls": true,
  • "convergedConferencingEnabled": false,
  • "mediaServerEnabled": true,
  • "mediaRoutingProfileId": 1,
  • "urnEnabled": true,
  • "urnProfileId": 1
}

Get all session policies

Get all session policies

User must have the session-policy:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit session policy in SBCE

Edit session policy in SBCE

User must have the session-policy:update capability to perform this action.

path Parameters
policyId
required
integer

ID of the policy

Request Body schema: application/json
policyId
integer
policyName
string
mediaAnchoringEnabled
boolean
mediaForkingProfileId
integer
callTypeMediaAnchoring
string
Enum: "ALL" "TROMBONE_ONLY"
recordingServerEnabled
boolean
recordingServerId
integer
optimizeHairpinCalls
boolean
convergedConferencingEnabled
boolean
mediaServerEnabled
boolean
mediaRoutingProfileId
integer
urnEnabled
boolean
urnProfileId
integer

Responses

Request samples

Content type
application/json
{
  • "policyId": 1,
  • "policyName": "test",
  • "mediaAnchoringEnabled": true,
  • "mediaForkingProfileId": 1,
  • "callTypeMediaAnchoring": false,
  • "recordingServerEnabled": false,
  • "recordingServerId": 1,
  • "optimizeHairpinCalls": true,
  • "convergedConferencingEnabled": false,
  • "mediaServerEnabled": true,
  • "mediaRoutingProfileId": 1,
  • "urnEnabled": true,
  • "urnProfileId": 1
}

Response samples

Content type
application/json
{
  • "policyId": 1,
  • "policyName": "test",
  • "mediaAnchoringEnabled": true,
  • "mediaForkingProfileId": 1,
  • "callTypeMediaAnchoring": false,
  • "recordingServerEnabled": false,
  • "recordingServerId": 1,
  • "optimizeHairpinCalls": true,
  • "convergedConferencingEnabled": false,
  • "mediaServerEnabled": true,
  • "mediaRoutingProfileId": 1,
  • "urnEnabled": true,
  • "urnProfileId": 1
}

Get the session policy for given ID

Get the session policy for given ID

User must have the session-policy:read capability to perform this action.

path Parameters
policyId
required
integer

ID of the policy

Responses

Response samples

Content type
application/json
{
  • "policyId": 1,
  • "policyName": "test",
  • "mediaAnchoringEnabled": true,
  • "mediaForkingProfileId": 1,
  • "callTypeMediaAnchoring": false,
  • "recordingServerEnabled": false,
  • "recordingServerId": 1,
  • "optimizeHairpinCalls": true,
  • "convergedConferencingEnabled": false,
  • "mediaServerEnabled": true,
  • "mediaRoutingProfileId": 1,
  • "urnEnabled": true,
  • "urnProfileId": 1
}

Delete the session policy for given ID

Delete the session policy for given ID

User must have the session-policy:delete capability to perform this action.

path Parameters
policyId
required
integer

ID of the policy

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Session Flows

APIs for managing session flows.

Add new session flow in SBCE

Add new session flow in SBCE

User must have the session-flow:create capability to perform this action.

Request Body schema: application/json
flowName
string
fromUriGroupId
integer
toUriGroupId
integer
signalingSourceIpSubnet
string
signalingDestinationIpSubnet
string
sessionPolicyId
integer
sourceSignalingIpId
integer
destinationSignalingIpId
integer
hasRemoteSbc
boolean

Responses

Request samples

Content type
application/json
{
  • "flowName": "test",
  • "fromUriGroupId": 1,
  • "toUriGroupId": 1,
  • "signalingSourceIpSubnet": "*",
  • "signalingDestinationIpSubnet": "*",
  • "sessionPolicyId": 1,
  • "sourceSignalingIpId": 1,
  • "destinationSignalingIpId": 1,
  • "hasRemoteSbc": false
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/session-flows/1",
  • "flowId": 1,
  • "flowName": "test",
  • "fromUriGroupId": 1,
  • "toUriGroupId": 1,
  • "signalingSourceIpSubnet": "*",
  • "signalingDestinationIpSubnet": "*",
  • "sessionPolicyId": 1,
  • "sourceSignalingIpId": 1,
  • "destinationSignalingIpId": 1,
  • "hasRemoteSbc": false
}

Get all session flows

Get all session flows

User must have the session-flow:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit session flow in SBCE

Edit session flow in SBCE

User must have the session-flow:update capability to perform this action.

path Parameters
flowId
required
integer

ID of the flow

Request Body schema: application/json
flowId
integer <int64>

The new priority to update. This value can be negative priority. that means that the priority value -1 will be the least priority, and -2 will be the second least priority. The negative priority starts from where the priorities ends. This means that the last priority of the session flows is the first element in the negative indexing which is -1.

For Example, if there are 5 session flows and the least priority is 5, then -1 priority indicates priority 5 and -5 indicates priority 1.

flowName
string
fromUriGroupId
integer
toUriGroupId
integer
signalingSourceIpSubnet
string
signalingDestinationIpSubnet
string
sessionPolicyId
integer
sourceSignalingIpId
integer
destinationSignalingIpId
integer
hasRemoteSbc
boolean

Responses

Request samples

Content type
application/json
{
  • "flowId": 1,
  • "flowName": "test",
  • "fromUriGroupId": 1,
  • "toUriGroupId": 1,
  • "signalingSourceIpSubnet": "*",
  • "signalingDestinationIpSubnet": "*",
  • "sessionPolicyId": 1,
  • "sourceSignalingIpId": 1,
  • "destinationSignalingIpId": 1,
  • "hasRemoteSbc": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the session flow for given ID

Get the session flow for given ID

User must have the session-flow:read capability to perform this action.

path Parameters
flowId
required
integer

ID of the flow

Responses

Response samples

Content type
application/json
{
  • "flowId": 1,
  • "flowName": "test",
  • "fromUriGroupId": 1,
  • "toUriGroupId": 1,
  • "signalingSourceIpSubnet": "*",
  • "signalingDestinationIpSubnet": "*",
  • "sessionPolicyId": 1,
  • "sourceSignalingIpId": 1,
  • "destinationSignalingIpId": 1,
  • "hasRemoteSbc": false
}

Delete the session flow for given ID

Delete the session flow for given ID

User must have the session-flow:delete capability to perform this action.

path Parameters
flowId
required
integer

ID of the flow

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

CDR Servers

APIs for managing Call-Detail Record (CDR) servers.

Add or Edit CDR server in SBCE

Add or Edit CDR server in SBCE

User must have the cdr-server:create capability to perform this action.

Request Body schema: application/json
address
string <address:port>
username
string
password
string
location
string

The location path where CDRs will be copied on the server.

timeIntervalInHours
integer

Time interval to send CDR to server in 24hr format.

Responses

Request samples

Content type
application/json
{
  • "address": "1.1.1.1:111",
  • "username": "test",
  • "password": "SIPera_123",
  • "location": "/home",
  • "timeIntervalInHours": 1
}

Response samples

Content type
application/json
{
  • "address": "1.1.1.1:111",
  • "username": "test",
  • "password": "SIPera_123",
  • "location": "/home",
  • "timeIntervalInHours": 1
}

Get CDR server details

Get CDR server details

User must have the cdr-server:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "address": "1.1.1.1:111",
  • "username": "test",
  • "password": "SIPera_123",
  • "location": "/home",
  • "timeIntervalInHours": 1
}

Delete the CDR server

Delete the CDR server

User must have the cdr-server:delete capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

RADIUS Profiles

APIs for managing Remote Authentication Dial-In User Service (RADIUS) profiles.

Add new radius profile in SBCE

Adds new radius profile in SBCE.

User must have the radius-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string
serverAddress
string <ip>
serverPort
integer <port>
alternateServerAddress
string <ip>
alternateServerPort
integer <port>
sharedSecret
string
maxRetry
integer
retryTimeoutInSeconds
integer
connectPort
integer <port>
healthCheckIntervalInSeconds
integer

Responses

Request samples

Content type
application/json
{
  • "profileName": "radius-profile-1",
  • "serverAddress": "1.1.1.1",
  • "serverPort": 22,
  • "alternateServerAddress": "2.2.2.2",
  • "alternateServerPort": 44,
  • "sharedSecret": "SIPera_123",
  • "maxRetry": 5,
  • "retryTimeoutInSeconds": 44,
  • "connectPort": 34,
  • "healthCheckIntervalInSeconds": 5
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/radius-profiles/1",
  • "profileId": 1,
  • "profileName": "radius-profile-1",
  • "serverAddress": "1.1.1.1",
  • "serverPort": 22,
  • "alternateServerAddress": "2.2.2.2",
  • "alternateServerPort": 44,
  • "sharedSecret": "SIPera_123",
  • "maxRetry": 5,
  • "retryTimeoutInSeconds": 44,
  • "connectPort": 34,
  • "healthCheckIntervalInSeconds": 5
}

Get all radius profiles configured in SBCE

Retrieve all radius profiles configured in SBCE.

User must have the radius-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit radius profile by profileId in SBCE

Edit radius profile for given profileId in SBCE.

User must have the radius-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Request Body schema: application/json
profileName
string
serverAddress
string <ip>
serverPort
integer <port>
alternateServerAddress
string <ip>
alternateServerPort
integer <port>
sharedSecret
string
maxRetry
integer
retryTimeoutInSeconds
integer
connectPort
integer <port>
healthCheckIntervalInSeconds
integer

Responses

Request samples

Content type
application/json
{
  • "profileName": "radius-profile-1",
  • "serverAddress": "1.1.1.1",
  • "serverPort": 22,
  • "alternateServerAddress": "2.2.2.2",
  • "alternateServerPort": 44,
  • "sharedSecret": "SIPera_123",
  • "maxRetry": 5,
  • "retryTimeoutInSeconds": 44,
  • "connectPort": 34,
  • "healthCheckIntervalInSeconds": 5
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "radius-profile-1",
  • "serverAddress": "1.1.1.1",
  • "serverPort": 22,
  • "alternateServerAddress": "2.2.2.2",
  • "alternateServerPort": 44,
  • "sharedSecret": "SIPera_123",
  • "maxRetry": 5,
  • "retryTimeoutInSeconds": 44,
  • "connectPort": 34,
  • "healthCheckIntervalInSeconds": 5
}

Get radius profile by profileId configured in SBCE

Get radius profile by profileId configured in SBCE.

User must have the radius-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "radius-profile-1",
  • "serverAddress": "1.1.1.1",
  • "serverPort": 22,
  • "alternateServerAddress": "2.2.2.2",
  • "alternateServerPort": 44,
  • "sharedSecret": "SIPera_123",
  • "maxRetry": 5,
  • "retryTimeoutInSeconds": 44,
  • "connectPort": 34,
  • "healthCheckIntervalInSeconds": 5
}

Delete radius profile by profileId in SBCE

Delete radius profile by profileId in SBCE

User must have the radius-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

URN Profiles

APIs for managing Uniform Resource Name (URN) profiles.

Add new URN profiles in SBCE

Adds new URN profile in SBCE.

User must have the urn-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string
Array of objects (PostURNMapping)

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "urnConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/urn-profiles/1",
  • "profileId": 1,
  • "profileName": "test",
  • "urnConfigs": [
    ]
}

Get all URN profiles

Retrieve all URN profiles configured in SBCE.

User must have the urn-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the URN profile for given ID

Get URN profile by profileId configured in SBCE.

User must have the urn-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "urnConfigs": [
    ]
}

Delete the URN profile for given ID

Delete URN profile by profileId in SBCE

User must have the urn-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new URN mapping in SBCE

Adds new URN mapping in SBCE.

User must have the urn-profile:create capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Request Body schema: application/json
urnMap
string
urnDialDigitString
string

Responses

Request samples

Content type
application/json
{
  • "urnMap": "urn:nena:service:sos.ambulance",
  • "urnDialDigitString": "1234"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "urnConfigs": [
    ]
}

Edit the URN mapping for given config ID

Edit URN mapping in SBCE.

User must have the urn-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

configId
required
integer

ID of the mapping

Request Body schema: application/json
configId
integer
urnMap
string
urnDialDigitString
string

Responses

Request samples

Content type
application/json
{
  • "configId": 1,
  • "urnMap": "urn:nena:service:sos.ambulance",
  • "urnDialDigitString": "1234"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "urnConfigs": [
    ]
}

Delete the URN mapping for given ID

Delete URN mapping by configId in SBCE

User must have the urn-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

configId
required
integer

ID of the mapping

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

URI Groups

APIs for managing Uniform Resource Identifier (URI) groups.

Add new URI group in SBCE

Adds new URI group in SBCE.

User must have the uri-group:create capability to perform this action.

Request Body schema: application/json
groupName
string
Array of objects (URIMember)

Responses

Request samples

Content type
application/json
{
  • "groupName": "test",
  • "userMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/uri-groups/1",
  • "groupId": 1,
  • "groupName": "test",
  • "userMembers": [
    ]
}

Get all URI groups

Retrieve all URI groups configured in SBCE.

User must have the uri-group:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the URI groups for given ID

Get URI group by groupId configured in SBCE.

User must have the uri-group:read capability to perform this action.

path Parameters
groupId
required
integer

ID of the group

Responses

Response samples

Content type
application/json
{
  • "groupId": 1,
  • "groupName": "test",
  • "userMembers": [
    ]
}

Delete the URI group for given ID

Delete URI group by groupId in SBCE

User must have the uri-group:delete capability to perform this action.

path Parameters
groupId
required
integer

ID of the group

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new URI member in SBCE

Adds new URI member in SBCE.

User must have the uri-group:create capability to perform this action.

path Parameters
groupId
required
integer

ID of the group

Request Body schema: application/json
scheme
string
Enum: "ANY" "SIP" "TEL"
type
string
Enum: "PLAIN" "DIAL_PLAN" "REGULAR_EXPRESSION"
uri
string

Responses

Request samples

Content type
application/json
{
  • "scheme": "SIP",
  • "type": "REGULAR_EXPRESSION",
  • "uri": "*"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/uri-groups/1",
  • "groupId": 1,
  • "groupName": "test",
  • "userMembers": [
    ]
}

Edit the URI member for given group ID

Edit URI member in SBCE.

User must have the uri-group:update capability to perform this action.

path Parameters
groupId
required
integer

ID of the group

memberName
required
string

Name of the URI member. Encode with Base 64 if the value have the unsupported url characters and pass the query parameters base64 as true

query Parameters
base64
boolean
Default: false

This query parameter is required when the memberName value is encoded in Base64 format.

Request Body schema: application/json
scheme
string
Enum: "ANY" "SIP" "TEL"
type
string
Enum: "PLAIN" "DIAL_PLAN" "REGULAR_EXPRESSION"
uri
string

Responses

Request samples

Content type
application/json
{
  • "scheme": "SIP",
  • "type": "REGULAR_EXPRESSION",
  • "uri": "*"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/uri-groups/1",
  • "groupId": 1,
  • "groupName": "test",
  • "userMembers": [
    ]
}

Delete the URI member for given ID

Delete URI member by memberName in SBCE

User must have the uri-group:delete capability to perform this action.

path Parameters
groupId
required
integer

ID of the group

memberName
required
string

Name of the URI member. Encode with Base 64 if the value have the unsupported url characters and pass the query parameters base64 as true

query Parameters
base64
boolean
Default: false

This query parameter is required when the memberName is encoded in Base64 format.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

LDAP Servers

APIs for managing Lightweight Directory Access Protocol (LDAP) servers

Add new LDAP Server in SBCE

Adds new LDAP Server in SBCE.

User must have the ldap-server:create capability to perform this action.

Request Body schema: application/json
profileName
string
primaryAddress
string <fqdn>
primaryPort
integer <port>
secondaryAddress
string <fqdn>
secondaryPort
integer <port>
object (SecureLdap)
bindDn
string
bindPassphrase
string
baseDnList
string
timeoutInSeconds
integer
object (Caching)

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "primaryAddress": "1.1.1.1",
  • "primaryPort": 1134,
  • "secondaryAddress": "1.1.1.1",
  • "secondaryPort": 1134,
  • "secureLdap": {
    },
  • "bindDn": "dc=mydomain",
  • "bindPassphrase": "qwerty",
  • "baseDnList": [
    ],
  • "timeoutInSeconds": 10,
  • "caching": {
    }
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/ldap-servers/1",
  • "profileId": 1,
  • "profileName": "test",
  • "primaryAddress": "1.1.1.1",
  • "primaryPort": 1134,
  • "secondaryAddress": "1.1.1.1",
  • "secondaryPort": 1134,
  • "secureLdap": {
    },
  • "bindDn": "dc=mydomain",
  • "bindPassphrase": "qwerty",
  • "baseDnList": [
    ],
  • "timeoutInSeconds": 10,
  • "caching": {
    }
}

Get all LDAP servers

Get all LDAP Servers configured in SBCE.

User must have the ldap-server:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit LDAP server in SBCE

Modify an existing LDAP Server for this system.

User must have the ldap-server:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the server

Request Body schema: application/json
profileName
string
primaryAddress
string <fqdn>
primaryPort
integer <port>
secondaryAddress
string <fqdn>
secondaryPort
integer <port>
object (SecureLdap)
bindDn
string
bindPassphrase
string
baseDnList
string
timeoutInSeconds
integer
object (Caching)

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "primaryAddress": "1.1.1.1",
  • "primaryPort": 1134,
  • "secondaryAddress": "1.1.1.1",
  • "secondaryPort": 1134,
  • "secureLdap": {
    },
  • "bindDn": "dc=mydomain",
  • "bindPassphrase": "qwerty",
  • "baseDnList": [
    ],
  • "timeoutInSeconds": 10,
  • "caching": {
    }
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "primaryAddress": "1.1.1.1",
  • "primaryPort": 1134,
  • "secondaryAddress": "1.1.1.1",
  • "secondaryPort": 1134,
  • "secureLdap": {
    },
  • "bindDn": "dc=mydomain",
  • "bindPassphrase": "qwerty",
  • "baseDnList": [
    ],
  • "timeoutInSeconds": 10,
  • "caching": {
    }
}

Get the LDAP Server for given ID

Get LDAP Server by profileId configured in SBCE.

User must have the ldap-server:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the server

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "primaryAddress": "1.1.1.1",
  • "primaryPort": 1134,
  • "secondaryAddress": "1.1.1.1",
  • "secondaryPort": 1134,
  • "secureLdap": {
    },
  • "bindDn": "dc=mydomain",
  • "bindPassphrase": "qwerty",
  • "baseDnList": [
    ],
  • "timeoutInSeconds": 10,
  • "caching": {
    }
}

Delete the LDAP server for given ID

Delete LDAP Server by profileId in SBCE

User must have the ldap-server:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

User Agents

APIs for managing user agents.

Add new user agent in SBCE

Adds new User agent in SBCE.

User must have the user-agent:create capability to perform this action.

Request Body schema: application/json
agentName
string
userAgentRegex
string

Responses

Request samples

Content type
application/json
{
  • "agentName": "test",
  • "userAgentRegex": "*"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/user-agents/1",
  • "agentId": 1,
  • "agentName": "test",
  • "userAgentRegex": "*"
}

Get All User Agents

Get all user agents configured in SBCE.

User must have the user-agent:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit User Agent in SBCE

Modify an existing user agent for this system.

User must have the user-agent:update capability to perform this action.

path Parameters
agentId
required
integer

ID of the user agent

Request Body schema: application/json
agentName
string
userAgentRegex
string

Responses

Request samples

Content type
application/json
{
  • "agentName": "test",
  • "userAgentRegex": "*"
}

Response samples

Content type
application/json
{
  • "agentId": 1,
  • "agentName": "test",
  • "userAgentRegex": "*"
}

Get the User Agent for given ID

Get User agent by profileId configured in SBCE.

User must have the user-agent:read capability to perform this action.

path Parameters
agentId
required
integer

ID of the user agent

Responses

Response samples

Content type
application/json
{
  • "agentId": 1,
  • "agentName": "test",
  • "userAgentRegex": "*"
}

Delete the user agent for given ID

Delete User agent by profileId in SBCE

User must have the user-agent:delete capability to perform this action.

path Parameters
agentId
required
integer

ID of the user agent

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

FGDN Groups

APIs for managing Failover Group Domain Name (FGDN) groups.

Add new FGDN Group in SBCE

Adds new FGDN Groups in SBCE.

User must have the fgdn-group:create capability to perform this action.

Request Body schema: application/json
groupName
string
fgdnGroupMembersList
string

Responses

Request samples

Content type
application/json
{
  • "groupName": "test",
  • "fgdnGroupMembersList": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/fgdn-groups/1",
  • "groupId": 1,
  • "groupName": "test",
  • "fgdnGroupMembersList": [
    ]
}

Get all FGDN Groups

Get all FGDN Groups configured in SBCE.

User must have the fgdn-group:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the FGDN Group for given ID

Get FGDN Group by groupId configured in SBCE.

User must have the fgdn-group:read capability to perform this action.

path Parameters
groupId
required
integer

ID of the FGDN Group

Responses

Response samples

Content type
application/json
{
  • "groupId": 1,
  • "groupName": "test",
  • "fgdnGroupMembersList": [
    ]
}

Delete the FGDN Group for given ID

Delete FGDN Group by groupId in SBCE

User must have the fgdn-group:delete capability to perform this action.

path Parameters
groupId
required
integer

ID of the FGDN Group

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new FGDN Member in SBCE

Adds new FGDN Member in SBCE.

User must have the fgdn-group:create capability to perform this action.

path Parameters
groupId
required
integer

ID of the FGDN Group

Request Body schema: application/json
string (PostFGDNMember)

Responses

Request samples

Content type
application/json
[
  • "sbc1.com",
  • "sbc2.com"
]

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/fgdn-groups/1",
  • "groupId": 1,
  • "groupName": "test",
  • "fgdnGroupMembersList": [
    ]
}

Edit existing FGDN Member in SBCE

Edit existing FGDN Member in SBCE.

User must have the fgdn-group:create capability to perform this action.

path Parameters
groupId
required
integer

ID of the FGDN Group

oldFgdnMember
required
string

Old FGDN Member

newFgdnMember
required
string

Update FGDN Member

Responses

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/fgdn-groups/1",
  • "groupId": 1,
  • "groupName": "test",
  • "fgdnGroupMembersList": [
    ]
}

Delete the FGDN Member

Delete FGDN Member of groupId in SBCE

User must have the fgdn-group:delete capability to perform this action.

path Parameters
groupId
required
integer

ID of the FGDN Group

fgdnMember
required
string

Name of the FGDN Member

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Time of Day Rules

APIs for managing time of day rules.

Add a new Time of Day Rule

Adds new Time of Day Rule in SBCE.

User must have the tod-rule:create capability to perform this action.

Request Body schema: application/json
ruleName
string
startDate
string <date>
endDate
string <date>
startTime
string <time>
endTime
string <time>
days
string

Select the days of the weeks

weeks
string
day
integer
recurrence
string
Enum: "DAILY_EVERYDAY" "DAILY_WEEKDAY" "DAILY_WEEKEND" "WEEKLY_WEEKLY" "MONTHLY_ON_X_EVERY_MONTH"

Responses

Request samples

Content type
application/json
{
  • "ruleName": "test",
  • "startDate": "23-03-2020",
  • "endDate": "23-03-2020",
  • "startTime": "00:00",
  • "endTime": "23:59",
  • "days": [
    ],
  • "weeks": [
    ],
  • "day": 3,
  • "recurrence": "DAILY_EVERYDAY"
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/tod-rules/1",
  • "ruleId": 1,
  • "ruleName": "test",
  • "startDate": "23-03-2020",
  • "endDate": "23-03-2020",
  • "startTime": "00:00",
  • "endTime": "23:59",
  • "days": [
    ],
  • "weeks": [
    ],
  • "day": 3,
  • "recurrence": "DAILY_EVERYDAY"
}

Get all Time of Day Rules

Get all FGDN Groups configured in SBCE.

User must have the tod-rule:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit an existing Time of Day rule

Modify an existing Time of Day rule for this system.

User must have the tod-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the rule

Request Body schema: application/json
ruleName
string
startDate
string <date>
endDate
string <date>
startTime
string <time>
endTime
string <time>
days
string

Select the days of the weeks

weeks
string
day
integer
recurrence
string
Enum: "DAILY_EVERYDAY" "DAILY_WEEKDAY" "DAILY_WEEKEND" "WEEKLY_WEEKLY" "MONTHLY_ON_X_EVERY_MONTH"

Responses

Request samples

Content type
application/json
{
  • "ruleName": "test",
  • "startDate": "23-03-2020",
  • "endDate": "23-03-2020",
  • "startTime": "00:00",
  • "endTime": "23:59",
  • "days": [
    ],
  • "weeks": [
    ],
  • "day": 3,
  • "recurrence": "DAILY_EVERYDAY"
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "test",
  • "startDate": "23-03-2020",
  • "endDate": "23-03-2020",
  • "startTime": "00:00",
  • "endTime": "23:59",
  • "days": [
    ],
  • "weeks": [
    ],
  • "day": 3,
  • "recurrence": "DAILY_EVERYDAY"
}

Get the Time Of Day Rule for given ID

Get Time Of Day Rule by ruleId configured in SBCE.

User must have the tod-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "test",
  • "startDate": "23-03-2020",
  • "endDate": "23-03-2020",
  • "startTime": "00:00",
  • "endTime": "23:59",
  • "days": [
    ],
  • "weeks": [
    ],
  • "day": 3,
  • "recurrence": "DAILY_EVERYDAY"
}

Delete the Time of Day Rule for given ID

Delete Time of Day Rule by ruleId in SBCE

User must have the tod-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Logging

APIs for collecting logs.

Copy logs to a server.

Copy logs for this system to a specified SFTP server.

User must have the logging:update capability to perform this action.

Request Body schema: application/json
fromDateTime
string <date-time>
toDateTime
string <date-time>
serverAddress
string
serverPort
integer
userName
string
password
string
location
string

Responses

Request samples

Content type
application/json
{
  • "fromDateTime": "2019-11-21T19:15:55",
  • "toDateTime": "2019-11-21T19:15:55",
  • "serverAddress": "1.1.1.1",
  • "serverPort": 1212,
  • "userName": "testuser",
  • "password": "12asdf",
  • "location": "/temp"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Alarms

APIs for collecting alarms.

List all alarm events.

Retrieve a list of all alarm events for this system.

User must have the alarm:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete an alarm event.

Acknowledge and delete a specific alarm event from this system based on the alarm ID.

User must have the alarm:delete capability to perform this action.

path Parameters
id
required
integer

ID of the alarm

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Domain DoS

APIs for managing Domain Denial of Service (DoS).

Add new Domain DoS profile in SBCE

Adds new Domain DoS profile in SBCE.

User must have the domain-dos-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string
trafficType
string
Enum: "TRUNK_TRAFFIC" "REMOTE_USERS" "BOTH"
maximumConcurrentSessions
integer [ 100 .. 5000 ]
noOfRemoteUsers
integer [ 100 .. 5000 ]

Responses

Request samples

Content type
application/json
{
  • "profileName": "domainDos-profile-1",
  • "trafficType": "TRUNK_TRAFFIC",
  • "maximumConcurrentSessions": 1000,
  • "noOfRemoteUsers": 1000
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/domain-dos-profiles/8",
  • "profileId": 1,
  • "profileName": "domainDos-profile-1",
  • "trafficType": "TRUNK_TRAFFIC",
  • "maximumConcurrentSessions": 1000,
  • "noOfRemoteUsers": 1000
}

Get all Domain DoS profiles configured in SBCE

Retrieve all Domain DoS profiles configured in SBCE.

User must have the domain-dos-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit Domain DoS profile by profileId in SBCE

Edit Domain DoS profile for given profileId in SBCE.

User must have the domain-dos-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Request Body schema: application/json
profileName
string
trafficType
string
Enum: "TRUNK_TRAFFIC" "REMOTE_USERS" "BOTH"
maximumConcurrentSessions
integer [ 100 .. 5000 ]
noOfRemoteUsers
integer [ 100 .. 5000 ]

Responses

Request samples

Content type
application/json
{
  • "profileName": "domainDos-profile-1",
  • "trafficType": "TRUNK_TRAFFIC",
  • "maximumConcurrentSessions": 1000,
  • "noOfRemoteUsers": 1000
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "domainDos-profile-1",
  • "trafficType": "TRUNK_TRAFFIC",
  • "maximumConcurrentSessions": 1000,
  • "noOfRemoteUsers": 1000
}

Get Domain DoS profile by profileId configured in SBCE

Get Domain DoS profile by profileId configured in SBCE.

User must have the domain-dos-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "domainDos-profile-1",
  • "trafficType": "TRUNK_TRAFFIC",
  • "maximumConcurrentSessions": 1000,
  • "noOfRemoteUsers": 1000
}

Delete Domain DoS profile by profileId in SBCE

Delete Domain DoS profile by profileId in SBCE

User must have the domain-dos-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Security Rules

APIs for managing security rules.

Create new Security rule in SBCE

Adds new Security Rule in SBCE.

User must have the security-rule:create capability to perform this action.

Request Body schema: application/json
name
string
object
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "security-rule-1",
  • "compliance": {
    },
  • "domainDos": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/domain-dos-profiles/8",
  • "profileId": 1,
  • "name": "security-rule-1",
  • "compliance": {
    },
  • "domainDos": {
    },
  • "authentication": {
    }
}

Get all Security rules configured in SBCE

Retrieve all Security Rules configured in SBCE.

User must have the security-rule:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit Security Rule by ruleId in SBCE

Edit Domain Security Rule for given ruleId in SBCE.

User must have the security-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Security rule

Request Body schema: application/json
name
string
object
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "security-rule-1",
  • "compliance": {
    },
  • "domainDos": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "name": "security-rule-1",
  • "compliance": {
    },
  • "domainDos": {
    },
  • "authentication": {
    }
}

Get Security Rule by ruleId configured in SBCE

Get Security Rule by ruleId configured in SBCE.

User must have the security-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Security Rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Security Rule by ruleId in SBCE

Delete Security Rule by ruleId in SBCE

User must have the security-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Firewall Rules

APIs for managing firewall configuration.

List all firewall blacklist rules

Retrieve a list of all configured firewall blacklist rules for this system.

User must have the firewall:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new firewall blacklist rule

Create a new firewall blacklist rules for this system.

User must have the firewall:create capability to perform this action.

Request Body schema: application/json
ruleName
string
interfaceName
string
Enum: "ANY" "A1" "A2" "B1" "B2"

The interface to apply this rule to. (Note: B2 may not be available on this system)

sourceAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

sourcePortOrSequence
string

A comma separated list of ports or port ranges.

protocol
string
Enum: "TCP" "UDP" "ICMP"
destinationAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

destinationPortOrSequence
string

A comma separated list of ports or port ranges.

Responses

Request samples

Content type
application/json
{
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "ruleId": 0,
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Get a firewall blacklist rule

Retrieve a list of firewall blacklist rules for this system.

User must have the firewall:read capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "ruleId": 0,
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Modify an existing firewall blacklist rule

Modify an existing firewall blacklist rule for this system.

User must have the firewall:update capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
ruleName
string
interfaceName
string
Enum: "ANY" "A1" "A2" "B1" "B2"

The interface to apply this rule to. (Note: B2 may not be available on this system)

sourceAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

sourcePortOrSequence
string

A comma separated list of ports or port ranges.

protocol
string
Enum: "TCP" "UDP" "ICMP"
destinationAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

destinationPortOrSequence
string

A comma separated list of ports or port ranges.

Responses

Request samples

Content type
application/json
{
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "ruleId": 0,
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Delete an existing firewall blacklist rule

Delete an existing firewall blacklist rule for this system.

User must have the firewall:delete capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List all firewall whitelist rules

Retrieve a list of all configured firewall whitelist rules for this system.

User must have the firewall:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "ruleId": 0,
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Create a new firewall whitelist rule

Create a new firewall whitelist rules for this system.

User must have the firewall:create capability to perform this action.

Request Body schema: application/json
ruleName
string
interfaceName
string
Enum: "ANY" "A1" "A2" "B1" "B2"

The interface to apply this rule to. (Note: B2 may not be available on this system)

sourceAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

sourcePortOrSequence
string

A comma separated list of ports or port ranges.

protocol
string
Enum: "TCP" "UDP" "ICMP"
destinationAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

destinationPortOrSequence
string

A comma separated list of ports or port ranges.

Responses

Request samples

Content type
application/json
{
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "ruleId": 0,
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Get a firewall whitelist rule

Retrieve a list of firewall whitelist rules for this system.

User must have the firewall:read capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Modify an existing firewall whitelist rule

Modify an existing firewall whitelist rule for this system.

User must have the firewall:update capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
ruleName
string
interfaceName
string
Enum: "ANY" "A1" "A2" "B1" "B2"

The interface to apply this rule to. (Note: B2 may not be available on this system)

sourceAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

sourcePortOrSequence
string

A comma separated list of ports or port ranges.

protocol
string
Enum: "TCP" "UDP" "ICMP"
destinationAddress
string

An IP address or subnet represented in CIDR notation (integer notation only).

destinationPortOrSequence
string

A comma separated list of ports or port ranges.

Responses

Request samples

Content type
application/json
{
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "ruleId": 0,
  • "ruleName": "string",
  • "interfaceName": "ANY",
  • "sourceAddress": "string",
  • "sourcePortOrSequence": "80,443,8080-8090",
  • "protocol": "TCP",
  • "destinationAddress": "string",
  • "destinationPortOrSequence": "80,443,8080-8090"
}

Delete an existing firewall whitelist rule

Delete an existing firewall whitelist rule for this system.

User must have the firewall:delete capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List services

List all services which can be acted upon by the firewall.

User must have the firewall:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Manage firewall service action

Manage settings for a service which can be acted upon by the firewall.

User must have the firewall:update capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
action
string
Enum: "ACCEPT" "REJECT" "DROP"

Responses

Request samples

Content type
application/json
{
  • "action": "ACCEPT"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "action": "ACCEPT"
}

List firewall rate limits

List rate-limiting settings for the firewall for this system.

User must have the firewall:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Manage firewall rate limits

Manage rate-limiting settings for the firewall for this system.

User must have the firewall:update capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
dropThreshold
integer

Responses

Request samples

Content type
application/json
{
  • "dropThreshold": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "dropThreshold": 0
}

Media Rules

APIs for managing media rules.

Create new Media rule in SBCE

Adds new Media Rule in SBCE.

User must have the media-rule:create capability to perform this action.

Request Body schema: application/json
ruleName
string
object (MediaRuleEncryption)
object (MediaRuleCodecPrioritization)
object (MediaRuleAdvanced)
object (MediaRuleQos)

Responses

Request samples

Content type
application/json
{
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/media-rules/1",
  • "ruleId": 1,
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Get all Media rules configured in SBCE

Retrieve all Media Rules configured in SBCE.

User must have the media-rule:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Media Rule by ruleId configured in SBCE

Get Media Rule by ruleId configured in SBCE.

User must have the media-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Media Rule

Responses

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Delete Media Rule by ruleId in SBCE

Delete Media Rule by ruleId in SBCE

User must have the media-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Edit Encryption fields of Media Rule by ruleId in SBCE

Edit Encryption fields of Media Rule for given ruleId in SBCE.

User must have the media-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Media rule

Request Body schema: application/json
object (MediaRuleEncryptionData)
object (MediaRuleEncryptionData)
capabilityNegotiation
boolean

Responses

Request samples

Content type
application/json
{
  • "audio": {
    },
  • "video": {
    },
  • "capabilityNegotiation": true
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Edit codec prioritization fields of Media Rule by ruleId in SBCE

Edit codec prioritization fields of Media Rule for given ruleId in SBCE.

User must have the media-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Media rule

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "audio": {
    },
  • "video": {
    }
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Edit advanced fields of Media Rule by ruleId in SBCE

Edit advanced fields of Media Rule for given ruleId in SBCE.

User must have the media-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Media rule

Request Body schema: application/json
object
object
enableBFCP
boolean

Indicates whether Binary Floor Control Protocol (BFCP) is used in a people and content telepresence scenario to control the content channel. Content information is passed as a video stream and is controlled by the BFCP channel. It enables the moderator to release floor control to participants and vice versa to give control of the content channel to various participants. The system works on sending a token on the BFCP control signaling. The moderator allows or denies the access to the token. Avaya SBCE can support one BFCP channel for multiple video content channels.

enableFECC
boolean

Indicates whether Far End Camera Control (FECC) is enabled. It provides mixed encryption support for audio, main video, and FECC . In the media path, using an RTP payload type sends control signaling to control the far end camera. The FECC channel facilitates setting up the signaling for the media path, and control signals are sent on this path using the RTP payload type of a particular codec type (H.224).

enableMediaLineCompliance
boolean
iceGatewaySupport
boolean
Default: false

Enables support for Interactive Connectivity Establishment (ICE) used when connecting with Microsoft Teams. When enabled, you can administer the Local Media Optimization options.

object
enableRTCPMux
boolean
Default: false

System supports for RTCP multiplexing (RTCP-MUX) when it is enabled.

enableAudioPortChangeOnNewOffer
boolean
Default: false

Specifies whether Avaya SBC generates new ports when a new OFFER message is received. By default, this option is disabled, meaning Avaya SBC will not generate new ports.

enableVideoPortChangeOnNewOffer
boolean
Default: false

Specifies whether Avaya SBC generates new ports when a new OFFER message is received. By default, this option is disabled, meaning Avaya SBC will not generate new ports.

enableAudioPortChangeOnAnswer
boolean
Default: false
enableVideoPortChangeOnAnswer
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "silencing": {
    },
  • "anat": {
    },
  • "enableBFCP": false,
  • "enableFECC": false,
  • "enableMediaLineCompliance": false,
  • "iceGatewaySupport": false,
  • "localMediaOptimization": {
    },
  • "enableRTCPMux": false,
  • "enableAudioPortChangeOnNewOffer": false,
  • "enableVideoPortChangeOnNewOffer": false,
  • "enableAudioPortChangeOnAnswer": false,
  • "enableVideoPortChangeOnAnswer": false
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Edit qos fields of Media Rule by ruleId in SBCE

Edit qos fields of Media Rule for given ruleId in SBCE.

User must have the media-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Media rule

Request Body schema: application/json
enable
boolean
object
object

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "tos": {
    },
  • "dscp": {
    }
}

Response samples

Content type
application/json
{
  • "ruleId": 1,
  • "ruleName": "media-rule-1",
  • "encryption": {
    },
  • "codecPrioritization": {
    },
  • "advanced": {
    },
  • "qos": {
    }
}

Advanced Options

APIs for managing advanced options.

Add or edit new advanced SIP options in SBCE

Adds and edits advanced SIP options in SBCE.

User must have the sip-option:create capability to perform this action.

Request Body schema: application/json
dnsCaching
boolean
asSipMode
boolean
e911UriGroupId
integer
maxConcurrentSessions
integer

Responses

Request samples

Content type
application/json
{
  • "dnsCaching": false,
  • "asSipMode": true,
  • "e911UriGroupId": 2,
  • "maxConcurrentSessions": 20
}

Response samples

Content type
application/json
{
  • "dnsCaching": false,
  • "asSipMode": true,
  • "e911UriGroupId": 2,
  • "maxConcurrentSessions": 20
}

Get advanced SIP options

Retrieve advanced SIP Options configured in SBCE.

User must have the sip-option:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "dnsCaching": false,
  • "asSipMode": true,
  • "e911UriGroupId": 2,
  • "maxConcurrentSessions": 20
}

Add or edit periodic stats in SBCE

Add or edit periodic stats in SBCE.

User must have the periodic-stat:create capability to perform this action.

Request Body schema: application/json
collectPeriodicStat
boolean
collectionIntervalInSeconds
integer

Responses

Request samples

Content type
application/json
{
  • "collectPeriodicStat": true,
  • "collectionIntervalInSeconds": 60
}

Response samples

Content type
application/json
{
  • "collectPeriodicStat": true,
  • "collectionIntervalInSeconds": 60
}

Get Periodic statistics values

Retrieve Periodic statistics values configured in SBCE.

User must have the periodic-stat:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "collectPeriodicStat": true,
  • "collectionIntervalInSeconds": 60
}

Add or edit RTCP Monitoring in SBCE

Adds and edits advanced RTCP Monitoring in SBCE.

User must have the rtcp-monitoring:create capability to perform this action.

Request Body schema: application/json
object (RTCPMonitoringRelay)
object (RTCPMonitoringReportGeneration)

Responses

Request samples

Content type
application/json
{
  • "rtcpMonitoringRelay": {
    },
  • "rtcpMonitoringReportGeneration": {
    }
}

Response samples

Content type
application/json
{
  • "rtcpMonitoringRelay": {
    },
  • "rtcpMonitoringReportGeneration": {
    }
}

Get advanced RTCP Monitoring

Retrieve advanced RTCP Monitoring configured in SBCE.

User must have the rtcp-monitoring:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "rtcpMonitoringRelay": {
    },
  • "rtcpMonitoringReportGeneration": {
    }
}

Add or edit Network options in SBCE

Adds and edits advanced network options in SBCE.

User must have the network-option:create capability to perform this action.

path Parameters
status
required
string
Enum: "ENABLED" "DISABLED"

status of the network option Allow non unique IP

Responses

Response samples

Content type
application/json
{
  • "allowNonUniqueIp": "ENABLED"
}

Get advanced Network option

Retrieve advanced advanced network options configured in SBCE.

User must have the network-option:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "allowNonUniqueIp": "ENABLED"
}

Topology Hiding Profiles

APIs for managing topology hiding profiles.

Create new Topology Hiding Profile in SBCE

Adds new Topology Hiding Profile in SBCE.

User must have the topology-hiding-profile:create capability to perform this action.

Request Body schema: application/json
profileName
string
Array of objects (TopologyHidingProfile_headerRule)

Responses

Request samples

Content type
application/json
{
  • "profileName": "topology-hiding-profile-1",
  • "headerRules": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/topology-hiding-profiles/1",
  • "profileId": 1,
  • "profileName": "topology-hiding-profile-1",
  • "headerRules": [
    ]
}

Get all Topology Hiding Profiles configured in SBCE

Retrieve all Topology Hiding Profiles configured in SBCE.

User must have the topology-hiding-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Topology Hiding Profile by profileId configured in SBCE

Get Topology Hiding Profile by profileId configured in SBCE.

User must have the topology-hiding-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the Topology Hiding Profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "topology-hiding-profile-1",
  • "headerRules": [
    ]
}

Delete Topology Hiding Profile by profileId in SBCE

Delete Topology Hiding Profile by profileId in SBCE

User must have the topology-hiding-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add or Edit Header rule of Topology Hiding Profile by profileId in SBCE

Add or Edit Header rule of Topology Hiding Profile by profileId in SBCE

User must have the topology-hiding-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the Topology Hiding Profile

header
required
string
Enum: "REQUEST_LINE" "FROM" "TO" "RECORD_ROUTE" "VIA" "SDP" "REFER_TO" "REFER_BY"

header required to add or update in Topology Hiding Profile

Request Body schema: application/json
header
string
Enum: "REQUEST_LINE" "FROM" "TO" "RECORD_ROUTE" "VIA" "SDP" "REFER_TO" "REFER_BY"
criteria
string
Enum: "IP_DOMAIN" "IP" "DOMAIN"
action
string
Enum: "AUTO" "NEXT_HOP" "DESTINATION_IP" "SIGNALING_INTERFACE" "MEDIA_INTERFACE" "OVERWRITE"
overwriteValue
string

Responses

Request samples

Content type
application/json
{
  • "header": "REQUEST_LINE",
  • "criteria": "IP_DOMAIN",
  • "action": "OVERWRITE",
  • "overwriteValue": "a.com"
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "topology-hiding-profile-1",
  • "headerRules": [
    ]
}

Delete Header Rule from Topology Hiding Profile by profileId in SBCE

Delete Header Rule from Topology Hiding Profile by profileId in SBCE

User must have the topology-hiding-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the Topology Hiding Profile

header
required
string
Enum: "REQUEST_LINE" "FROM" "TO" "RECORD_ROUTE" "VIA" "SDP" "REFER_TO" "REFER_BY"

header required to add or update in Topology Hiding Profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

DoS Settings

APIs for managing Denial of Service (DoS) / Distributed Denial of Service (DDoS) settings.

Get single source DoS settings

Retrieve the single source DoS settings from this system.

User must have the dos:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "method": "string",
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Update single source DoS settings

Update the single source DoS settings on this system.

User must have the dos:update capability to perform this action.

Request Body schema: application/json
threshold
integer
action
string (DosSettingsAction)
Enum: "ALERT" "BLOCK" "CHALLENGE"
blockDuration
integer

Duration to block after threshold violations; Ignored if action is not BLOCK.

Responses

Request samples

Content type
application/json
{
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Response samples

Content type
application/json
{
  • "method": "string",
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Get phone DoS settings

Retrieve the phone DoS settings from this system.

User must have the dos:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "service": "string",
  • "method": "string",
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Update phone DoS settings

Update the phone DoS settings on this system.

User must have the dos:update capability to perform this action.

Request Body schema: application/json
threshold
integer
action
string (DosSettingsActionWithLimit)
Enum: "ALERT" "BLOCK" "CHALLENGE" "LIMIT"
blockDuration
integer

Duration to block after threshold violations; Ignored if action is not BLOCK.

Responses

Request samples

Content type
application/json
{
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Response samples

Content type
application/json
{
  • "service": "string",
  • "method": "string",
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Get stealth DoS settings

Retrieve the stealth DoS settings from this system.

User must have the dos:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get stealth DoS settings for a specific timeslot

Retrieve the stealth DoS settings from this system by timeslot.

User must have the dos:read capability to perform this action.

path Parameters
timeslot
required
string (DosSettingsStealthTimeslot)
Enum: "MORNING" "AFTERNOON" "EVENING" "NIGHT"

This parameter is case-insensitive.

Responses

Response samples

Content type
application/json
{
  • "timeslot": "MORNING",
  • "service": "string",
  • "method": "string",
  • "averageDurationThreshold": 0,
  • "maxConsecutiveViolations": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Update stealth DoS settings for a specific timeslot

Update the stealth DoS settings on this system.

User must have the dos:update capability to perform this action.

path Parameters
timeslot
required
string (DosSettingsStealthTimeslot)
Enum: "MORNING" "AFTERNOON" "EVENING" "NIGHT"

This parameter is case-insensitive.

Request Body schema: application/json
averageDurationThreshold
integer
maxConsecutiveViolations
integer
action
string (DosSettingsAction)
Enum: "ALERT" "BLOCK" "CHALLENGE"
blockDuration
integer

Duration to block after threshold violations; Ignored if action is not BLOCK.

Responses

Request samples

Content type
application/json
{
  • "averageDurationThreshold": 0,
  • "maxConsecutiveViolations": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Response samples

Content type
application/json
{
  • "timeslot": "MORNING",
  • "service": "string",
  • "method": "string",
  • "averageDurationThreshold": 0,
  • "maxConsecutiveViolations": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Get call walking DoS settings

Retrieve the call walking DoS settings from this system.

User must have the dos:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get call walking DoS settings for a specific method

Retrieve the call walking DoS settings from this system.

User must have the dos:read capability to perform this action.

path Parameters
method
required
string (DosSettingsCallWalkingMethod)
Enum: "ALL" "INVITE" "REGISTER"

This parameter is case-insensitive.

Responses

Response samples

Content type
application/json
{
  • "service": "string",
  • "method": "ALL",
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Update call walking DoS settings for a specific method

Update the call walking DoS settings on this system.

User must have the dos:update capability to perform this action.

path Parameters
method
required
string (DosSettingsCallWalkingMethod)
Enum: "ALL" "INVITE" "REGISTER"

This parameter is case-insensitive.

Request Body schema: application/json
threshold
integer
action
string (DosSettingsAction)
Enum: "ALERT" "BLOCK" "CHALLENGE"
blockDuration
integer

Duration to block after threshold violations; Ignored if action is not BLOCK.

Responses

Request samples

Content type
application/json
{
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Response samples

Content type
application/json
{
  • "service": "string",
  • "method": "ALL",
  • "threshold": 0,
  • "action": "ALERT",
  • "blockDuration": 0
}

Get DoS whitelist

Retrieve the DoS whitelist from this system.

User must have the dos:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "uriGroup": 0
}

Update DoS whitelist

Update the DoS whitelist on this system.

User must have the dos:update capability to perform this action.

Request Body schema: application/json
uriGroup
integer

Responses

Request samples

Content type
application/json
{
  • "uriGroup": 0
}

Response samples

Content type
application/json
{
  • "uriGroup": 0
}

Server Interworking

APIs for managing server interworking.

List all server interworking profiles

Retrieve a list of all configured server interworking profiles for this system.

User must have the server-interworking:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new server interworking profile

Create a new server interworking profile for this system.

User must have the server-interworking:create capability to perform this action.

Request Body schema: application/json
profileName
string
object (ServerInterworkingGeneral)
object (ServerInterworkingPrivacy)
object (ServerInterworkingTimers)
object (ServerInterworkingAdvanced)

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "general": {
    },
  • "privacy": {
    },
  • "timers": {
    },
  • "advanced": {
    }
}

Response samples

Content type
application/json
{
  • "resourcePath": "api/config/v1/server-interworking/1",
  • "profileId": 1,
  • "profileName": "test",
  • "general": {
    },
  • "privacy": {
    },
  • "timers": {
    },
  • "advanced": {
    }
}

Get a server interworking profile

Retrieve an existing server interworking profile from this system.

User must have the server-interworking:read capability to perform this action.

path Parameters
profileId
required
integer

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "general": {
    },
  • "privacy": {
    },
  • "timers": {
    },
  • "advanced": {
    }
}

Modify an existing server interworking profile

Modify an existing server interworking profile for this system. All fields are optional and any omitted field will use the value from the existing profile.

User must have the server-interworking:update capability to perform this action.

path Parameters
profileId
required
integer
Request Body schema: application/json
profileName
string
object (ServerInterworkingGeneral)
object (ServerInterworkingPrivacy)
object (ServerInterworkingTimers)
object (ServerInterworkingAdvanced)

Responses

Request samples

Content type
application/json
{
  • "profileName": "test",
  • "general": {
    },
  • "privacy": {
    },
  • "timers": {
    },
  • "advanced": {
    }
}

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "test",
  • "general": {
    },
  • "privacy": {
    },
  • "timers": {
    },
  • "advanced": {
    }
}

Delete an existing server interworking profile

Delete an existing server interworking profile from this system.

User must have the server-interworking:delete capability to perform this action.

path Parameters
profileId
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Signaling Rules

APIs for managing signaling rules.

Create new Signaling rule in SBCE

Adds new Signaling Rule in SBCE.

User must have the signaling-rule:create capability to perform this action.

Request Body schema: application/json
ruleName
string
object (SignalingRule_general)
Array of objects (SignalingRule_requestRule)
Array of objects (SignalingRule_responseRule)
Array of objects (SignalingRule_requestHeaderRule)
Array of objects (SignalingRule_responseHeaderRule)
object (SignalingRule_signalingQos)
object (SignalingRule_ucid)

Responses

Request samples

Content type
application/json
{
  • "ruleName": "signaling-rule-1",
  • "general": {
    },
  • "requestRules": [
    ],
  • "responseRules": [
    ],
  • "requestHeaderRules": [
    ],
  • "responseHeaderRules": [
    ],
  • "signalingQos": {
    },
  • "ucid": {
    }
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/signaling-rules/10",
  • "ruleId": 10,
  • "ruleName": "signaling-rule-1",
  • "general": {
    },
  • "requestRules": [
    ],
  • "responseRules": [
    ],
  • "requestHeaderRules": [
    ],
  • "responseHeaderRules": [
    ],
  • "signalingQos": {
    },
  • "ucid": {
    }
}

Get all Signaling rules configured in SBCE

Retrieve all Signaling Rules configured in SBCE.

User must have the signaling-rule:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Signaling Rule by ruleId configured in SBCE

Get Signaling Rule by ruleId configured in SBCE.

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Responses

Response samples

Content type
application/json
{
  • "ruleId": 10,
  • "ruleName": "signaling-rule-1",
  • "general": {
    },
  • "requestRules": [
    ],
  • "responseRules": [
    ],
  • "requestHeaderRules": [
    ],
  • "responseHeaderRules": [
    ],
  • "signalingQos": {
    },
  • "ucid": {
    }
}

Delete Signaling Rule by ruleId in SBCE

Delete Signaling Rule by ruleId in SBCE

User must have the signaling-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Edit General fields of Signaling Rule by ruleId in SBCE

Edit General fields of Signaling Rule for given ruleId in SBCE.

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
object (SignalingRule_general_boundDetails)
object (SignalingRule_general_boundDetails)
object

Responses

Request samples

Content type
application/json
{
  • "inbound": {
    },
  • "outbound": {
    },
  • "contentTypePolicy": {
    }
}

Response samples

Content type
application/json
{
  • "ruleId": 10,
  • "ruleName": "signaling-rule-1",
  • "general": {
    },
  • "requestRules": [
    ],
  • "responseRules": [
    ],
  • "requestHeaderRules": [
    ],
  • "responseHeaderRules": [
    ],
  • "signalingQos": {
    },
  • "ucid": {
    }
}

Edit UCID fields of Signaling Rule by ruleId in SBCE

Edit UCID fields of Signaling Rule for given ruleId in SBCE.

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
enabled
boolean
nodeId
number [ 1 .. 32767 ]

this values should be present when enabled is true

protocolDiscriminator
string
Enum: "00" "04"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "nodeId": 1,
  • "protocolDiscriminator": "00"
}

Response samples

Content type
application/json
{
  • "ruleId": 10,
  • "ruleName": "signaling-rule-1",
  • "general": {
    },
  • "requestRules": [
    ],
  • "responseRules": [
    ],
  • "requestHeaderRules": [
    ],
  • "responseHeaderRules": [
    ],
  • "signalingQos": {
    },
  • "ucid": {
    }
}

Edit Signaling QoS fields of Signaling Rule by ruleId in SBCE

Edit Signaling QoS fields of Signaling Rule for given ruleId in SBCE.

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
enabled
boolean
object
object

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "dscp": {
    },
  • "tos": {
    }
}

Response samples

Content type
application/json
{
  • "ruleId": 10,
  • "ruleName": "signaling-rule-1",
  • "general": {
    },
  • "requestRules": [
    ],
  • "responseRules": [
    ],
  • "requestHeaderRules": [
    ],
  • "responseHeaderRules": [
    ],
  • "signalingQos": {
    },
  • "ucid": {
    }
}

Add new Request rule to Signaling Rule by ruleId in SBCE

Add new Request rule to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:create capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
proprietaryRequest
boolean
methodName
string
Enum: "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"

if proprietaryRequest is false then methodName should be one of defined values.

object
object
direction
string
Enum: "IN" "OUT"

Responses

Request samples

Content type
application/json
{
  • "proprietaryRequest": false,
  • "methodName": "ACK",
  • "inDialogAction": {
    },
  • "outOfDialogAction": {
    },
  • "direction": "IN"
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/signaling-rules/10/request-rules/ACK/IN",
  • "proprietaryRequest": false,
  • "methodName": "ACK",
  • "inDialogAction": {
    },
  • "outOfDialogAction": {
    },
  • "direction": "IN"
}

Get all Request rules associated to Signaling Rule by ruleId in SBCE

Get all Request rules associated to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit Request rule with method name direction in Signaling Rule by ruleId in SBCE

Edit Request rule with method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

methodName
required
string

methodName of the request rule

direction
required
string

direction of the request rule

Request Body schema: application/json
proprietaryRequest
boolean
methodName
string
Enum: "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"

if proprietaryRequest is false then methodName should be one of defined values.

object
object
direction
string
Enum: "IN" "OUT"

Responses

Request samples

Content type
application/json
{
  • "proprietaryRequest": false,
  • "methodName": "ACK",
  • "inDialogAction": {
    },
  • "outOfDialogAction": {
    },
  • "direction": "IN"
}

Response samples

Content type
application/json
{
  • "proprietaryRequest": false,
  • "methodName": "ACK",
  • "inDialogAction": {
    },
  • "outOfDialogAction": {
    },
  • "direction": "IN"
}

Get Request rule with method name direction in Signaling Rule by ruleId in SBCE

Get Request rule with method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

methodName
required
string

methodName of the request rule

direction
required
string

direction of the request rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Request rule with method name direction in Signaling Rule by ruleId in SBCE

Delete Request rule with method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

methodName
required
string

methodName of the request rule

direction
required
string

direction of the request rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new Response rule to Signaling Rule by ruleId in SBCE

Add new Response rule to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:create capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
proprietaryResponse
boolean
responseCode
string
Enum: "3XX" "300" "301" "302" "305" "380" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "500" "501" "502" "503" "504" "505" "513" "580" "600" "603" "604" "606"

if proprietaryResponse is false then headerName should be once of defined values.

methodName
string
Enum: "ALL" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"
object
direction
string

Responses

Request samples

Content type
application/json
{
  • "proprietaryResponse": false,
  • "responseCode": "3XX",
  • "methodName": "ALL",
  • "inDialogAction": {
    },
  • "direction": "string"
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/signaling-rules/10/response-rules/3XX/ALL/IN",
  • "proprietaryResponse": false,
  • "responseCode": "3XX",
  • "methodName": "ALL",
  • "inDialogAction": {
    },
  • "direction": "string"
}

Get all Response rules associated to Signaling Rule by ruleId in SBCE

Get all Response rules associated to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

Edit Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

methodName
required
string

methodName of the response rule

direction
required
string

direction of the response rule

responseCode
required
string

responseCode of the response rule

Request Body schema: application/json
proprietaryResponse
boolean
responseCode
string
Enum: "3XX" "300" "301" "302" "305" "380" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "500" "501" "502" "503" "504" "505" "513" "580" "600" "603" "604" "606"

if proprietaryResponse is false then headerName should be once of defined values.

methodName
string
Enum: "ALL" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"
object
direction
string

Responses

Request samples

Content type
application/json
{
  • "proprietaryResponse": false,
  • "responseCode": "3XX",
  • "methodName": "ALL",
  • "inDialogAction": {
    },
  • "direction": "string"
}

Response samples

Content type
application/json
{
  • "proprietaryResponse": false,
  • "responseCode": "3XX",
  • "methodName": "ALL",
  • "inDialogAction": {
    },
  • "direction": "string"
}

Get Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

Get Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

methodName
required
string

methodName of the response rule

direction
required
string

direction of the response rule

responseCode
required
string

responseCode of the response rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

Delete Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

methodName
required
string

methodName of the response rule

direction
required
string

direction of the response rule

responseCode
required
string

responseCode of the response rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new Request header rule to Signaling Rule by ruleId in SBCE

Add new Request header rule to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:create capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
proprietaryRequestHeader
boolean
headerName
string
Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate"

if proprietaryRequestHeader is false then headerName should be once of defined values.

methodName
string
Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"
headerCriteria
string
Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN"
object
direction
string
Enum: "IN" "OUT"

Responses

Request samples

Content type
application/json
{
  • "proprietaryRequestHeader": true,
  • "headerName": "Accept",
  • "methodName": "ACK",
  • "headerCriteria": "MANDATORY",
  • "action": {
    },
  • "direction": "IN"
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/signaling-rules/10/request-header-rules/Accept/ACK/IN",
  • "proprietaryRequestHeader": true,
  • "headerName": "Accept",
  • "methodName": "ACK",
  • "headerCriteria": "MANDATORY",
  • "action": {
    },
  • "direction": "IN"
}

Get all Request header rules associated to Signaling Rule by ruleId in SBCE

Get all Request header rules associated to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit Request header rule with header name, method name and direction in Signaling Rule by ruleId in SBCE

Edit Request header rule with method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

headerName
required
string

headerName of the request header rule

methodName
required
string

methodName of the request header rule

direction
required
string

direction of the request header rule

Request Body schema: application/json
proprietaryRequestHeader
boolean
headerName
string
Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate"

if proprietaryRequestHeader is false then headerName should be once of defined values.

methodName
string
Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"
headerCriteria
string
Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN"
object
direction
string
Enum: "IN" "OUT"

Responses

Request samples

Content type
application/json
{
  • "proprietaryRequestHeader": true,
  • "headerName": "Accept",
  • "methodName": "ACK",
  • "headerCriteria": "MANDATORY",
  • "action": {
    },
  • "direction": "IN"
}

Response samples

Content type
application/json
{
  • "proprietaryRequestHeader": true,
  • "headerName": "Accept",
  • "methodName": "ACK",
  • "headerCriteria": "MANDATORY",
  • "action": {
    },
  • "direction": "IN"
}

Get Request header rule with method name direction in Signaling Rule by ruleId in SBCE

Get Request header rule with method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

headerName
required
string

headerName of the request header rule

methodName
required
string

methodName of the request header rule

direction
required
string

direction of the request header rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Request header rule with header name, method name direction in Signaling Rule by ruleId in SBCE

Delete Request header rule with method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

headerName
required
string

headerName of the request header rule

methodName
required
string

methodName of the request header rule

direction
required
string

direction of the request header rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new Response header rule to Signaling Rule by ruleId in SBCE

Add new Response header rule to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:create capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Request Body schema: application/json
proprietaryResponseHeader
boolean
headerName
string
Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate"

if proprietaryResponseHeader is false then headerName should be once of defined values.

methodName
string
Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"
responseCode
string
Enum: "1XX" "100" "180" "181" "182" "183" "2XX" "200" "202" "3XX" "300" "301" "302" "305" "380" "4XX" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "5XX" "500" "501" "502" "503" "504" "505" "513" "580" "6XX" "600" "603" "604" "606"
headerCriteria
string
Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN"
object
direction
string
Enum: "IN" "OUT"

Responses

Request samples

Content type
application/json
{
  • "proprietaryResponseHeader": false,
  • "headerName": "Accept",
  • "methodName": "ALL",
  • "responseCode": "1XX",
  • "headerCriteria": "OPTIONAL",
  • "action": {
    },
  • "direction": "IN"
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/signaling-rules/10/response-header-rules/Accept/1XX/ALL/IN",
  • "proprietaryResponseHeader": false,
  • "headerName": "Accept",
  • "methodName": "ALL",
  • "responseCode": "1XX",
  • "headerCriteria": "OPTIONAL",
  • "action": {
    },
  • "direction": "IN"
}

Get all Response header rules associated to Signaling Rule by ruleId in SBCE

Get all Response header rules associated to Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit Response header rule with header name, response code, method name direction in Signaling Rule by ruleId in SBCE

Edit Response header rule with header name, response code, method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:update capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

headerName
required
string

headerName of the response header rule

methodName
required
string

methodName of the response header rule

direction
required
string

direction of the response header rule

responseCode
required
string

responseCode of the response header rule

Request Body schema: application/json
proprietaryResponseHeader
boolean
headerName
string
Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate"

if proprietaryResponseHeader is false then headerName should be once of defined values.

methodName
string
Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE"
responseCode
string
Enum: "1XX" "100" "180" "181" "182" "183" "2XX" "200" "202" "3XX" "300" "301" "302" "305" "380" "4XX" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "5XX" "500" "501" "502" "503" "504" "505" "513" "580" "6XX" "600" "603" "604" "606"
headerCriteria
string
Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN"
object
direction
string
Enum: "IN" "OUT"

Responses

Request samples

Content type
application/json
{
  • "proprietaryResponseHeader": false,
  • "headerName": "Accept",
  • "methodName": "ALL",
  • "responseCode": "1XX",
  • "headerCriteria": "OPTIONAL",
  • "action": {
    },
  • "direction": "IN"
}

Response samples

Content type
application/json
{
  • "proprietaryResponse": false,
  • "responseCode": "3XX",
  • "methodName": "ALL",
  • "inDialogAction": {
    },
  • "direction": "string"
}

Get Response header rule with header name, response code, method name direction in Signaling Rule by ruleId in SBCE

Get Response header rule with response code, method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:read capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

headerName
required
string

headerName of the response header rule

methodName
required
string

methodName of the response header rule

direction
required
string

direction of the response header rule

responseCode
required
string

responseCode of the response header rule

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Response rule with header name, response code, method name direction in Signaling Rule by ruleId in SBCE

Delete Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE

User must have the signaling-rule:delete capability to perform this action.

path Parameters
ruleId
required
integer

ID of the Signaling Rule

headerName
required
string

headerName of the response header rule

methodName
required
string

methodName of the response header rule

direction
required
string

direction of the response header rule

responseCode
required
string

responseCode of the response header rule

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

SNI Groups

APIs for managing Server Name Indication (SNI) groups.

List all SNI groups

Retrieve a list of SNI groups from this system.

User must have the sni-group:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new SNI group

Create a new SNI group for this system.

User must have the sni-group:create capability to perform this action.

Request Body schema: application/json
name
string
profileList
Array of integers

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profileList": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "string",
  • "id": 0,
  • "name": "string",
  • "profileList": [
    ]
}

Get an SNI group

Retrieve an existing SNI group from this system.

User must have the sni-group:read capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "profileList": [
    ]
}

Modify an existing SNI group

Modify an existing SNI group for this system.

User must have the sni-group:update capability to perform this action.

path Parameters
id
required
integer
Request Body schema: application/json
name
string
profileList
Array of integers

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profileList": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "profileList": [
    ]
}

Delete an existing SNI group

Delete an existing SNI group from this system.

User must have the sni-group:delete capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

H.248 Profiles

APIs for managing the H.248 Profiles.

Create new H.248 profile in SBCE

Add new H.248 profile profile in SBCE

User must have the h248-profile:create capability to perform this action.

Request Body schema: application/json
required

H.248 Profile object that needs to be added in SBCE.

profileName
string <= 32
Array of objects (PostH248ProfileAddress)

Responses

Request samples

Content type
application/json
{
  • "profileName": "H248-profile-1",
  • "profileAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/h248-profiles/1",
  • "profileId": 1,
  • "profileName": "H248-profile-1",
  • "profileAddresses": [
    ]
}

Get all H.248 profiles

Get all H.248 profiles

User must have the h248-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the H.248 profile for given ID

Get the H.248 profile for given ID

User must have the h248-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the Profile

Responses

Response samples

Content type
application/json
{
  • "profileId": 1,
  • "profileName": "H248-profile-1",
  • "profileAddresses": [
    ]
}

Delete the H.248 profile for given ID

Delete the H.248 profile for given ID

User must have the h248-profile:delete capability to perform this action.

path Parameters
profileId
required
integer

ID of the Profile

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add new H.248 profile address to H.248 profile with profileId in SBCE.

Add new H.248 profile address to H.248 profile with profileId in SBCE.

User must have the h248-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the H.248 Profile

Request Body schema: application/json
required

H.248 profile address object that needs to be added to H.248 Profile in SBCE.

ipAddress
string
type
string
Value: "SNMP"

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "1.1.1.1",
  • "type": "SNMP"
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/h248-profiles/1/profile-addresses/10",
  • "addressId": 10,
  • "ipAddress": "1.1.1.1",
  • "type": "SNMP"
}

Get the H.248 profile addresses associated to H.248 profile for given ID

Get the H.248 profile addresses associated to H.248 profile for given ID

User must have the h248-profile:read capability to perform this action.

path Parameters
profileId
required
integer

ID of the profile

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit H.248 profile address associated to H.248 profile in SBCE

Edit H.248 profile address associated to H.248 profile in SBCE

User must have the h248-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of H.248 Profile

addressId
required
integer

ID of the profile address

Request Body schema: application/json
required

H.248 profile address object that needs to be edited for H.248 profile in SBCE.

ipAddress
string
type
string
Value: "SNMP"

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "1.1.1.1",
  • "type": "SNMP"
}

Response samples

Content type
application/json
{
  • "addressId": 10,
  • "ipAddress": "1.1.1.1",
  • "type": "SNMP"
}

Delete the H.248 profile address associated to H.248 profile for given ID

Delete the H.248 profile address associated to H.248 profile for given ID.

  • Profile cannot be deleted if it is mapped to H.248 Relay.

User must have the h248-profile:update capability to perform this action.

path Parameters
profileId
required
integer

ID of the Profile

addressId
required
integer

ID of the profile address

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

H.248 Servers

APIs for managing the H.248 Servers.

Create new H.248 Server in SBCE

Add new H.248 Server profile in SBCE

User must have the h248-server:create capability to perform this action.

Request Body schema: application/json
required

H.248 Server object that needs to be added in SBCE.

serverName
string <= 32 characters
serverType
string
Enum: "MEDIA_GATEWAY" "MEDIA_GATEWAY_CONTROLLER"
ipAddress
string

This is allowed when server type is 'MEDIA_GATEWAY_CONTROLLER'

serialId
string = 12 characters

This is allowed when server type is 'MEDIA_GATEWAY'

Responses

Request samples

Content type
application/json
{
  • "serverName": "H248-server-1",
  • "serverType": "MEDIA_GATEWAY",
  • "ipAddress": "1.1.1.1",
  • "serialId": "azdvdsdvaswd"
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/h248-servers/1",
  • "serverName": "H248-server-1",
  • "serverType": "MEDIA_GATEWAY",
  • "ipAddress": "1.1.1.1",
  • "serialId": "azdvdsdvaswd",
  • "serverId": 1
}

Get all H.248 Servers.

Get all H.248 Servers.

User must have the h248-server:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit H.248 Server in SBCE.

Edit H.248 Server in SBCE.

User must have the h248-server:update capability to perform this action.

path Parameters
serverId
required
integer

ID of the H.248 Server.

Request Body schema: application/json
required

H.248 Server object that needs to be edited.

serverName
string <= 32 characters
serverType
string
Enum: "MEDIA_GATEWAY" "MEDIA_GATEWAY_CONTROLLER"
ipAddress
string

This is allowed when server type is 'MEDIA_GATEWAY_CONTROLLER'

serialId
string = 12 characters

This is allowed when server type is 'MEDIA_GATEWAY'

Responses

Request samples

Content type
application/json
{
  • "serverName": "H248-server-1",
  • "serverType": "MEDIA_GATEWAY",
  • "ipAddress": "1.1.1.1",
  • "serialId": "azdvdsdvaswd"
}

Response samples

Content type
application/json
{
  • "serverName": "H248-server-1",
  • "serverType": "MEDIA_GATEWAY",
  • "ipAddress": "1.1.1.1",
  • "serialId": "azdvdsdvaswd",
  • "serverId": 1
}

Get the H.248 Server for given ID

Get the H.248 Server for given ID

User must have the h248-server:read capability to perform this action.

path Parameters
serverId
required
integer

ID of the H.248 Server.

Responses

Response samples

Content type
application/json
{
  • "serverName": "H248-server-1",
  • "serverType": "MEDIA_GATEWAY",
  • "ipAddress": "1.1.1.1",
  • "serialId": "azdvdsdvaswd",
  • "serverId": 1
}

Delete the H.248 Server for given ID

Delete the H.248 Server for given ID

  • Profile cannot be deleted if it is mapped to H.248 Relay.

User must have the h248-server:delete capability to perform this action.

path Parameters
serverId
required
integer

ID of the H.248 Server

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

H.248 Relay

APIs for managing the H.248 Relays.

Create new H.248 Relay in SBCE.

Add new H.248 Relay in SBCE.

User must have the h248-relay:create capability to perform this action.

Request Body schema: application/json
required

H.248 Relay object that should to be added to the SBCE.

relayName
string <= 32
listenIpId
integer

This value must be a valid reference to a valid IP address.

listenPort
integer
listenTransport
string
Enum: "TCP" "UDP" "TLS"
listenTlsProfileId
integer
Default: 0

This value must be a valid reference to a Tls server profile when the listenTransport is TLS. The 0 indicates None Profile.

connectIpId
integer

This value must be a valid reference to a valid IP address.

connectPort
integer
connectTransport
string
Enum: "TCP" "UDP" "TLS"
connectTlsProfileId
integer
Default: 0

This value must be a valid reference to a Tls client profile when the connectTransport is TLS. The 0 indicates None Profile.

mediaGatewayId
integer

This value must be a valid reference to a H248 server with server type is MEDIA_GATEWAY.

mediaGatewayControllerId
integer

This value must be a valid reference to a H248 server with server type is MEDIA_GATEWAY_CONTROLLER.

listenMediaInterfaceId
integer

This value must be valid reference to the Media Interface.

connectMediaInterfaceId
integer

This value must be valid reference to the Media Interface.

h248ProfileId
integer

This value must be valid reference to the H248 Profile.

Responses

Request samples

Content type
application/json
{
  • "relayName": "H248-relay-1",
  • "listenIpId": 1,
  • "listenPort": 1111,
  • "listenTransport": "TCP",
  • "listenTlsProfileId": 0,
  • "connectIpId": 2,
  • "connectPort": 1111,
  • "connectTransport": "TCP",
  • "connectTlsProfileId": 0,
  • "mediaGatewayId": 1,
  • "mediaGatewayControllerId": 2,
  • "listenMediaInterfaceId": 1,
  • "connectMediaInterfaceId": 2,
  • "h248ProfileId": 1
}

Response samples

Content type
application/json
{
  • "resourcePath": "/api/config/v1/h248-relay/1",
  • "relayId": 1,
  • "relayName": "H248-relay-1",
  • "listenIpId": 1,
  • "listenPort": 1111,
  • "listenTransport": "TCP",
  • "listenTlsProfileId": 0,
  • "connectIpId": 2,
  • "connectPort": 1111,
  • "connectTransport": "TCP",
  • "connectTlsProfileId": 0,
  • "mediaGatewayId": 1,
  • "mediaGatewayControllerId": 2,
  • "listenMediaInterfaceId": 1,
  • "connectMediaInterfaceId": 2,
  • "h248ProfileId": 1
}

Retrieve all H.248 Relays.

Get all H.248 Relays.

User must have the h248-relay:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit H.248 Relay in SBCE.

Edit H.248 Relay in SBCE.

User must have the h248-relay:update capability to perform this action.

path Parameters
relayId
required
integer

ID of the H.248 relay.

Request Body schema: application/json
required

H.248 relay object that needs to be edited.

relayName
string <= 32
listenIpId
integer

This value must be a valid reference to a valid IP address.

listenPort
integer
listenTransport
string
Enum: "TCP" "UDP" "TLS"
listenTlsProfileId
integer
Default: 0

This value must be a valid reference to a Tls server profile when the listenTransport is TLS. The 0 indicates None Profile.

connectIpId
integer

This value must be a valid reference to a valid IP address.

connectPort
integer
connectTransport
string
Enum: "TCP" "UDP" "TLS"
connectTlsProfileId
integer
Default: 0

This value must be a valid reference to a Tls client profile when the connectTransport is TLS. The 0 indicates None Profile.

mediaGatewayId
integer

This value must be a valid reference to a H248 server with server type is MEDIA_GATEWAY.

mediaGatewayControllerId
integer

This value must be a valid reference to a H248 server with server type is MEDIA_GATEWAY_CONTROLLER.

listenMediaInterfaceId
integer

This value must be valid reference to the Media Interface.

connectMediaInterfaceId
integer

This value must be valid reference to the Media Interface.

h248ProfileId
integer

This value must be valid reference to the H248 Profile.

Responses

Request samples

Content type
application/json
{
  • "relayName": "H248-relay-1",
  • "listenIpId": 1,
  • "listenPort": 1111,
  • "listenTransport": "TCP",
  • "listenTlsProfileId": 0,
  • "connectIpId": 2,
  • "connectPort": 1111,
  • "connectTransport": "TCP",
  • "connectTlsProfileId": 0,
  • "mediaGatewayId": 1,
  • "mediaGatewayControllerId": 2,
  • "listenMediaInterfaceId": 1,
  • "connectMediaInterfaceId": 2,
  • "h248ProfileId": 1
}

Response samples

Content type
application/json
{
  • "relayId": 1,
  • "relayName": "H248-relay-1",
  • "listenIpId": 1,
  • "listenPort": 1111,
  • "listenTransport": "TCP",
  • "listenTlsProfileId": 0,
  • "connectIpId": 2,
  • "connectPort": 1111,
  • "connectTransport": "TCP",
  • "connectTlsProfileId": 0,
  • "mediaGatewayId": 1,
  • "mediaGatewayControllerId": 2,
  • "listenMediaInterfaceId": 1,
  • "connectMediaInterfaceId": 2,
  • "h248ProfileId": 1
}

Get the H.248 Relay for given ID

Get the H.248 Relay for given ID

User must have the h248-relay:read capability to perform this action.

path Parameters
relayId
required
integer

ID of the H.248 Relay.

Responses

Response samples

Content type
application/json
{
  • "relayId": 1,
  • "relayName": "H248-relay-1",
  • "listenIpId": 1,
  • "listenPort": 1111,
  • "listenTransport": "TCP",
  • "listenTlsProfileId": 0,
  • "connectIpId": 2,
  • "connectPort": 1111,
  • "connectTransport": "TCP",
  • "connectTlsProfileId": 0,
  • "mediaGatewayId": 1,
  • "mediaGatewayControllerId": 2,
  • "listenMediaInterfaceId": 1,
  • "connectMediaInterfaceId": 2,
  • "h248ProfileId": 1
}

Delete the H.248 Relay for given ID

Delete the H.248 Relay for given ID

User must have the h248-relay:delete capability to perform this action.

path Parameters
relayId
required
integer

ID of the H.248 Relay.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

IP / URI Blocklist

APIs for managing IP / URI Blocklist Entries

Get all IP / URI Blocklist entries

Retrieve all IP / URI Blocklist entries from this system.

User must have the ip-uri-blocklist:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add new IP / URI Blocklist entry

Add a new IP / URI Blocklist entry to this system.

User must have the ip-uri-blocklist:create capability to perform this action.

Request Body schema: application/json
One of
address
required
string <IP>

An IPv4 address, IPv4 CIDR address, IPv6 address, or IPv6 CIDR address to block.

durationInMinutes
integer

The block duration, in minutes. If unspecified, the block will be permanent.

Responses

Request samples

Content type
application/json
Example
{
  • "address": "10.0.0.1",
  • "durationInMinutes": 1440
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uri": "string",
  • "address": "string",
  • "blockTime": "string",
  • "expireTime": "string",
  • "resourcePath": "/api/config/v1/ip-uri-blocklist/00000000-0000-0000-0000-000000000000"
}

Get IP / URI Blocklist entry

Get an existing IP / URI Blocklist entry from this system.

User must have the ip-uri-blocklist:read capability to perform this action.

path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uri": "string",
  • "address": "string",
  • "blockTime": "string",
  • "expireTime": "string"
}

Delete IP / URI Blocklist entry

Delete an existing IP / URI Blocklist entry from this system.

User must have the ip-uri-blocklist:delete capability to perform this action.

path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

IP / URI Blocklist Profile

APIs for managing IP / URI Blocklist Configuration

Get all IP / URI Blocklist profiles

Get all IP / URI Blocklist profiles from this system.

User must have the ip-uri-blocklist-profile:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new IP / URI Blocklist profile

Add a new IP / URI Blocklist profile to this system.

User must have the ip-uri-blocklist-profile:create capability to perform this action.

Request Body schema: application/json
name
string
ipUsernameBlockThreshold
integer
ipPasswordBlockThreshold
integer
uriUsernameBlockThreshold
integer
uriPasswordBlockThreshold
integer
blockTimer
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ipUsernameBlockThreshold": 0,
  • "ipPasswordBlockThreshold": 0,
  • "uriUsernameBlockThreshold": 0,
  • "uriPasswordBlockThreshold": 0,
  • "blockTimer": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ipUsernameBlockThreshold": 0,
  • "ipPasswordBlockThreshold": 0,
  • "uriUsernameBlockThreshold": 0,
  • "uriPasswordBlockThreshold": 0,
  • "blockTimer": 0,
  • "id": 0,
  • "resourcePath": "/api/config/v1/ip-uri-blocklist-profiles/1"
}

Get a specific IP / URI Blocklist profile

Get a specific IP / URI Blocklist profile from this system.

User must have the ip-uri-blocklist-profile:read capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "ipUsernameBlockThreshold": 0,
  • "ipPasswordBlockThreshold": 0,
  • "uriUsernameBlockThreshold": 0,
  • "uriPasswordBlockThreshold": 0,
  • "blockTimer": 0,
  • "id": 0
}

Modify an existing IP / URI Blocklist profile

Modify an existing IP / URI Blocklist profile on this system.

User must have the ip-uri-blocklist-profile:update capability to perform this action.

path Parameters
id
required
number
Request Body schema: application/json
name
string
ipUsernameBlockThreshold
integer
ipPasswordBlockThreshold
integer
uriUsernameBlockThreshold
integer
uriPasswordBlockThreshold
integer
blockTimer
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ipUsernameBlockThreshold": 0,
  • "ipPasswordBlockThreshold": 0,
  • "uriUsernameBlockThreshold": 0,
  • "uriPasswordBlockThreshold": 0,
  • "blockTimer": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ipUsernameBlockThreshold": 0,
  • "ipPasswordBlockThreshold": 0,
  • "uriUsernameBlockThreshold": 0,
  • "uriPasswordBlockThreshold": 0,
  • "blockTimer": 0,
  • "id": 0
}

Delete an existing IP / URI Blocklist profile

Delete an existing IP / URI Blocklist profile from this system.

User must have the ip-uri-blocklist-profile:delete capability to perform this action.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Feature Control

APIs for managing optional features

Show status of optional features

Show the status of all configurable optional features on this system.

User must have the feature-control:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "transrating": true,
  • "mediaTunneling": true,
  • "transcoding": true,
  • "amsOffloading": true
}

Toggle status of optional features

Toggle the status of any configurable optional features on this system.

User must have the feature-control:update capability to perform this action.

Request Body schema: application/json
transrating
boolean
mediaTunneling
boolean
transcoding
boolean
amsOffloading
boolean

Responses

Request samples

Content type
application/json
{
  • "transrating": true,
  • "mediaTunneling": true,
  • "transcoding": true,
  • "amsOffloading": true
}

Response samples

Content type
application/json
{
  • "transrating": true,
  • "mediaTunneling": true,
  • "transcoding": true,
  • "amsOffloading": true
}