Settings

Retrieve system settings

get

Retrieve settings for PortSIP PBX.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/admin/settings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "user_agent": "text",
  "blocked_user_agents": "text",
  "enable_shared_address_space_address_range": true,
  "enable_digest_auth": true,
  "enable_auth_mid_dialog": true,
  "enable_digest_auth_int": true,
  "enable_external_recording": true,
  "enable_reject_bad_nonce": true,
  "statistics_log_interval": 1,
  "dead_session_timeout": 1,
  "enable_session_timer": true,
  "session_timer_duration": 1,
  "enable_to_tag_in_register": true,
  "enable_congestion_management": true,
  "congestion_management_metric": "WAIT_TIME",
  "congestion_management_tolerance": 1,
  "enable_create_non_exist_extension": true,
  "enable_prack": true,
  "enable_tenant_level_trunk": true,
  "enable_diversion_support": true,
  "enable_history_info_support": true,
  "enable_outbound_support": true,
  "flow_timer": 1,
  "register_expiration_time": 1,
  "enable_auto_answer_alert_info_header": true,
  "auto_answer_alert_info_header": "INTERCOM",
  "enable_auto_answer_call_info_header": true,
  "enable_require_answer_mode": true,
  "enable_www_auth": true,
  "user_equal_required_for_auth_name": true,
  "trace_server_host": "text",
  "trace_server_port": 80,
  "web_failed_auth_amount": 1,
  "web_blacklist_time_interval": 1,
  "sip_failed_auth_amount": 1,
  "sip_failed_challenge_requests_amount": 1,
  "sip_blacklist_time_interval": 1,
  "sip_detection_period": 1,
  "sip_barrier_1_packets": 1,
  "sip_barrier_1_blocking_time": 1,
  "sip_barrier_2_packets": 1,
  "sip_barrier_2_blocking_time": 1,
  "stir_shaken_cert": "text",
  "stir_shaken_key": "text",
  "custom_options": "text"
}

OK

Update system settings

post

Update settings for PortSIP PBX

Authorizations

Body

user_agentstring · min: 1 · max: 1024optional

User agent.

Default: PortSIP UC

blocked_user_agentsstringoptional

The semicolon separated list of blocked user agents.

enable_shared_address_space_address_rangebooleanoptional

Enable Shared Address Space Address Range or not (RFC 6598).

Default: true

enable_digest_authbooleanoptional

Indicates if DIGEST authentication would be enabled.

Default: true

enable_auth_mid_dialogbooleanoptional

Indicates if PortSIP PBX requires authentication against all subsequent requests originated from one calling.

Default: false

enable_digest_auth_intbooleanoptional

Indicates if auth-int DIGEST authentication mode would be enabled.

Default: false

enable_external_recordingbooleanoptional

Allow external calls recording.

Default: true

enable_reject_bad_noncebooleanoptional

When a client sends a bad nonce in their credentials, return 403 message if this parameter is true, or send a new challenge if this parameter is false.

Default: false

statistics_log_intervalinteger · int32optional

Interval for statistics logs, in seconds.

Default: 600

dead_session_timeoutinteger · int32optional

Close the session if no RTP packets received within specified duration, in seconds.

Default: 600

enable_session_timerbooleanoptional

Indicates if session timer (RFC 4028) would be enabled. This also requires client support.

Default: true

session_timer_durationinteger · int32 · min: 90 · max: 3600optional

Duration recorded by Session timer. Precondition: "enable_session_timer" MUST be set to true.

Default: 3600

enable_to_tag_in_registerbooleanoptional

Indicates if "to" tag is allowed in REGISTER message.

Default: false

enable_congestion_managementbooleanoptional

Indicates if congestion management would be enabled.

Default: true

congestion_management_metricstring · enumoptional

Precondition: "enable_congestion_management" parameter MUST be set to true. The recommended is WAIT_TIME based on the expected wait time for each FIFO.

• WAIT_TIME:
• TIME_DEPTH:
• SIZE:

Available options:

congestion_management_toleranceinteger · int32optional

Precondition: "enable_congestion_management" parameter MUST be set to true. Congestion management tolerance for the given metric. This parameter determines when the Rejection Behavior changes.

Default: 600

enable_create_non_exist_extensionbooleanoptional

Indicates if the extension would be automatically created when a non-existent extension try to register. If it is set to true, when a non-included extension tries to send registry message to PBX, the PBX will create the extension with default password "portsip" automatically.

Default: false

enable_prackbooleanoptional

Enable prack or not.

Default: false

enable_tenant_level_trunkbooleanoptional

Whether to enable tenant-level trunk.

Default: true

enable_diversion_supportbooleanoptional

Enable Diversion support or not (RFC 5806).

Default: false

enable_history_info_supportbooleanoptional

Enable History-Info support (RFC 7044).

Default: false

enable_outbound_supportbooleanoptional

Enable Outbound Support or not (RFC 5626).

Default: true

