Jump to

• Request
• Response

Retrieve one config element: SD.realm-config

get

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

Retrieve one config element: SD.realm-config

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  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

• application/json

200 Response

return one config element: RealmConfig

Body ()

Root Schema : schema

Type: object

configure a realm for media management

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• access-control-trust-level: string
  Allowed Values: [ "none", "low", "medium", "high" ]
• accounting-enable: boolean
  enable accounting support for realm
• addr-prefixes: array addr-prefixes
  address prefixes to match realm. Omit number of bits for exact match. e.g. 10.0.0.0/24 or 2001:DB8:0:56::/64
• alt-family-realm: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  alternate family realm name for this realm
• auth-attribute: array auth-attribute
  list of auth-attributes
• average-rate-limit: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  average data rate (bytes per second) (e.g. 8000)
• block-rtcp: boolean
  Block RTCP from entering or leaving realm
• bw-cac-non-mm: boolean
  decrement released media bandwidth from realm's available bandwidth
• call-recording-server-id: string
  name of the recording server
• class-profile: string
  name of session classification profile
• codec-manip-in-network: boolean
  enable/disable codec policy within this network
• codec-manip-in-realm: boolean
  enable codec manipulation support for realm
• codec-policy: string
  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  set codec policy mode for the realm
• constraint-name: string
  name of constraint
• delay-media-update: boolean
  enable media update delay support for realm
• deny-period: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  blocked period for dynamic denied entries (seconds) (e.g. 30)
• description: string
  realm description
• dns-realm: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of realm of DNS server for this realm
• dyn-refer-term: boolean
  enable terminating refer call transfer support for realm
• early-media-allow: string
  Allowed Values: [ "both", "reverse", "none" ]
• enforcement-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of enforcement profile
• fallback-bandwidth: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  fallback bandwidth for dynamic flows to/from realm (kilobits per second) (e.g. 64000)
• feature-trfo: array feature-trfo
  Enable/disable transcoding free operation
• flow-time-limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 2073600

  Flow Time Limit(seconds).
• hairpin-id: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  hairpin id (0 disables)
• hide-egress-media-update: boolean
  hide changes to ingress RTP egressing into realm
• hold-refer-reinvite: boolean
  enable or disable holding re-invite
• icmp-advertisement-interval: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  ICMP advertisement interval (seconds)
• icmp-detect-multiplier: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  ICMP detect multipiler
• icmp-target-ip: string
  Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){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}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$

  ICMP target IP
• identifier(required): string
  Minimum Length: 1

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

  name of realm
• in-manipulationid: string
  name of inbound SIP manipulation rule
• in-translationid: string
  inbound translation rule id
• initial-guard-timer: integer (int32)
  Minimum Value: 1

  Maximum Value: 86400

  initial flow guard timer (seconds).
• invalid-signal-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  allowed invalid signaling message rate within tolerance window (e.g. 30)
• manipulation-pattern: string
  regex to use in header manipulation rules
• manipulation-string: string
  string that can be used in header manipulation rules
• match-media-profiles: array match-media-profiles
  media profile subtypes for realm. Supports subtypes and name wildcarding (e.g. PCMU::A PCMA:: *::B)
• max-bandwidth: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  maximum bandwidth for dynamic flows to/from realm (kilobits per second) (e.g. 64000)
• max-endpoints-per-nat: integer (int64)
  Minimum Value: 0

  Maximum Value: 65535

  allowed maximum number of endpoints behind a NAT device
• max-priority-bandwidth: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  maximum priority bandwidth for dynamic flows to/from realm (kilobits per second) (e.g. 64000)
• maximum-signal-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  maximum allowed number of signaling messages within tolerance window (e.g. 1000)
• media-policy: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

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

  name of default media security policy
• merge-early-dialogs: boolean
  Enable/disable early dialogs merge
• mm-in-network: boolean
  enable media managing for endpoints on same network
• mm-in-realm: boolean
  enable media managing for endpoints within same realm
• mm-in-system: boolean
  enable media managing for endpoints on same SD
• mm-same-ip: boolean
  enable media managing for endpoints behind same IP
