Jump to

• Request
• Response

Replace a config element: SD.sip-interface

put

https://cloud-native-SBC-IP/config/v1/sd/sip-interface/{ElementKey}

Replace a config element: SD.sip-interface

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure SIP interfaces

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• add-sdp-in-msg: array add-sdp-in-msg
  Insert SDP in sip message
• add-sdp-invite: string
  Allowed Values: [ "disabled", "invite", "reinvite", "both" ]
• add-sdp-profiles: array add-sdp-profiles
  list of media profiles
• add-sdp-profiles-in-msg: array add-sdp-profiles-in-msg
  list of media profiles
• anonymous-priority: string
  Allowed Values: [ "none", "normal", "non-urgent", "urgent", "emergency" ]
• asymmetric-preconditions: boolean
  Enable/disable asymmetric preconditions
• asymmetric-preconditions-mode: string
  Allowed Values: [ "send-with-nodelay", "send-with-delay" ]
• carriers: array carriers
  list of carriers
• ccf-address: string
  ccf_address to be used for p-charging-function-address
• charging-function-address-mode: string
  Allowed Values: [ "none", "pass", "delete", "insert", "insert-reg-cache", "delete-and-respond", "conditional-insert" ]
• charging-vector-mode: string
  Allowed Values: [ "none", "pass", "delete", "insert", "delete-and-respond", "conditional-insert" ]
• constraint-name: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the constraint
• contact-mode: string
  Allowed Values: [ "none", "maddr", "loose-route", "strict-route" ]
• description: string
  sip interface description
• diversion-info-mapping-mode: string
  Allowed Values: [ "none", "hist2div", "div2hist", "force" ]
• ecf-address: string
  ecf_address to be used for p-charging-function-address
• enforcement-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of enforcement profile
• hist-to-div-for-cause-380: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• in-manipulationid: string
  inbound SIP manipulation rule name
• inactive-conn-timeout: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  timeout for idle TCP/TLS connections (0 disables) (seconds)
• initial-inv-trans-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Transaction expiration time <TIMER_B> for initial INVITE. 0 = Fall back to sip-config initial-inv-trans-expire
• invite-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  INVITE transaction expiration timer (TIMER_C) (seconds)
• kpml-interworking: boolean
  kpml-interworking
• kpml2833-iwf-on-hairpin: boolean
  To enable kpml-2833 interworking on hairpin
• ldap-policy-server: string
  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the ldap policy server
• local-response-map: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of local response map
• manipulation-pattern: string
  regular expression that can be used in header manipulation rules
• manipulation-string: string
  string that can be used in header manipulation rules
• max-incoming-conns: integer (int64)
  Minimum Value: 0

  Maximum Value: 20000

  Maximum number of TCP/TLS connections for this sip interface.Upper limit constrained by system limit.
