1. REST API for Oracle Cloud Native Session Border Controller, Release 1.25.1
  2. Tasks
  3. Configuration Management: Client

Retrieve all config elements: SD.sip-manipulation

get

https://cloud-native-SBC-IP/config/v1/sd/sip-manipulation

Retrieve all config elements: SD.sip-manipulation

Request

Query Parameters
  • Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

return all config elements: SipManipulation
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : schema
Type: object
configure SIP manipulations
Show Source
Nested Schema : SipManipOrderEntry
Type: object
order of sip manipulation rules
Show Source
Nested Schema : header-rules
Type: array
list of header rules
Show Source
Nested Schema : join-headers
Type: array
Unique Items Required: true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : mime-isup-rules
Type: array
list of mime isup rules
Show Source
Nested Schema : mime-rules
Type: array
list of mime rules
Show Source
Nested Schema : mime-sdp-rules
Type: array
list of mime sdp rules
Show Source
Nested Schema : split-headers
Type: array
Unique Items Required: true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : rules-order
Type: array
list of header,mime,mime-isup and mime-sdp rules
Show Source
Nested Schema : SipHdrRule
Type: object
list of header rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • element-rules
    list of element-rules
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    header name for which rule needs to be applied
  • value to match against the current object. To clear the match-value, enter an empty string
  • methods
    Unique Items Required: true
    specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
  • Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : element-rules
Type: array
list of element-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : SipElemRule
Type: object
list of element-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete-element", "delete-header", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Allowed Values: [ "any", "ip", "fqdn" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • element param name for which rule needs to be applied
  • Allowed Values: [ "none", "header-value", "header-param", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "teluri-param", "uri-display", "uri-param-name", "uri-header-name", "header-param-name", "status-code", "reason-phrase", "mime", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : MimeIsupRule
Type: object
list of mime isup rules
Show Source
Nested Schema : isup-msg-types
Type: array
Unique Items Required: true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM
Show Source
Nested Schema : isup-param-rules
Type: array
list of isup-param-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : rules-order
Type: array
list of mime-header and isup-param rules
Show Source
Nested Schema : IsupParamRule
Type: object
list of isup-param-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Allowed Values: [ "raw-binary", "hex-ascii", "bcd", "binary-ascii", "ascii-string", "number-param" ]
  • value to match against the current object. To clear the match-value, update with an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. To clear the newValue, update with an empty string
  • Pattern: ^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\[([*^]|[0-9]+)\])?$
    parameter type specifying which part of the isup body will be manipulated
Nested Schema : MimeHeaderRule
Type: object
list of mime-header-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : MimeRule
Type: object
list of mime rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Pattern: ^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
    Content-Type header for which rule needs to be applied
  • Allowed Values: [ "ascii-string", "hex-ascii", "binary-ascii" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • methods
    Unique Items Required: true
    specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
  • mime-header-rules
    list of mime-header-rules
  • Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes(e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : MimeSdpRule
Type: object
list of mime sdp rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : rules-order
Type: array
list of mime-header ,sdp-session and sdp-media rules
Show Source
Nested Schema : sdp-media-rules
Type: array
list of sdp-media-rules
Show Source
Nested Schema : sdp-session-rules
Type: array
list of sdp-session-rules
Show Source
Nested Schema : SdpMediaRule
Type: object
list of sdp-media-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    media type to manipulate (e.g. audio, video, etc.)
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • sdp-line-rules
    list of sdp-line-rules
Nested Schema : sdp-line-rules
Type: array
list of sdp-line-rules
Show Source
Nested Schema : SdpLineRule
Type: object
list of sdp-line-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • Pattern: ^[A-Za-z](\[(([0-9]+)|([*^]))\])?$
    descriptor type specifying which line of the sdp will be manipulated
Nested Schema : SdpSessionRule
Type: object
list of sdp-session-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • sdp-line-rules
    list of sdp-line-rules
Nested Schema : sdp-line-rules
Type: array
list of sdp-line-rules
Show Source

404 Response

Not Found
Body ()
Root Schema : ApiValidationError
Type: object
Show Source
Nested Schema : errors
Type: array
Show Source
Nested Schema : Errors
Type: object
Show Source
Back to Top