• monthly-minutes: integer (int64)
  Minimum Value: 0

  Maximum Value: 71582788

  maximum monthly minutes allowed for the realm
• msm-release: boolean
  include info for multi-system media release
• nat-invalid-message-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 65535

  acceptable number of invalid messages from behind a NAT
• nat-trust-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 65535

  number of endpoints behind a NAT that have to be denied (e.g. 30)
• options: string
  optional features/parameters
• out-manipulationid: string
  name of outbound SIP manipulation rule
• out-translationid: string
  outbound translation rule id
• pai-strip: boolean
  remove P_ASSERTED_Identity headers
• parent-realm: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of parent realm
• pref-addr-type: string
  Allowed Values: [ "none", "ipv4", "ipv6" ]
• qos-constraint: string
  name of the qos-constraint
• qos-enable: boolean
  enable QOS support for realm
• refer-call-transfer: string
  Allowed Values: [ "disabled", "enabled", "dynamic" ]
• refer-notify-provisional: string
  Allowed Values: [ "none", "initial", "all" ]
• restricted-latching: string
  Allowed Values: [ "none", "sdp", "peer-ip" ]
• restriction-mask: integer (int64)
  Minimum Value: 1

  Maximum Value: 128

  bits of IP address used for restriction latching should be in the range 1-32 for IPv4 address family and 1-128 for IPv6 address family
• rtcp-mux: boolean
  specifies whether RTCP multiplexing shall be negotiated or not
• rtcp-policy: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of rtcp policy for this realm
• service-networks(required): array service-networks
  Minimum Number of Items: 1

  service network this realm is available to
• 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.
• sip-isup-profile: string
  name of sip-isup profile
• sip-profile: string
  name of sip profile
• spl-options: string
  optional SPL features/parameters
• srtp-msm-passthrough: boolean
  enable inclusion of info for multi-system SRTP pass-through
• 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)
• subsq-guard-timer: integer (int32)
  Minimum Value: 1

  Maximum Value: 86400

  subsequent flow guard timer (seconds).
• symmetric-latching: string
  Allowed Values: [ "disabled", "enabled", "pre-emptive" ]
• tcp-flow-time-limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 2073600

  TCP Flow Time Limit(seconds).
• tcp-initial-guard-timer: integer (int32)
  Minimum Value: 1

  Maximum Value: 86400

  initial TCP flow init timer (seconds).
• tcp-media-profile: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  TCP media profile to use for this realm
• tcp-subsq-guard-timer: integer (int32)
  Minimum Value: 1

  Maximum Value: 86400

  subsequent TCP flow guard timer (seconds).
• trunk-context: string
  default trunk context for realm
• untrusted-signal-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  maximum allowed number of untrusted signaling messages within tolerance window (e.g. 1000)
• wait-time-for-invalid-register: integer (int64)
  Minimum Value: 0

  Maximum Value: 300

  time period (in seconds) for which the SD will wait before counting the absence of the REGISTER message as an invalid message
• xnq-state: string
  Allowed Values: [ "xnq-unknown", "xnq-potential", "xnq-remove" ]

