Versions Compared

Old Version 4

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 5

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

REST API Method: POST /rest/mediacryptoprofile/{identifier}

mediacryptoprofile - REST API Methods
Page Tree
rootResource - mediacryptoprofile

Modifies a Media Crypto Profile Table given a specific Table ID.

URL:

https://134.56.227.163/rest/mediacryptoprofile/{identifier}

HTTP Method

POST

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max LengthDescribes this Media Crypto Profile so that it is easily identifiable.
OperationOptionNoNoEnum1Possible values:
  • 0 - soUnknown
  • 1 - soRequired
  • 2 - soOptional
  • 3 - soOff
 Specifies how encryption is supported for this profile.
  • Required
    - This setting permits call connections only if security (encryption) can be used for the call.
    • If the peer device does not support SRTP (Secure Real Time Protocol) for voice encryption over the IP network, call setup will fail.
  • Supported
    - This setting advertises to the peer device that the Sonus SBC 1000/2000 system implements SRTP. However, a call connection is allowed in secure or unsecure mode depending on the peer preference and capability.
  • Off
    - This setting disables the use of SRTP for encrypted calling.
CryptoSuiteNoNoEnum1Possible values:
  • 0 - scsCryptoSuite_32
  • 1 - scsCryptoSuite_80
This setting lets you configure the crypto suite that the Sonus SBC 1000/2000 should use to negotiate with its peer device.
MasterKeyLifeValueNoNoint31Possible values:
  • 0 - Minimum
  • 48 - Maximum
 The lifetime for the Master Key. The configured value is as power of 2.
Info

When this option is set to 0 means it never expires. Other wise it can take values from 1 to 48

MasterKeyIdentifierLengthNoNoint1Possible values:
  • 0 - Minimum
  • 4 - Maximum
The number of bytes that should be used for communicating the Master Key Identifier in the SRTP packets.
SessionKeyDerivationRateNoNoint0Possible values:
  • 0 - Minimum
  • 24 - Maximum
 The rate at which the session key should be refreshed during the SRTP session. The configured value is as power of 2. A value of 0 means that the session key will not be refreshed during the call.
Info

This option is available when *Derive Session Key is Set* to a range 16 to 24.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource