REST API for Oracle Cloud Native Session Border Controller, Release 1.25.1

Retrieve all config elements: SD.session-agent

get

https://cloud-native-SBC-IP/config/v1/sd/session-agent

Retrieve all config elements: SD.session-agent

Request

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.

Response

Supported Media Types

application/json

200 Response

return all config elements: SessionAgent

Root Schema : schema

Type: array

Show Source

Array of: object schema

configure session agents

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

Nested Schema : schema

Type: object

configure session agents

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
allow-next-hop-lp: boolean

allow this session agent to be used as nexthop in local policy
app-protocol: string

Allowed Values: [ "SIP" ]
associated-agents: array associated-agents

list of Agents Associated with this session-agent
auth-attribute: array auth-attribute

list of auth-attributes
burst-rate-window: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

burst rate window (seconds)
cac-alarm-threshold: integer (int64)

Minimum Value: 0

Maximum Value: 99

CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.
carriers: array carriers

list of carriers
codec-policy: string

codec policy to apply
constraints: boolean

apply session constraints to agent
description: string

description of session agent
early-media-allow: string

Allowed Values: [ "both", "reverse", "none" ]
egress-realm-id: string

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

default egress realm to use for session agent 'pings' and when multiple egress realms are possible (e.g. realm-id is empty or '*')
enforcement-profile: string

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

Name of enforcement profile
hold-refer-reinvite: boolean

enable or disables holding re-invite
hostname(required): string

Minimum Length: 1

