Description

Update a rule

REST Name
update
Request
POST
URL
[server url][:port]/SAFe/sng_rest/api/update/sipsecmon/rules/{identifier}
Input
Name Data Possible Values Description
failed_attempts

Type

  • integer

Default

  • None

Rules

  • required

Failed Attempts

Number of failed registration attempts to match the rule.

time_frame

Type

  • integer

Default

  • None

Rules

  • required

Interval

Number of minutes to wait before resetting the counter for failed attempts.

src_ip_filter_expr

Type

  • string

Default

  • None

Rules

  • src_ip_filter_rule

Source IP Filter

Whether to filter registration attempts based on source IP.

Below is the syntax that must be used for the source IP filter:

1) Empty = No source IP/Network filtering will be performed.

2) IPv4 IP Address (10.10.0.1)

3) IPv4 Network Address (172.16.0.0/16)

4) Comma seperated list of IPv4 addresses or networks (10.10.0.1, 172.16.0.0/16)

profile_filter

Type

  • Enumeration

Default

  • __empty__

Rules

  • required

Values

  • __empty__ - none

SIP Profile Filter

Whether to filter registration attempts based on SIP profile.

account_filter_expr

Type

  • string

Default

  • None

Rules

  • validate_account_filter

Account Registration Filter

Whether to filter registration attempts based on account.

Below is the syntax that must be used for the Account Registration filter:

1) Empty = No account filtering will be perfomed.

2) Unknown = The string "unknown" matches any accounts that are not known to the registrar (ie, trying to register joe@domain.com where the domain.com registrar does not know about any joe user). This option only works when SIP thru registration is disabled for the profile receiving the REGISTER request.

3) Comma-separated list of accounts to match, ie "bob@company.com, alice@company.com".

4) A regular expression matching the desired accounts in format: regex="the regular expression"

user_agent_filter_expr

Type

  • string

Default

  • None

Rules

  • validate_user_agent_filter

User Agent Filter

Whether to filter registration attempts based on user agent.

Below is the syntax that must be used for the user agent filter:

1) Empty = No user agent filtering will be perfomed.

2) Any string (this will be an exact match of the string with the user agent)

3) A regular expression matching the desired user agent in format: regex="the regular expression"

action_expr

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Log
  • block_ip - Block IP

Action

Action to perform when the rule matches

action_param

Type

  • string

Default

  • None

Rules

  • required[action_expr,in,block_ip]
  • greater_or_equal[0]
  • less_than[1440]

Action Parameter

Defines parameter of the selected action:

Block IP - Number of minutes the IP will remain blocked, from [0 to 1439]. 0 means block this IP forever, until admin manually unblocks it.

comments

Type

  • string

Default

  • None

Comments