Description

Retrieve a limit

REST Name
retrieve
Request
GET
URL
[server url][:port]/SAFe/sng_rest/api/retrieve/sip/profile/{identifier}/limit/{identifier}
Output
Name Data Possible Values Description
host

Type

  • string

Default

  • ANY

Rules

  • valid_ip_or_blank_or_any

Host

Host which will be used in the limitation rule. If this field is left blank, the rule will use any host. The field accepts any IPv4 IP address.

limit

Type

  • string

Default

  • None

Rules

  • required
  • is_numeric
  • greater_than[0]

Rate Limit

Number of SIP messages to limit

method

Type

  • Enumeration

Default

  • ANY

Rules

  • required
  • required

Values

  • INFO - INFO
  • INVITE - INVITE
  • ACK - ACK
  • REGISTER - REGISTER
  • PRACK - PRACK
  • UPDATE - UPDATE
  • PUBLISH - PUBLISH
  • OPTIONS - OPTIONS
  • SUBSCRIBE - SUBSCRIBE
  • NOTIFY - NOTIFY
  • MALFORMED - MALFORMED
  • CANCEL - CANCEL
  • MESSAGE - MESSAGE
  • BYE - BYE
  • ANY - ANY
  • REFER - REFER

SIP Method

SIP messages which will be used in the limitation rule.

period

Type

  • string

Default

  • None

Rules

  • required
  • is_numeric
  • greater_than[0]

Rate Period

Time period in seconds to limit incoming requests.