Pattern: ^(((((\*)|(\*\.)){0,1})([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})|(\*?))$|^((([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}$

hostname at which to contact session agent
in-manipulationid: string

inbound manipulation ID
in-service-period: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

in service period
in-translationid: string

inbound translation ID
ip-address: string

Pattern: ^$|^((([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])(/[0-2]?[0-9]|/3[0-2])?$|^([\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}):([\d]{1,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}:)|(::))|:(53|(102[5-9]|10[3-9][0-9]{1}|1[1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[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]))\](:[0-9]{0,4})$|^\[(([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]))\]$|^(([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]))$

IP Address if hostname is FQDN (optional)
kpml-interworking: string

Allowed Values: [ "inherit", "disabled", "enabled" ]
kpml2833-iwf-on-hairpin: string

Allowed Values: [ "inherit", "disabled", "enabled" ]
li-trust-me: boolean

session agent is trusted for Lawful Intercept or not
load-balance-dns-query: string

Allowed Values: [ "hunt", "round-robin" ]
local-response-map: string

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

name of local response map to use for the SA
loose-routing: boolean

enable loose routing
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
match-identifier: array match-identifier

Identification criteria to match this agent
max-burst-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max burst rate (invites per second)
max-inbound-burst-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max inbound burst rate (invites per second)
max-inbound-sessions: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max inbound sessions allowed to this agent
max-inbound-sustain-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max inbound sustained rate (invites per second)
max-outbound-burst-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max outbound burst rate (invites per second)
max-outbound-sessions: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max outbound sessions allowed to this agent
max-outbound-sustain-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max outbound sustained rate (invites per second)
max-register-sustain-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

maximum reg sustain rate (register per second)
max-sessions: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max sessions allowed to and from this agent
max-sustain-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max sustained rate (invites per second)
media-profiles: array media-profiles

list of media profiles
min-asr: integer (int64)

Minimum Value: 0

Maximum Value: 100

minimum answer seizure ratio (percentage)
min-seizures: integer (int64)

Minimum Value: 1

Maximum Value: 999999999

minimum number of seizures for a no-answer scenario
options: string

optional features/parameters
out-manipulationid: string

Outbound Manipulation Id
out-service-response-codes: string

Pattern: ^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$

Response codes for Any Dialog creating or Ping Request that make the SA OOS
out-translationid: string

Outbound Translation Id
p-asserted-id: string

p-asserted-id(URI Format) for Session Agent
ping-all-addresses: boolean

SIP ping all adresses from DNS query
ping-from-user-part: string

ping From User Part
ping-in-service-response-codes: string

Pattern: ^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$

Response codes for PING Resuest that make the SA InService
ping-interval: integer (int64)

Minimum Value: 0

Maximum Value: 4294967295

how often to ping SA (seconds)
ping-method: string

SIP message/method used for pinging
ping-response: boolean

OPTIONS received will be considered as ping and will be locally responded
ping-send-mode: string

Allowed Values: [ "keep-alive", "continuous" ]
ping-to-user-part: string

ping To User Part
port: integer (int32)

Minimum Value: 0

Maximum Value: 65535

port to contact session agent
precedence: integer (int64)

Minimum Value: 0

Maximum Value: 4294967295

Selection precedence of Session Agents with same IP address
proxy-mode: string

Allowed Values: [ "Stateless", "Proxy", "Redirect", "Record-Route" ]
rate-constraints: array rate-constraints

create a rate constraint for a method
realm-id: string

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

realm this session agent resides in
redirect-action: string

Allowed Values: [ "Proxy", "Recurse", "Recurse-305-only" ]
refer-call-transfer: string

Allowed Values: [ "disabled", "enabled", "dynamic" ]
refer-notify-provisional: string

Allowed Values: [ "none", "initial", "all" ]
req-uri-carrier-mode: string

Allowed Values: [ "None", "URI-param", "Prefix" ]
request-uri-headers: array request-uri-headers

list of headers which need to be inserted in the RE-INVITE from the contact Header
response-map: string

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

response map name
reuse-connections: string

Allowed Values: [ "NONE", "TCP", "SCTP", "TLS" ]
rfc2833-mode: string

Allowed Values: [ "none", "transparent", "preferred", "dual" ]
rfc2833-payload: integer (int32)

Minimum Value: 0

Maximum Value: 127

payload type used by the SA in preferred rfc2833-mode (0,128>x>95)
send-media-session: boolean

send media session description
send-tcp-fin: boolean

Enables or disables sending TCP FIN messages when SA is Out of Service
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

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

Name of sip-isup profile
sip-profile: string

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

Name of 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). E.g. 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). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
stop-recurse: string

Response codes that stop recursion of targets/contacts
sustain-rate-window: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

sustained rate window (seconds)
tcp-keepalive: string

Allowed Values: [ "none", "enabled", "disabled" ]
tcp-reconn-interval: string

TCP/SCTP Reconnection Interval
time-to-resume: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

time to resume
transport-method: string

Allowed Values: [ "UDP", "UDP+TCP", "DynamicTCP", "StaticTCP", "DynamicTLS", "StaticTLS", "StaticSCTP", "ANY" ]
trunk-group: array trunk-group

list of trunk groups and their contexts. To use the default context case, omit : and the context
trust-me: boolean

whether this session agent is trusted or not
ttr-no-response: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

no response time to resume

{
    "required":[
        "hostname"
    ],
    "properties":{
        "hostname":{
            "description":"hostname at which to contact session agent",
            "minLength":1,
            "pattern":"^(((((\\*)|(\\*\\.)){0,1})([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})|(\\*?))$|^((([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"
        },
        "ip-address":{
            "description":"IP Address if hostname is FQDN (optional)",
            "pattern":"^$|^((([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])(/[0-2]?[0-9]|/3[0-2])?$|^([\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}):([\\d]{1,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}:)|(::))|:(53|(102[5-9]|10[3-9][0-9]{1}|1[1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[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]))\\](:[0-9]{0,4})$|^\\[(([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]))\\]$|^(([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]))$",
            "type":"string"
        },
        "port":{
            "description":"port to contact session agent",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "app-protocol":{
            "$ref":"#/components/schemas/LPApplicationProtocolConstraintEnum"
        },
        "transport-method":{
            "$ref":"#/components/schemas/SATransportMethodConstraintEnum"
        },
        "realm-id":{
            "description":"realm this session agent resides in",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "egress-realm-id":{
            "description":"default egress realm to use for session agent &#39;pings&#39; and when multiple egress realms are possible (e.g. realm-id is empty or &#39;*&#39;)",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"description of session agent",
            "type":"string"
        },
        "carriers":{
            "description":"list of carriers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "allow-next-hop-lp":{
            "description":"allow this session agent to be used as nexthop in local policy",
            "type":"boolean"
        },
        "match-identifier":{
            "description":"Identification criteria to match this agent",
            "items":{
                "$ref":"#/components/schemas/SessionAgentIdentifier"
            },
            "type":"array"
        },
        "associated-agents":{
            "description":"list of Agents Associated with this session-agent",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "constraints":{
            "description":"apply session constraints to agent",
            "type":"boolean"
        },
        "max-sessions":{
            "description":"max sessions allowed to and from this agent",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sessions":{
            "description":"max inbound sessions allowed to this agent",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sessions":{
            "description":"max outbound sessions allowed to this agent",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-burst-rate":{
            "description":"max burst rate (invites per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-burst-rate":{
            "description":"max inbound burst rate (invites per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-burst-rate":{
            "description":"max outbound burst rate (invites per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-sustain-rate":{
            "description":"max sustained rate (invites per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sustain-rate":{
            "description":"max inbound sustained rate (invites per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sustain-rate":{
            "description":"max outbound sustained rate (invites per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "min-seizures":{
            "description":"minimum number of seizures for a no-answer scenario",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "min-asr":{
            "description":"minimum answer seizure ratio (percentage)",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "cac-alarm-threshold":{
            "description":"CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.",
            "format":"int64",
            "maximum":99,
            "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"
        },
        "time-to-resume":{
            "description":"time to resume",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "ttr-no-response":{
            "description":"no response time to resume",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "in-service-period":{
            "description":"in service period",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "burst-rate-window":{
            "description":"burst rate window (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "sustain-rate-window":{
            "description":"sustained rate window (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "req-uri-carrier-mode":{
            "$ref":"#/components/schemas/ReqURICarModeEnum"
        },
        "proxy-mode":{
            "$ref":"#/components/schemas/ProxyModeConstraintEnum"
        },
        "redirect-action":{
            "$ref":"#/components/schemas/SipRedirectActionEnum"
        },
        "loose-routing":{
            "description":"enable loose routing",
            "type":"boolean"
        },
        "send-media-session":{
            "description":"send media session description",
            "type":"boolean"
        },
        "response-map":{
            "description":"response map name",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "ping-method":{
            "description":"SIP message/method used for pinging",
            "type":"string"
        },
        "ping-interval":{
            "description":"how often to ping SA (seconds)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "ping-send-mode":{
            "$ref":"#/components/schemas/SipPingSendModeEnum"
        },
        "ping-all-addresses":{
            "description":"SIP ping all adresses from DNS query",
            "type":"boolean"
        },
        "ping-in-service-response-codes":{
            "description":"Response codes for PING Resuest that make the SA InService",
            "pattern":"^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$",
            "type":"string"
        },
        "out-service-response-codes":{
            "description":"Response codes for Any Dialog creating or Ping Request that make the SA OOS",
            "pattern":"^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$",
            "type":"string"
        },
        "load-balance-dns-query":{
            "$ref":"#/components/schemas/DnsLoadBalanceEnum"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "spl-options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "media-profiles":{
            "description":"list of media profiles",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "in-translationid":{
            "description":"inbound translation ID",
            "type":"string"
        },
        "out-translationid":{
            "description":"Outbound Translation Id",
            "type":"string"
        },
        "trust-me":{
            "description":"whether this session agent is trusted or not",
            "type":"boolean"
        },
        "request-uri-headers":{
            "description":"list of headers which need to be inserted in the RE-INVITE from the contact Header",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "stop-recurse":{
            "description":"Response codes that stop recursion of targets/contacts",
            "type":"string"
        },
        "local-response-map":{
            "description":"name of local response map to use for the SA",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "ping-to-user-part":{
            "description":"ping To User Part",
            "type":"string"
        },
        "ping-from-user-part":{
            "description":"ping From User Part",
            "type":"string"
        },
        "ping-response":{
            "description":"OPTIONS received will be considered as ping and will be locally responded",
            "type":"boolean"
        },
        "li-trust-me":{
            "description":"session agent is trusted for Lawful Intercept or not",
            "type":"boolean"
        },
        "in-manipulationid":{
            "description":"inbound manipulation ID",
            "type":"string"
        },
        "out-manipulationid":{
            "description":"Outbound Manipulation Id",
            "type":"string"
        },
        "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"
        },
        "p-asserted-id":{
            "description":"p-asserted-id(URI Format) for Session Agent",
            "type":"string"
        },
        "trunk-group":{
            "description":"list of trunk groups and their contexts. To use the default context case, omit : and the context",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "max-register-sustain-rate":{
            "description":"maximum reg sustain rate (register per second)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "early-media-allow":{
            "$ref":"#/components/schemas/MediaDirAllowEnum"
        },
        "rfc2833-mode":{
            "$ref":"#/components/schemas/Rfc2833ModeSAEnum"
        },
        "rfc2833-payload":{
            "description":"payload type used by the SA in preferred rfc2833-mode (0,128&gt;x&gt;95)",
            "format":"int32",
            "maximum":127,
            "minimum":0,
            "type":"integer"
        },
        "codec-policy":{
            "description":"codec policy to apply",
            "type":"string"
        },
        "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"
        },
        "refer-notify-provisional":{
            "$ref":"#/components/schemas/ReferNotifyProvisionalModeEnum"
        },
        "reuse-connections":{
            "$ref":"#/components/schemas/SipConnectionReuseEnum"
        },
        "tcp-keepalive":{
            "$ref":"#/components/schemas/SockTcpKeepaliveEnum"
        },
        "tcp-reconn-interval":{
            "description":"TCP/SCTP Reconnection Interval",
            "type":"string"
        },
        "rate-constraints":{
            "description":"create a rate constraint for a method",
            "items":{
                "$ref":"#/components/schemas/RateConstraints"
            },
            "type":"array"
        },
        "sip-profile":{
            "description":"Name of sip profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "sip-isup-profile":{
            "description":"Name of sip-isup profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "kpml-interworking":{
            "$ref":"#/components/schemas/ConfigModeEnum"
        },
        "kpml2833-iwf-on-hairpin":{
            "$ref":"#/components/schemas/ConfigModeEnum"
        },
        "precedence":{
            "description":"Selection precedence of Session Agents with same IP address",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "auth-attribute":{
            "description":"list of auth-attributes",
            "items":{
                "$ref":"#/components/schemas/SipAuthAttribute"
            },
            "type":"array"
        },
        "hold-refer-reinvite":{
            "description":"enable or disables holding re-invite",
            "type":"boolean"
        },
        "send-tcp-fin":{
            "description":"Enables or disables sending TCP FIN messages when SA is Out of Service",
            "type":"boolean"
        },
        "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"
        },
        "sti-as":{
            "description":"group name or list of STI authentication server (up to four allowed). E.g. STG:&lt;STI-group-name&gt; (for STI Server Group), &lt;STI-name&gt; (for single STI Server)",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sti-vs":{
            "description":"group name or list of STI validation server (up to four allowed). E.g. STG:&lt;STI-group-name&gt; (for STI Server Group), &lt;STI-name&gt; (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 session agents",
    "type":"object"
}

Nested Schema : associated-agents

Type: array

list of Agents Associated with this session-agent

Show Source

Array of: string

{
    "description":"list of Agents Associated with this session-agent",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : auth-attribute

Type: array

list of auth-attributes

Show Source

Array of: object schema

list of auth-attributes

{
    "description":"list of auth-attributes",
    "items":{
        "$ref":"#/components/schemas/SipAuthAttribute"
    },
    "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 : match-identifier

Type: array

Identification criteria to match this agent

Show Source

Array of: object SessionAgentIdentifier

Identification criteria to match this agent

{
    "description":"Identification criteria to match this agent",
    "items":{
        "$ref":"#/components/schemas/SessionAgentIdentifier"
    },
    "type":"array"
}

Nested Schema : media-profiles

Type: array

list of media profiles

Show Source

Array of: string

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

Nested Schema : rate-constraints

Type: array

create a rate constraint for a method

Show Source

Array of: object RateConstraints

create a rate constraint for a method

{
    "description":"create a rate constraint for a method",
    "items":{
        "$ref":"#/components/schemas/RateConstraints"
    },
    "type":"array"
}

Nested Schema : request-uri-headers

Type: array

list of headers which need to be inserted in the RE-INVITE from the contact Header

Show Source

Array of: string

{
    "description":"list of headers which need to be inserted in the RE-INVITE from the contact Header",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : sti-as

Type: array

group name or list of STI authentication server (up to four allowed). E.g. 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). E.g. STG:&lt;STI-group-name&gt; (for STI Server Group), &lt;STI-name&gt; (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). E.g. 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). E.g. STG:&lt;STI-group-name&gt; (for STI Server Group), &lt;STI-name&gt; (for single STI Server)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : trunk-group

Type: array

list of trunk groups and their contexts. To use the default context case, omit : and the context

Show Source

Array of: string

{
    "description":"list of trunk groups and their contexts. To use the default context case, omit : and the context",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : schema

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

Nested Schema : SessionAgentIdentifier

Type: object

Identification criteria to match this agent

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
identifier-rule(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}$

specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address
match-value(required): string

Minimum Length: 1

Pattern: ^.*$

value to match in sip header field which identifies this Session Agent

{
    "required":[
        "identifier-rule",
        "match-value"
    ],
    "properties":{
        "identifier-rule":{
            "description":"specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address",
            "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"
        },
        "match-value":{
            "description":"value to match in sip header field which identifies this Session Agent",
            "minLength":1,
            "pattern":"^.*$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Identification criteria to match this agent",
    "type":"object"
}

Nested Schema : RateConstraints

Type: object

create a rate constraint for a method

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
max-inbound-burst-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max inbound burst rate (methods per rate)
max-inbound-sustain-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max inbound sustained rate (methods per rate)
max-outbound-burst-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max outbound burst rate (methods per rate)
max-outbound-sustain-rate: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

max outbound sustained rate (methods per rate)
method(required): string

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

{
    "required":[
        "method"
    ],
    "properties":{
        "method":{
            "$ref":"#/components/schemas/SipMethodsConstraintEnum"
        },
        "max-inbound-burst-rate":{
            "description":"max inbound burst rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-burst-rate":{
            "description":"max outbound burst rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sustain-rate":{
            "description":"max inbound sustained rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sustain-rate":{
            "description":"max outbound sustained rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"create a rate constraint for a method",
    "type":"object"
}

404 Response

Not Found

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