{
    "required":[
        "identifier",
        "service-networks"
    ],
    "properties":{
        "identifier":{
            "description":"name of realm",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"realm description",
            "type":"string"
        },
        "service-networks":{
            "description":"service network this realm is available to",
            "items":{
                "type":"string"
            },
            "minItems":1,
            "type":"array"
        },
        "mm-in-realm":{
            "description":"enable media managing for endpoints within same realm",
            "type":"boolean"
        },
        "mm-in-network":{
            "description":"enable media managing for endpoints on same network",
            "type":"boolean"
        },
        "mm-same-ip":{
            "description":"enable media managing for endpoints behind same IP",
            "type":"boolean"
        },
        "mm-in-system":{
            "description":"enable media managing for endpoints on same SD",
            "type":"boolean"
        },
        "bw-cac-non-mm":{
            "description":"decrement released media bandwidth from realm's available bandwidth",
            "type":"boolean"
        },
        "msm-release":{
            "description":"include info for multi-system media release",
            "type":"boolean"
        },
        "qos-enable":{
            "description":"enable QOS support for realm",
            "type":"boolean"
        },
        "max-bandwidth":{
            "description":"maximum bandwidth for dynamic flows to/from realm (kilobits per second) (e.g. 64000)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "fallback-bandwidth":{
            "description":"fallback bandwidth for dynamic flows to/from realm (kilobits per second) (e.g. 64000)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-priority-bandwidth":{
            "description":"maximum priority bandwidth for dynamic flows to/from realm (kilobits per second) (e.g. 64000)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "parent-realm":{
            "description":"name of parent realm",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "dns-realm":{
            "description":"name of realm of DNS server for this realm",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "media-policy":{
            "description":"name of default media policy",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "media-sec-policy":{
            "description":"name of default media security policy",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "rtcp-mux":{
            "description":"specifies whether RTCP multiplexing shall be negotiated or not",
            "type":"boolean"
        },
        "srtp-msm-passthrough":{
            "description":"enable inclusion of info for multi-system SRTP pass-through",
            "type":"boolean"
        },
        "class-profile":{
            "description":"name of session classification profile",
            "type":"string"
        },
        "in-translationid":{
            "description":"inbound translation rule id",
            "type":"string"
        },
        "out-translationid":{
            "description":"outbound translation rule id",
            "type":"string"
        },
        "in-manipulationid":{
            "description":"name of inbound SIP manipulation rule",
            "type":"string"
        },
        "out-manipulationid":{
            "description":"name of outbound SIP manipulation rule",
            "type":"string"
        },
        "average-rate-limit":{
            "description":"average data rate (bytes per second) (e.g. 8000)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "access-control-trust-level":{
            "$ref":"#/components/schemas/AccessControlTrustLevelEnum"
        },
        "invalid-signal-threshold":{
            "description":"allowed invalid signaling message rate within tolerance window (e.g. 30)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "maximum-signal-threshold":{
            "description":"maximum allowed number of signaling messages within tolerance window (e.g. 1000)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "untrusted-signal-threshold":{
            "description":"maximum allowed number of untrusted signaling messages within tolerance window (e.g. 1000)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "nat-trust-threshold":{
            "description":"number of endpoints behind a NAT that have to be denied (e.g. 30)",
            "format":"int64",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "max-endpoints-per-nat":{
            "description":"allowed maximum number of endpoints behind a NAT device",
            "format":"int64",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "nat-invalid-message-threshold":{
            "description":"acceptable number of invalid messages from behind a NAT",
            "format":"int64",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "wait-time-for-invalid-register":{
            "description":"time period (in seconds) for which the SD will wait before counting the absence of the REGISTER message as an invalid message",
            "format":"int64",
            "maximum":300,
            "minimum":0,
            "type":"integer"
        },
        "deny-period":{
            "description":"blocked period for dynamic denied entries (seconds) (e.g. 30)",
            "format":"int64",
            "maximum":"4294967295",
            "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"
        },
        "symmetric-latching":{
            "$ref":"#/components/schemas/SymmetricLatchingEnum"
        },
        "pai-strip":{
            "description":"remove P_ASSERTED_Identity headers",
            "type":"boolean"
        },
        "trunk-context":{
            "description":"default trunk context for realm",
            "type":"string"
        },
        "early-media-allow":{
            "$ref":"#/components/schemas/MediaDirAllowEnum"
        },
        "enforcement-profile":{
            "description":"name of enforcement profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "addr-prefixes":{
            "description":"address prefixes to match realm. Omit number of bits for exact match. e.g. 10.0.0.0/24 or 2001:DB8:0:56::/64",
            "items":{
                "$ref":"#/components/schemas/RealmConfigAddrPrefixes"
            },
            "type":"array"
        },
        "restricted-latching":{
            "$ref":"#/components/schemas/RestrictedLatchingEnum"
        },
        "restriction-mask":{
            "description":"bits of IP address used for restriction latching should be in the range 1-32 for IPv4 address family and 1-128 for IPv6 address family",
            "format":"int64",
            "maximum":128,
            "minimum":1,
            "type":"integer"
        },
        "icmp-detect-multiplier":{
            "description":"ICMP detect multipiler",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "icmp-advertisement-interval":{
            "description":"ICMP advertisement interval (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "icmp-target-ip":{
            "description":"ICMP target IP",
            "pattern":"$|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){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}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$",
            "type":"string"
        },
        "monthly-minutes":{
            "description":"maximum monthly minutes allowed for the realm",
            "format":"int64",
            "maximum":71582788,
            "minimum":0,
            "type":"integer"
        },
        "spl-options":{
            "description":"optional SPL features/parameters",
            "type":"string"
        },
        "accounting-enable":{
            "description":"enable accounting support for realm",
            "type":"boolean"
        },
        "delay-media-update":{
            "description":"enable media update delay support for realm",
            "type":"boolean"
        },
        "refer-call-transfer":{
            "$ref":"#/components/schemas/ReferTransferModeEnum"
        },
        "hold-refer-reinvite":{
            "description":"enable or disable holding re-invite",
            "type":"boolean"
        },
        "refer-notify-provisional":{
            "$ref":"#/components/schemas/ReferNotifyProvisionalModeEnum"
        },
        "dyn-refer-term":{
            "description":"enable terminating refer call transfer support for realm",
            "type":"boolean"
        },
        "codec-policy":{
            "description":"set codec policy mode for the realm",
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "codec-manip-in-realm":{
            "description":"enable codec manipulation support for realm",
            "type":"boolean"
        },
        "codec-manip-in-network":{
            "description":"enable/disable codec policy within this network",
            "type":"boolean"
        },
        "rtcp-policy":{
            "description":"name of rtcp policy for this realm",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "constraint-name":{
            "description":"name of constraint",
            "type":"string"
        },
        "call-recording-server-id":{
            "description":"name of the recording server",
            "type":"string"
        },
        "xnq-state":{
            "$ref":"#/components/schemas/RealmConfigXnqStateEnum"
        },
        "hairpin-id":{
            "description":"hairpin id (0 disables)",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "manipulation-string":{
            "description":"string that can be used in header manipulation rules",
            "type":"string"
        },
        "manipulation-pattern":{
            "description":"regex to use in header manipulation rules",
            "type":"string"
        },
        "sip-profile":{
            "description":"name of sip profile",
            "type":"string"
        },
        "flow-time-limit":{
            "description":"Flow Time Limit(seconds).",
            "format":"int32",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "initial-guard-timer":{
            "description":"initial flow guard timer (seconds).",
            "format":"int32",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "subsq-guard-timer":{
            "description":"subsequent flow guard timer (seconds).",
            "format":"int32",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "tcp-flow-time-limit":{
            "description":"TCP Flow Time Limit(seconds).",
            "format":"int32",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "tcp-initial-guard-timer":{
            "description":"initial TCP flow init timer (seconds).",
            "format":"int32",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "tcp-subsq-guard-timer":{
            "description":"subsequent TCP flow guard timer (seconds).",
            "format":"int32",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "sip-isup-profile":{
            "description":"name of sip-isup profile",
            "type":"string"
        },
        "match-media-profiles":{
            "description":"media profile subtypes for realm. Supports subtypes and name wildcarding (e.g. PCMU::A PCMA:: *::B)",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "qos-constraint":{
            "description":"name of the qos-constraint",
            "type":"string"
        },
        "block-rtcp":{
            "description":"Block RTCP from entering or leaving realm",
            "type":"boolean"
        },
        "hide-egress-media-update":{
            "description":"hide changes to ingress RTP egressing into realm",
            "type":"boolean"
        },
        "tcp-media-profile":{
            "description":"TCP media profile to use for this realm",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "alt-family-realm":{
            "description":"alternate family realm name for this realm",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "pref-addr-type":{
            "$ref":"#/components/schemas/SessionAddrTypeEnum"
        },
        "merge-early-dialogs":{
            "description":"Enable/disable early dialogs merge",
            "type":"boolean"
        },
        "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"
        },
        "feature-trfo":{
            "description":"Enable/disable transcoding free operation",
            "items":{
                "$ref":"#/components/schemas/FeatureTrfoEnum"
            },
            "type":"array"
        },
        "auth-attribute":{
            "description":"list of auth-attributes",
            "items":{
                "$ref":"#/components/schemas/SipAuthAttribute"
            },
            "type":"array"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a realm for media management",
    "type":"object"
}

Nested Schema : addr-prefixes

Type: array

address prefixes to match realm. Omit number of bits for exact match. e.g. 10.0.0.0/24 or 2001:DB8:0:56::/64

Show Source

• Array of: object RealmConfigAddrPrefixes

{
    "description":"address prefixes to match realm. Omit number of bits for exact match. e.g. 10.0.0.0/24 or 2001:DB8:0:56::/64",
    "items":{
        "$ref":"#/components/schemas/RealmConfigAddrPrefixes"
    },
    "type":"array"
}

Nested Schema : auth-attribute

Type: array

list of auth-attributes

Show Source

• Array of: object SipAuthAttribute
  list of auth-attributes

{
    "description":"list of auth-attributes",
    "items":{
        "$ref":"#/components/schemas/SipAuthAttribute"
    },
    "type":"array"
}

Nested Schema : feature-trfo

Type: array

Enable/disable transcoding free operation

Show Source

• Array of: string
  Allowed Values: [ "ringback" ]

{
    "description":"Enable/disable transcoding free operation",
    "items":{
        "$ref":"#/components/schemas/FeatureTrfoEnum"
    },
    "type":"array"
}

Nested Schema : match-media-profiles

Type: array

media profile subtypes for realm. Supports subtypes and name wildcarding (e.g. PCMU::A PCMA:: *::B)

Show Source

• Array of: string

{
    "description":"media profile subtypes for realm. Supports subtypes and name wildcarding (e.g. PCMU::A PCMA:: *::B)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : service-networks

Type: array

Minimum Number of Items: 1

service network this realm is available to

Show Source

• Array of: string

{
    "description":"service network this realm is available to",
    "items":{
        "type":"string"
    },
    "minItems":1,
    "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 : RealmConfigAddrPrefixes

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• address: string
  Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){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}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$

{
    "properties":{
        "address":{
            "pattern":"$|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){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}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : SipAuthAttribute

Type: object

list of auth-attributes

Show Source

• _elementKey: string
  Read Only: true

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

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

  authentication realm
• auth-user-lookup(required): string
  Minimum Length: 1

  Lookup used for selecting the AuthUser
• in-dialog-methods: array in-dialog-methods
  in dialog methods to add authentication headers to
• password: string password
  authentication password
• passwordAsString: string
• username: string
  authentication username

{
    "required":[
        "auth-realm",
        "auth-user-lookup"
    ],
    "properties":{
        "auth-realm":{
            "description":"authentication realm",
            "minLength":1,
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$",
            "type":"string"
        },
        "username":{
            "description":"authentication username",
            "type":"string"
        },
        "auth-user-lookup":{
            "description":"Lookup used for selecting the AuthUser",
            "minLength":1,
            "type":"string"
        },
        "password":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SecureString"
                }
            ],
            "description":"authentication password",
            "type":"string"
        },
        "in-dialog-methods":{
            "description":"in dialog methods to add authentication headers to",
            "items":{
                "$ref":"#/components/schemas/SipMethodsConstraintEnum"
            },
            "type":"array"
        },
        "passwordAsString":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of auth-attributes",
    "type":"object"
}

Nested Schema : in-dialog-methods

Type: array

in dialog methods to add authentication headers to

Show Source

• Array of: string
  Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]

{
    "description":"in dialog methods to add authentication headers to",
    "items":{
        "$ref":"#/components/schemas/SipMethodsConstraintEnum"
    },
    "type":"array"
}

Nested Schema : password

authentication password

Match All

authentication password

Show Source

• string(password)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SecureString"
        }
    ],
    "description":"authentication password",
    "type":"string"
}

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"
}

Back to Top