• max-nat-interval: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  NAT Traversal Max registration interval (seconds) (max expires value in SD's REGISTER response)
• max-redirect-contacts: integer (int64)
  Minimum Value: 0

  Maximum Value: 10

  maximum number of contacts/routes attempts in case of redirects
• min-reg-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Minimum REGISTER expire time (seconds)
• nat-int-increment: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  NAT Traversal registration interval increment (seconds) (increment in expires value in SD's REGISTER response)
• nat-test-increment: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  NAT Traversal test interval increment (seconds) (dynamic hnt test increment value)
• nat-traversal: string
  Allowed Values: [ "none", "rport", "always" ]
• network-id: string
  network identifier
• operator-identifier: string
  Pattern: ^$|^[T][y][p][e][\s][1,3][A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  operator identifier
• options: string
  optional features/parameters
• out-manipulationid: string
  outbound SIP manipulation rule name
• p-early-media-direction: array p-early-media-direction
  Configure early-media-direction parameter for P-Early-Media header
• p-early-media-header: string
  Allowed Values: [ "disabled", "add", "modify", "support" ]
• per-src-ip-max-incoming-conns: integer (int64)
  Minimum Value: 0

  Maximum Value: 20000

  Maximum number of TCP/TLS connections per peer IP address (0 disables).
• port-map-end: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port map ending port, 0 to disable
• port-map-start: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port map starting port, 0 to disable
• proxy-mode: string
  Allowed Values: [ "Stateless", "Proxy", "Redirect", "Record-Route" ]
• realm-id(required): string
  Minimum Length: 1

  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  realm identifier
• redirect-action: string
  Allowed Values: [ "Proxy", "Recurse", "Recurse-305-only" ]
• refer-call-transfer: string
  Allowed Values: [ "disabled", "enabled", "dynamic" ]
• registration-caching: boolean
  This attribute is unsupported
• registration-interval: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  This attribute is unsupported
• response-map: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of response map
• rfc2833-mode: string
  Allowed Values: [ "transparent", "preferred", "dual" ]
• rfc2833-payload: integer (int32)
  Minimum Value: 96

  Maximum Value: 127

  payload type used by the SipInterface in preferred rfc2833-mode (128>x>95)
• route-to-registrar: boolean
  This attribute is unsupported
• route-unauthorized-calls: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^.*$

  name of SA or SAG to route unauthorized calls
• sec-agree-feature: boolean
  enable sec-agree feature
• sec-agree-pref: string
  Allowed Values: [ "ipsec3gpp", "tls", "ipsec3gpp-tls", "tls-ipsec3gpp" ]
• secured-network: boolean
  send messages on unsecured transport
• service-tag: string
  service tag
• session-max-life-limit: integer (int64)
  Minimum Value: 1

  Maximum Value: 2073600

  maximum life limit a SIP session can stay active (secs). Range 1-2073600.
• session-timer-profile: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the session timer profile
• sip-dynamic-hnt: boolean
  sip-dynamic-hnt
• sip-isup-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the sip-isup profile
• sip-ports: array sip-ports
  list of SIP ports
• sip-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the sip profile
• sip-recursion-policy: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  SIP Recursion Policy
• spl-options: string
  optional features/parameters
• state: boolean
  administrative state
• sti-as: array sti-as
  group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
• sti-attest: string
  Pattern: ^$|^[A-C]$

  Attestation Values can be either A, B, C or Empty. A: Full Attestation, B: Partial Attestation, C: Gateway Attestation
• sti-orig-id: string
  Pattern: ^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

  UUID4 added to STI-AS requests, if not already present. Leave empty to pick up the UUID from the upstream config object
• sti-signaling-attest: boolean
  Retrieve attestation value and OrigId from SIP headers, when present. Attestation-Info: attest [A/B/C] Origination-ID: origId [UUID]
• sti-vs: array sti-vs
  group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
• stop-recurse: string
  Pattern: ^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$

  Response codes that stop recursion of targets/contacts
• tcp-keepalive: string
  Allowed Values: [ "none", "enabled", "disabled" ]
• teluri-scheme: boolean
  use tel uri scheme
• term-tgrp-mode: string
  Allowed Values: [ "none", "iptel", "egress-uri" ]
• trans-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  transaction expiration timer (TIMER_B,D,F,H,J) (seconds)
• trust-mode: string
  Allowed Values: [ "all", "agents-only", "realm-prefix", "registered", "none" ]
• untrusted-conn-timeout: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  timeout (seconds) for untrusted endpoints on TCP/TLS connections.
• uri-fqdn-domain: string
  FQDN domain name
• user-agent: string
  user-agent string to be added to SIP User-Agent header

{
    "required":[
        "realm-id"
    ],
    "properties":{
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "realm-id":{
            "description":"realm identifier",
            "minLength":1,
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"sip interface description",
            "type":"string"
        },
        "sip-ports":{
            "description":"list of SIP ports",
            "items":{
                "$ref":"#/components/schemas/SipPort"
            },
            "type":"array"
        },
        "carriers":{
            "description":"list of carriers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "trans-expire":{
            "description":"transaction expiration timer (TIMER_B,D,F,H,J) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "initial-inv-trans-expire":{
            "description":"Transaction expiration time <TIMER_B> for initial INVITE. 0 = Fall back to sip-config initial-inv-trans-expire",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "invite-expire":{
            "description":"INVITE transaction expiration timer (TIMER_C) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "session-max-life-limit":{
            "description":"maximum life limit a SIP session can stay active (secs). Range 1-2073600.",
            "format":"int64",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "max-redirect-contacts":{
            "description":"maximum number of contacts/routes attempts in case of redirects",
            "format":"int64",
            "maximum":10,
            "minimum":0,
            "type":"integer"
        },
        "proxy-mode":{
            "$ref":"#/components/schemas/ProxyModeConstraintEnum"
        },
        "redirect-action":{
            "$ref":"#/components/schemas/SipRedirectActionEnum"
        },
        "contact-mode":{
            "$ref":"#/components/schemas/SipContactEnum"
        },
        "nat-traversal":{
            "$ref":"#/components/schemas/SipNatTraversalModeEnum"
        },
        "registration-caching":{
            "description":"This attribute is unsupported",
            "type":"boolean"
        },
        "min-reg-expire":{
            "description":"Minimum REGISTER expire time (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "registration-interval":{
            "description":"This attribute is unsupported",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "route-to-registrar":{
            "description":"This attribute is unsupported",
            "type":"boolean"
        },
        "secured-network":{
            "description":"send messages on unsecured transport",
            "type":"boolean"
        },
        "teluri-scheme":{
            "description":"use tel uri scheme",
            "type":"boolean"
        },
        "uri-fqdn-domain":{
            "description":"FQDN domain name",
            "type":"string"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "spl-options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "trust-mode":{
            "$ref":"#/components/schemas/TrustModeEnum"
        },
        "max-nat-interval":{
            "description":"NAT Traversal Max registration interval (seconds) (max expires value in SD's REGISTER response)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "nat-int-increment":{
            "description":"NAT Traversal registration interval increment (seconds) (increment in expires value in SD's REGISTER response)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "nat-test-increment":{
            "description":"NAT Traversal test interval increment (seconds) (dynamic hnt test increment value)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "sip-dynamic-hnt":{
            "description":"sip-dynamic-hnt",
            "type":"boolean"
        },
        "stop-recurse":{
            "description":"Response codes that stop recursion of targets/contacts",
            "pattern":"^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$",
            "type":"string"
        },
        "port-map-start":{
            "description":"port map starting port, 0 to disable",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "port-map-end":{
            "description":"port map ending port, 0 to disable",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "in-manipulationid":{
            "description":"inbound SIP manipulation rule name",
            "type":"string"
        },
        "out-manipulationid":{
            "description":"outbound SIP manipulation rule name",
            "type":"string"
        },
        "operator-identifier":{
            "description":"operator identifier",
            "pattern":"^$|^[T][y][p][e][\\s][1,3][A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "anonymous-priority":{
            "$ref":"#/components/schemas/AnonymousPriorityEnum"
        },
        "max-incoming-conns":{
            "description":"Maximum number of TCP/TLS connections for this sip interface.Upper limit constrained by system limit.",
            "format":"int64",
            "maximum":20000,
            "minimum":0,
            "type":"integer"
        },
        "per-src-ip-max-incoming-conns":{
            "description":"Maximum number of TCP/TLS connections per peer IP address (0 disables).",
            "format":"int64",
            "maximum":20000,
            "minimum":0,
            "type":"integer"
        },
        "inactive-conn-timeout":{
            "description":"timeout for idle TCP/TLS connections (0 disables) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "untrusted-conn-timeout":{
            "description":"timeout (seconds) for untrusted endpoints on TCP/TLS connections.",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "network-id":{
            "description":"network identifier",
            "type":"string"
        },
        "ldap-policy-server":{
            "description":"name of the ldap policy server",
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "term-tgrp-mode":{
            "$ref":"#/components/schemas/TermTgrpModeEnum"
        },
        "charging-vector-mode":{
            "$ref":"#/components/schemas/ChrgVectorModeConstraintEnum"
        },
        "charging-function-address-mode":{
            "$ref":"#/components/schemas/ChrgHdrModeEnum"
        },
        "ccf-address":{
            "description":"ccf_address to be used for p-charging-function-address",
            "type":"string"
        },
        "ecf-address":{
            "description":"ecf_address to be used for p-charging-function-address",
            "type":"string"
        },
        "rfc2833-payload":{
            "description":"payload type used by the SipInterface in preferred rfc2833-mode (128>x>95)",
            "format":"int32",
            "maximum":127,
            "minimum":96,
            "type":"integer"
        },
        "rfc2833-mode":{
            "$ref":"#/components/schemas/Rfc2833ModeSIEnum"
        },
        "constraint-name":{
            "description":"name of the constraint",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "response-map":{
            "description":"name of response map",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "local-response-map":{
            "description":"name of local response map",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "sec-agree-feature":{
            "description":"enable sec-agree feature",
            "type":"boolean"
        },
        "sec-agree-pref":{
            "$ref":"#/components/schemas/SecAgreePreferenceEnum"
        },
        "enforcement-profile":{
            "description":"name of enforcement profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "refer-call-transfer":{
            "$ref":"#/components/schemas/ReferTransferModeEnum"
        },
        "route-unauthorized-calls":{
            "description":"name of SA or SAG to route unauthorized calls",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^.*$",
            "type":"string"
        },
        "tcp-keepalive":{
            "$ref":"#/components/schemas/SockTcpKeepaliveEnum"
        },
        "add-sdp-invite":{
            "$ref":"#/components/schemas/InsertSdpModeEnum"
        },
        "add-sdp-in-msg":{
            "description":"Insert SDP in sip message",
            "items":{
                "$ref":"#/components/schemas/SdpInsertionConstraintEnum"
            },
            "type":"array"
        },
        "p-early-media-header":{
            "$ref":"#/components/schemas/PEarlyMediaHeaderEnum"
        },
        "p-early-media-direction":{
            "description":"Configure early-media-direction parameter for P-Early-Media header",
            "items":{
                "$ref":"#/components/schemas/PEarlyMediaDirectionEnum"
            },
            "type":"array"
        },
        "add-sdp-profiles":{
            "description":"list of media profiles",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "add-sdp-profiles-in-msg":{
            "description":"list of media profiles",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "manipulation-string":{
            "description":"string that can be used in header manipulation rules",
            "type":"string"
        },
        "manipulation-pattern":{
            "description":"regular expression that can be used in header manipulation rules",
            "type":"string"
        },
        "sip-profile":{
            "description":"name of the sip profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "sip-isup-profile":{
            "description":"name of the sip-isup profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "kpml-interworking":{
            "description":"kpml-interworking",
            "type":"boolean"
        },
        "kpml2833-iwf-on-hairpin":{
            "description":"To enable kpml-2833 interworking on hairpin",
            "type":"boolean"
        },
        "session-timer-profile":{
            "description":"name of the session timer profile",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "service-tag":{
            "description":"service tag",
            "type":"string"
        },
        "diversion-info-mapping-mode":{
            "$ref":"#/components/schemas/DivInfoMappingModeEnum"
        },
        "sip-recursion-policy":{
            "description":"SIP Recursion Policy",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "asymmetric-preconditions":{
            "description":"Enable/disable asymmetric preconditions",
            "type":"boolean"
        },
        "asymmetric-preconditions-mode":{
            "$ref":"#/components/schemas/PreconditionsModeEnum"
        },
        "hist-to-div-for-cause-380":{
            "$ref":"#/components/schemas/HIDivFeatureConfigModeEnum"
        },
        "user-agent":{
            "description":"user-agent string to be added to SIP User-Agent header",
            "type":"string"
        },
        "sti-as":{
            "description":"group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sti-vs":{
            "description":"group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sti-orig-id":{
            "description":"UUID4 added to STI-AS requests, if not already present. Leave empty to pick up the UUID from the upstream config object",
            "pattern":"^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
            "type":"string"
        },
        "sti-attest":{
            "description":"Attestation Values can be either A, B, C or Empty. A: Full Attestation, B: Partial Attestation, C: Gateway Attestation",
            "pattern":"^$|^[A-C]$",
            "type":"string"
        },
        "sti-signaling-attest":{
            "description":"Retrieve attestation value and OrigId from SIP headers, when present. Attestation-Info: attest [A/B/C] Origination-ID: origId [UUID]",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SIP interfaces",
    "type":"object"
}

Nested Schema : add-sdp-in-msg

Type: array

Insert SDP in sip message

Show Source

• Array of: string
  Allowed Values: [ "18xresp" ]

{
    "description":"Insert SDP in sip message",
    "items":{
        "$ref":"#/components/schemas/SdpInsertionConstraintEnum"
    },
    "type":"array"
}

Nested Schema : add-sdp-profiles

Type: array

list of media profiles

Show Source

• Array of: string

{
    "description":"list of media profiles",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : add-sdp-profiles-in-msg

Type: array

list of media profiles

Show Source

• Array of: string

{
    "description":"list of media profiles",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : carriers

Type: array

list of carriers

Show Source

• Array of: string

{
    "description":"list of carriers",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : p-early-media-direction

Type: array

Configure early-media-direction parameter for P-Early-Media header

Show Source

• Array of: string
  Allowed Values: [ "sendrecv", "sendonly", "recvonly", "inactive" ]

{
    "description":"Configure early-media-direction parameter for P-Early-Media header",
    "items":{
        "$ref":"#/components/schemas/PEarlyMediaDirectionEnum"
    },
    "type":"array"
}

Nested Schema : sip-ports

Type: array

list of SIP ports

Show Source

• Array of: object SipPort
  list of sip-ports

{
    "description":"list of SIP ports",
    "items":{
        "$ref":"#/components/schemas/SipPort"
    },
    "type":"array"
}

Nested Schema : sti-as

Type: array

group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)

Show Source

• Array of: string

{
    "description":"group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : sti-vs

Type: array

group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)

Show Source

• Array of: string

{
    "description":"group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : SipPort

Type: object

list of sip-ports

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• address(required): string
  Minimum Length: 1

  Pattern: ^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^(?:[1-9a-fA-F]{1,4}:){7}[1-9a-fA-F]{1,4}$|^(\:\:)?[1-9a-fA-F]{1,4}(\:\:?[0-9a-fA-F]{1,4}){0,7}(\:\:)?$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.|$)){4})$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|[0-9a-fA-F]{0,4}(\:[0-9a-fA-F]{0,4}){0,5}(::?)|[0-9a-fA-F]{1,4}|6[0-5]{2}[0-4]\d|6[0-4]{2}\d{2}|6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]{2}\d{3})$

  IP Address
• allow-anonymous: string
  Allowed Values: [ "all", "agents-only", "realm-prefix" ]
• port(required): integer (int32)
  Minimum Value: 1

  Maximum Value: 65535

  port
• tls-profile: string
  tls profile name
• transport-protocol(required): string
  Allowed Values: [ "UDP", "TCP", "TLS", "SCTP" ]

{
    "required":[
        "address",
        "port",
        "transport-protocol"
    ],
    "properties":{
        "address":{
            "description":"IP Address",
            "minLength":1,
            "pattern":"^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(\\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^\\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\\]?(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^(?:[1-9a-fA-F]{1,4}:){7}[1-9a-fA-F]{1,4}$|^(\\:\\:)?[1-9a-fA-F]{1,4}(\\:\\:?[0-9a-fA-F]{1,4}){0,7}(\\:\\:)?$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.|$)){4})$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|[0-9a-fA-F]{0,4}(\\:[0-9a-fA-F]{0,4}){0,5}(::?)|[0-9a-fA-F]{1,4}|6[0-5]{2}[0-4]\\d|6[0-4]{2}\\d{2}|6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]{2}\\d{3})$",
            "type":"string"
        },
        "port":{
            "description":"port",
            "format":"int32",
            "maximum":65535,
            "minimum":1,
            "type":"integer"
        },
        "transport-protocol":{
            "$ref":"#/components/schemas/TransProtocolConstraintEnum"
        },
        "tls-profile":{
            "description":"tls profile name",
            "type":"string"
        },
        "allow-anonymous":{
            "$ref":"#/components/schemas/AnonModeEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of sip-ports",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SipInterface

Body ()

Root Schema : schema

Type: object

configure SIP interfaces

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• add-sdp-in-msg: array add-sdp-in-msg
  Insert SDP in sip message
• add-sdp-invite: string
  Allowed Values: [ "disabled", "invite", "reinvite", "both" ]
• add-sdp-profiles: array add-sdp-profiles
  list of media profiles
• add-sdp-profiles-in-msg: array add-sdp-profiles-in-msg
  list of media profiles
• anonymous-priority: string
  Allowed Values: [ "none", "normal", "non-urgent", "urgent", "emergency" ]
• asymmetric-preconditions: boolean
  Enable/disable asymmetric preconditions
• asymmetric-preconditions-mode: string
  Allowed Values: [ "send-with-nodelay", "send-with-delay" ]
• carriers: array carriers
  list of carriers
• ccf-address: string
  ccf_address to be used for p-charging-function-address
• charging-function-address-mode: string
  Allowed Values: [ "none", "pass", "delete", "insert", "insert-reg-cache", "delete-and-respond", "conditional-insert" ]
• charging-vector-mode: string
  Allowed Values: [ "none", "pass", "delete", "insert", "delete-and-respond", "conditional-insert" ]
• constraint-name: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the constraint
• contact-mode: string
  Allowed Values: [ "none", "maddr", "loose-route", "strict-route" ]
• description: string
  sip interface description
• diversion-info-mapping-mode: string
  Allowed Values: [ "none", "hist2div", "div2hist", "force" ]
• ecf-address: string
  ecf_address to be used for p-charging-function-address
• enforcement-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of enforcement profile
• hist-to-div-for-cause-380: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• in-manipulationid: string
  inbound SIP manipulation rule name
• inactive-conn-timeout: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  timeout for idle TCP/TLS connections (0 disables) (seconds)
• initial-inv-trans-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Transaction expiration time <TIMER_B> for initial INVITE. 0 = Fall back to sip-config initial-inv-trans-expire
• invite-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  INVITE transaction expiration timer (TIMER_C) (seconds)
• kpml-interworking: boolean
  kpml-interworking
• kpml2833-iwf-on-hairpin: boolean
  To enable kpml-2833 interworking on hairpin
• ldap-policy-server: string
  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the ldap policy server
• local-response-map: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of local response map
• manipulation-pattern: string
  regular expression that can be used in header manipulation rules
• manipulation-string: string
  string that can be used in header manipulation rules
• max-incoming-conns: integer (int64)
  Minimum Value: 0

  Maximum Value: 20000

  Maximum number of TCP/TLS connections for this sip interface.Upper limit constrained by system limit.
• max-nat-interval: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  NAT Traversal Max registration interval (seconds) (max expires value in SD's REGISTER response)
• max-redirect-contacts: integer (int64)
  Minimum Value: 0

  Maximum Value: 10

  maximum number of contacts/routes attempts in case of redirects
• min-reg-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Minimum REGISTER expire time (seconds)
• nat-int-increment: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  NAT Traversal registration interval increment (seconds) (increment in expires value in SD's REGISTER response)
• nat-test-increment: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  NAT Traversal test interval increment (seconds) (dynamic hnt test increment value)
• nat-traversal: string
  Allowed Values: [ "none", "rport", "always" ]
• network-id: string
  network identifier
• operator-identifier: string
  Pattern: ^$|^[T][y][p][e][\s][1,3][A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  operator identifier
• options: string
  optional features/parameters
• out-manipulationid: string
  outbound SIP manipulation rule name
• p-early-media-direction: array p-early-media-direction
  Configure early-media-direction parameter for P-Early-Media header
• p-early-media-header: string
  Allowed Values: [ "disabled", "add", "modify", "support" ]
• per-src-ip-max-incoming-conns: integer (int64)
  Minimum Value: 0

  Maximum Value: 20000

  Maximum number of TCP/TLS connections per peer IP address (0 disables).
• port-map-end: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port map ending port, 0 to disable
• port-map-start: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port map starting port, 0 to disable
• proxy-mode: string
  Allowed Values: [ "Stateless", "Proxy", "Redirect", "Record-Route" ]
• realm-id(required): string
  Minimum Length: 1

  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  realm identifier
• redirect-action: string
  Allowed Values: [ "Proxy", "Recurse", "Recurse-305-only" ]
• refer-call-transfer: string
  Allowed Values: [ "disabled", "enabled", "dynamic" ]
• registration-caching: boolean
  This attribute is unsupported
• registration-interval: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  This attribute is unsupported
• response-map: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of response map
• rfc2833-mode: string
  Allowed Values: [ "transparent", "preferred", "dual" ]
• rfc2833-payload: integer (int32)
  Minimum Value: 96

  Maximum Value: 127

  payload type used by the SipInterface in preferred rfc2833-mode (128>x>95)
• route-to-registrar: boolean
  This attribute is unsupported
• route-unauthorized-calls: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^.*$

  name of SA or SAG to route unauthorized calls
• sec-agree-feature: boolean
  enable sec-agree feature
• sec-agree-pref: string
  Allowed Values: [ "ipsec3gpp", "tls", "ipsec3gpp-tls", "tls-ipsec3gpp" ]
• secured-network: boolean
  send messages on unsecured transport
• service-tag: string
  service tag
• session-max-life-limit: integer (int64)
  Minimum Value: 1

  Maximum Value: 2073600

  maximum life limit a SIP session can stay active (secs). Range 1-2073600.
• session-timer-profile: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the session timer profile
• sip-dynamic-hnt: boolean
  sip-dynamic-hnt
• sip-isup-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the sip-isup profile
• sip-ports: array sip-ports
  list of SIP ports
• sip-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the sip profile
• sip-recursion-policy: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  SIP Recursion Policy
• spl-options: string
  optional features/parameters
• state: boolean
  administrative state
• sti-as: array sti-as
  group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
• sti-attest: string
  Pattern: ^$|^[A-C]$

  Attestation Values can be either A, B, C or Empty. A: Full Attestation, B: Partial Attestation, C: Gateway Attestation
• sti-orig-id: string
  Pattern: ^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

  UUID4 added to STI-AS requests, if not already present. Leave empty to pick up the UUID from the upstream config object
• sti-signaling-attest: boolean
  Retrieve attestation value and OrigId from SIP headers, when present. Attestation-Info: attest [A/B/C] Origination-ID: origId [UUID]
• sti-vs: array sti-vs
  group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
• stop-recurse: string
  Pattern: ^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$

  Response codes that stop recursion of targets/contacts
• tcp-keepalive: string
  Allowed Values: [ "none", "enabled", "disabled" ]
• teluri-scheme: boolean
  use tel uri scheme
• term-tgrp-mode: string
  Allowed Values: [ "none", "iptel", "egress-uri" ]
• trans-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  transaction expiration timer (TIMER_B,D,F,H,J) (seconds)
• trust-mode: string
  Allowed Values: [ "all", "agents-only", "realm-prefix", "registered", "none" ]
• untrusted-conn-timeout: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  timeout (seconds) for untrusted endpoints on TCP/TLS connections.
• uri-fqdn-domain: string
  FQDN domain name
• user-agent: string
  user-agent string to be added to SIP User-Agent header

{
    "required":[
        "realm-id"
    ],
    "properties":{
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "realm-id":{
            "description":"realm identifier",
            "minLength":1,
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"sip interface description",
            "type":"string"
        },
        "sip-ports":{
            "description":"list of SIP ports",
            "items":{
                "$ref":"#/components/schemas/SipPort"
            },
            "type":"array"
        },
        "carriers":{
            "description":"list of carriers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "trans-expire":{
            "description":"transaction expiration timer (TIMER_B,D,F,H,J) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "initial-inv-trans-expire":{
            "description":"Transaction expiration time <TIMER_B> for initial INVITE. 0 = Fall back to sip-config initial-inv-trans-expire",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "invite-expire":{
            "description":"INVITE transaction expiration timer (TIMER_C) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "session-max-life-limit":{
            "description":"maximum life limit a SIP session can stay active (secs). Range 1-2073600.",
            "format":"int64",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "max-redirect-contacts":{
            "description":"maximum number of contacts/routes attempts in case of redirects",
            "format":"int64",
            "maximum":10,
            "minimum":0,
            "type":"integer"
        },
        "proxy-mode":{
            "$ref":"#/components/schemas/ProxyModeConstraintEnum"
        },
        "redirect-action":{
            "$ref":"#/components/schemas/SipRedirectActionEnum"
        },
        "contact-mode":{
            "$ref":"#/components/schemas/SipContactEnum"
        },
        "nat-traversal":{
            "$ref":"#/components/schemas/SipNatTraversalModeEnum"
        },
        "registration-caching":{
            "description":"This attribute is unsupported",
            "type":"boolean"
        },
        "min-reg-expire":{
            "description":"Minimum REGISTER expire time (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "registration-interval":{
            "description":"This attribute is unsupported",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "route-to-registrar":{
            "description":"This attribute is unsupported",
            "type":"boolean"
        },
        "secured-network":{
            "description":"send messages on unsecured transport",
            "type":"boolean"
        },
        "teluri-scheme":{
            "description":"use tel uri scheme",
            "type":"boolean"
        },
        "uri-fqdn-domain":{
            "description":"FQDN domain name",
            "type":"string"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "spl-options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "trust-mode":{
            "$ref":"#/components/schemas/TrustModeEnum"
        },
        "max-nat-interval":{
            "description":"NAT Traversal Max registration interval (seconds) (max expires value in SD's REGISTER response)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "nat-int-increment":{
            "description":"NAT Traversal registration interval increment (seconds) (increment in expires value in SD's REGISTER response)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "nat-test-increment":{
            "description":"NAT Traversal test interval increment (seconds) (dynamic hnt test increment value)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "sip-dynamic-hnt":{
            "description":"sip-dynamic-hnt",
            "type":"boolean"
        },
        "stop-recurse":{
            "description":"Response codes that stop recursion of targets/contacts",
            "pattern":"^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$",
            "type":"string"
        },
        "port-map-start":{
            "description":"port map starting port, 0 to disable",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "port-map-end":{
            "description":"port map ending port, 0 to disable",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "in-manipulationid":{
            "description":"inbound SIP manipulation rule name",
            "type":"string"
        },
        "out-manipulationid":{
            "description":"outbound SIP manipulation rule name",
            "type":"string"
        },
        "operator-identifier":{
            "description":"operator identifier",
            "pattern":"^$|^[T][y][p][e][\\s][1,3][A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9.!%*_+`'~-]+$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "anonymous-priority":{
            "$ref":"#/components/schemas/AnonymousPriorityEnum"
        },
        "max-incoming-conns":{
            "description":"Maximum number of TCP/TLS connections for this sip interface.Upper limit constrained by system limit.",
            "format":"int64",
            "maximum":20000,
            "minimum":0,
            "type":"integer"
        },
        "per-src-ip-max-incoming-conns":{
            "description":"Maximum number of TCP/TLS connections per peer IP address (0 disables).",
            "format":"int64",
            "maximum":20000,
            "minimum":0,
            "type":"integer"
        },
        "inactive-conn-timeout":{
            "description":"timeout for idle TCP/TLS connections (0 disables) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "untrusted-conn-timeout":{
            "description":"timeout (seconds) for untrusted endpoints on TCP/TLS connections.",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "network-id":{
            "description":"network identifier",
            "type":"string"
        },
        "ldap-policy-server":{
            "description":"name of the ldap policy server",
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "term-tgrp-mode":{
            "$ref":"#/components/schemas/TermTgrpModeEnum"
        },
        "charging-vector-mode":{
            "$ref":"#/components/schemas/ChrgVectorModeConstraintEnum"
        },
        "charging-function-address-mode":{
            "$ref":"#/components/schemas/ChrgHdrModeEnum"
        },
        "ccf-address":{
            "description":"ccf_address to be used for p-charging-function-address",
            "type":"string"
        },
        "ecf-address":{
            "description":"ecf_address to be used for p-charging-function-address",
            "type":"string"
        },
        "rfc2833-payload":{
            "description":"payload type used by the SipInterface in preferred rfc2833-mode (128>x>95)",
            "format":"int32",
            "maximum":127,
            "minimum":96,
            "type":"integer"
        },
        "rfc2833-mode":{
            "$ref":"#/components/schemas/Rfc2833ModeSIEnum"
        },
        "constraint-name":{
            "description":"name of the constraint",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "response-map":{
            "description":"name of response map",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "local-response-map":{
            "description":"name of local response map",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "sec-agree-feature":{
            "description":"enable sec-agree feature",
            "type":"boolean"
        },
        "sec-agree-pref":{
            "$ref":"#/components/schemas/SecAgreePreferenceEnum"
        },
        "enforcement-profile":{
            "description":"name of enforcement profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "refer-call-transfer":{
            "$ref":"#/components/schemas/ReferTransferModeEnum"
        },
        "route-unauthorized-calls":{
            "description":"name of SA or SAG to route unauthorized calls",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^.*$",
            "type":"string"
        },
        "tcp-keepalive":{
            "$ref":"#/components/schemas/SockTcpKeepaliveEnum"
        },
        "add-sdp-invite":{
            "$ref":"#/components/schemas/InsertSdpModeEnum"
        },
        "add-sdp-in-msg":{
            "description":"Insert SDP in sip message",
            "items":{
                "$ref":"#/components/schemas/SdpInsertionConstraintEnum"
            },
            "type":"array"
        },
        "p-early-media-header":{
            "$ref":"#/components/schemas/PEarlyMediaHeaderEnum"
        },
        "p-early-media-direction":{
            "description":"Configure early-media-direction parameter for P-Early-Media header",
            "items":{
                "$ref":"#/components/schemas/PEarlyMediaDirectionEnum"
            },
            "type":"array"
        },
        "add-sdp-profiles":{
            "description":"list of media profiles",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "add-sdp-profiles-in-msg":{
            "description":"list of media profiles",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "manipulation-string":{
            "description":"string that can be used in header manipulation rules",
            "type":"string"
        },
        "manipulation-pattern":{
            "description":"regular expression that can be used in header manipulation rules",
            "type":"string"
        },
        "sip-profile":{
            "description":"name of the sip profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "sip-isup-profile":{
            "description":"name of the sip-isup profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "kpml-interworking":{
            "description":"kpml-interworking",
            "type":"boolean"
        },
        "kpml2833-iwf-on-hairpin":{
            "description":"To enable kpml-2833 interworking on hairpin",
            "type":"boolean"
        },
        "session-timer-profile":{
            "description":"name of the session timer profile",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "service-tag":{
            "description":"service tag",
            "type":"string"
        },
        "diversion-info-mapping-mode":{
            "$ref":"#/components/schemas/DivInfoMappingModeEnum"
        },
        "sip-recursion-policy":{
            "description":"SIP Recursion Policy",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "asymmetric-preconditions":{
            "description":"Enable/disable asymmetric preconditions",
            "type":"boolean"
        },
        "asymmetric-preconditions-mode":{
            "$ref":"#/components/schemas/PreconditionsModeEnum"
        },
        "hist-to-div-for-cause-380":{
            "$ref":"#/components/schemas/HIDivFeatureConfigModeEnum"
        },
        "user-agent":{
            "description":"user-agent string to be added to SIP User-Agent header",
            "type":"string"
        },
        "sti-as":{
            "description":"group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sti-vs":{
            "description":"group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sti-orig-id":{
            "description":"UUID4 added to STI-AS requests, if not already present. Leave empty to pick up the UUID from the upstream config object",
            "pattern":"^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
            "type":"string"
        },
        "sti-attest":{
            "description":"Attestation Values can be either A, B, C or Empty. A: Full Attestation, B: Partial Attestation, C: Gateway Attestation",
            "pattern":"^$|^[A-C]$",
            "type":"string"
        },
        "sti-signaling-attest":{
            "description":"Retrieve attestation value and OrigId from SIP headers, when present. Attestation-Info: attest [A/B/C] Origination-ID: origId [UUID]",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SIP interfaces",
    "type":"object"
}

Nested Schema : add-sdp-in-msg

Type: array

Insert SDP in sip message

Show Source

• Array of: string
  Allowed Values: [ "18xresp" ]

{
    "description":"Insert SDP in sip message",
    "items":{
        "$ref":"#/components/schemas/SdpInsertionConstraintEnum"
    },
    "type":"array"
}

Nested Schema : add-sdp-profiles

Type: array

list of media profiles

Show Source

• Array of: string

{
    "description":"list of media profiles",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : add-sdp-profiles-in-msg

Type: array

list of media profiles

Show Source

• Array of: string

{
    "description":"list of media profiles",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : carriers

Type: array

list of carriers

Show Source

• Array of: string

{
    "description":"list of carriers",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : p-early-media-direction

Type: array

Configure early-media-direction parameter for P-Early-Media header

Show Source

• Array of: string
  Allowed Values: [ "sendrecv", "sendonly", "recvonly", "inactive" ]

{
    "description":"Configure early-media-direction parameter for P-Early-Media header",
    "items":{
        "$ref":"#/components/schemas/PEarlyMediaDirectionEnum"
    },
    "type":"array"
}

Nested Schema : sip-ports

Type: array

list of SIP ports

Show Source

• Array of: object SipPort
  list of sip-ports

{
    "description":"list of SIP ports",
    "items":{
        "$ref":"#/components/schemas/SipPort"
    },
    "type":"array"
}

Nested Schema : sti-as

Type: array

group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)

Show Source

• Array of: string

{
    "description":"group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : sti-vs

Type: array

group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)

Show Source

• Array of: string

{
    "description":"group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : SipPort

Type: object

list of sip-ports

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• address(required): string
  Minimum Length: 1

  Pattern: ^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^(?:[1-9a-fA-F]{1,4}:){7}[1-9a-fA-F]{1,4}$|^(\:\:)?[1-9a-fA-F]{1,4}(\:\:?[0-9a-fA-F]{1,4}){0,7}(\:\:)?$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.|$)){4})$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|[0-9a-fA-F]{0,4}(\:[0-9a-fA-F]{0,4}){0,5}(::?)|[0-9a-fA-F]{1,4}|6[0-5]{2}[0-4]\d|6[0-4]{2}\d{2}|6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]{2}\d{3})$

  IP Address
• allow-anonymous: string
  Allowed Values: [ "all", "agents-only", "realm-prefix" ]
• port(required): integer (int32)
  Minimum Value: 1

  Maximum Value: 65535

  port
• tls-profile: string
  tls profile name
• transport-protocol(required): string
  Allowed Values: [ "UDP", "TCP", "TLS", "SCTP" ]

{
    "required":[
        "address",
        "port",
        "transport-protocol"
    ],
    "properties":{
        "address":{
            "description":"IP Address",
            "minLength":1,
            "pattern":"^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(\\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^\\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\\]?(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^(?:[1-9a-fA-F]{1,4}:){7}[1-9a-fA-F]{1,4}$|^(\\:\\:)?[1-9a-fA-F]{1,4}(\\:\\:?[0-9a-fA-F]{1,4}){0,7}(\\:\\:)?$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.|$)){4})$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|[0-9a-fA-F]{0,4}(\\:[0-9a-fA-F]{0,4}){0,5}(::?)|[0-9a-fA-F]{1,4}|6[0-5]{2}[0-4]\\d|6[0-4]{2}\\d{2}|6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]{2}\\d{3})$",
            "type":"string"
        },
        "port":{
            "description":"port",
            "format":"int32",
            "maximum":65535,
            "minimum":1,
            "type":"integer"
        },
        "transport-protocol":{
            "$ref":"#/components/schemas/TransProtocolConstraintEnum"
        },
        "tls-profile":{
            "description":"tls profile name",
            "type":"string"
        },
        "allow-anonymous":{
            "$ref":"#/components/schemas/AnonModeEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of sip-ports",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

406 Response

Validation Failure

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top