flow_timerinteger · int32optional

The flow timer interval in seconds.

Default: 0

register_expiration_timeinteger · min: 90 · max: 3600optional

The register expiration time in seconds.

Default: 300

enable_auto_answer_alert_info_headerbooleanoptional

Enable call-info header for auto answer or not.

Default: false

auto_answer_alert_info_headerstring · enumoptional

Alert-info header to be added in INVITE message when PBX is forwarding the page/intercom. Values includes:

• INTERCOM: info=intercom.
• ALERT_AUTO_ANSWER: Alert-Info:;info=alert-autoanswer;delay=0.
• AUTO_ANSWER: info=Auto Answer.

Available options:

enable_auto_answer_call_info_headerbooleanoptional

Enable call-info header for auto answer. The value is "sip:portsip.com;answer-after=0".

Default: true

enable_require_answer_modebooleanoptional

Enable Require Answer Mode (RFC 5373) for auto answer.

Default: false

enable_www_authbooleanoptional

Enable WWW authentication or not.

Default: false

user_equal_required_for_auth_namebooleanoptional

User equal required for authentication name.

Default: true

trace_server_hoststringoptional

Tracer server host.

trace_server_portall ofoptional

The tracer server port.

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

web_failed_auth_amountinteger · int32optional

Block if failed to login PortSIP PBX Web more than this times.

Default: 5

web_blacklist_time_intervalinteger · int32optional

The web blocked time in seconds.

Default: 3600

sip_failed_auth_amountinteger · int32optional

The number of authentication failures.

Default: 50

sip_failed_challenge_requests_amountinteger · int32optional

DOS attacks can send REGISTER/INVITE requests but do not reply to Challenge (407). Configure the amount of "fake" requests that PortSIP PBX will accept per IP Address. If this value is exceeded in "Detection Period" interval the source IP address is put in the Blacklist. IP will remain blacklisted till "SIP Blacklist time interval" expires.

Default: 1000

sip_blacklist_time_intervalinteger · int32optional

The sip blocked time in seconds.

Default: 3600

sip_detection_periodinteger · int32optional

The detection period in seconds.

Default: 10

sip_barrier_1_packetsinteger · int32optional

If the amount of packets is exceeded, the PBX will block the source IP for "Level 1 blacklist time interval" seconds.

Default: 5000

sip_barrier_1_blocking_timeinteger · int32optional

This is the time interval in seconds that an abusive IP Address remains in the blacklist

Default: 3600

sip_barrier_2_packetsinteger · int32optional

If the amount of packets is exceeded, the PBX will block the source IP for "Level 2 blacklist time interval" seconds.

Default: 2000

sip_barrier_2_blocking_timeinteger · int32optional

This is the time interval in seconds that an abusive IP Address remains in the blacklist

Default: 30

stir_shaken_certstringoptional

Content of this certificate file for STIR/SHAKEN support.

stir_shaken_keystringoptional

Content of this private certificate file for STIR/SHAKEN support.

custom_optionsstringoptional

Some custom configuration options serialized as json string.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/admin/settings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_agent": "text",
    "blocked_user_agents": "text",
    "enable_shared_address_space_address_range": true,
    "enable_digest_auth": true,
    "enable_auth_mid_dialog": true,
    "enable_digest_auth_int": true,
    "enable_external_recording": true,
    "enable_reject_bad_nonce": true,
    "statistics_log_interval": 1,
    "dead_session_timeout": 1,
    "enable_session_timer": true,
    "session_timer_duration": 1,
    "enable_to_tag_in_register": true,
    "enable_congestion_management": true,
    "congestion_management_metric": "WAIT_TIME",
    "congestion_management_tolerance": 1,
    "enable_create_non_exist_extension": true,
    "enable_prack": true,
    "enable_tenant_level_trunk": true,
    "enable_diversion_support": true,
    "enable_history_info_support": true,
    "enable_outbound_support": true,
    "flow_timer": 1,
    "register_expiration_time": 1,
    "enable_auto_answer_alert_info_header": true,
    "auto_answer_alert_info_header": "INTERCOM",
    "enable_auto_answer_call_info_header": true,
    "enable_require_answer_mode": true,
    "enable_www_auth": true,
    "user_equal_required_for_auth_name": true,
    "trace_server_host": "text",
    "trace_server_port": 80,
    "web_failed_auth_amount": 1,
    "web_blacklist_time_interval": 1,
    "sip_failed_auth_amount": 1,
    "sip_failed_challenge_requests_amount": 1,
    "sip_blacklist_time_interval": 1,
    "sip_detection_period": 1,
    "sip_barrier_1_packets": 1,
    "sip_barrier_1_blocking_time": 1,
    "sip_barrier_2_packets": 1,
    "sip_barrier_2_blocking_time": 1,
    "stir_shaken_cert": "text",
    "stir_shaken_key": "text",
    "custom_options": "text"
  }'

200

4XX

200

No body

OK