Settings

Retrieve system settings

Retrieve settings for PortSIP PBX.

GEThttp://127.0.0.1:8888/api/admin/settings

Response

2004XX

OK

Body

application/json

user_agentstring

User agent.

blocked_user_agentsstring

The semicolon separated list of blocked user agents.

enable_shared_address_space_address_rangeboolean

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

enable_digest_authboolean

Indicates if DIGEST authentication would be enabled.

enable_auth_mid_dialogboolean

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

enable_digest_auth_intboolean

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

enable_external_recordingboolean

Allow external calls recording.

enable_reject_bad_nonceboolean

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.

statistics_log_intervalinteger (int32)

Interval for statistics logs, in seconds.

dead_session_timeoutinteger (int32)

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

enable_session_timerboolean

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

session_timer_durationinteger (int32)

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

enable_to_tag_in_registerboolean

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

enable_congestion_managementboolean

Indicates if congestion management would be enabled.

congestion_management_metricenum

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:

WAIT_TIMETIME_DEPTHSIZE

congestion_management_toleranceinteger (int32)

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.

enable_create_non_exist_extensionboolean

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.

enable_prackboolean

Enable prack or not.

enable_tenant_level_trunkboolean

Whether to enable tenant-level trunk.

enable_diversion_supportboolean

Enable Diversion support or not (RFC 5806).

enable_history_info_supportboolean

Enable History-Info support (RFC 7044).

enable_outbound_supportboolean

Enable Outbound Support or not (RFC 5626).

flow_timerinteger (int32)

The flow timer interval in seconds.

register_expiration_timeinteger

The register expiration time in seconds.

enable_auto_answer_alert_info_headerboolean

Enable call-info header for auto answer or not.

auto_answer_alert_info_headerenum

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.

INTERCOMALERT_AUTO_ANSWERAUTO_ANSWER

enable_auto_answer_call_info_headerboolean

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

enable_require_answer_modeboolean

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

enable_www_authboolean

Enable WWW authentication or not.

user_equal_required_for_auth_nameboolean

User equal required for authentication name.

trace_server_hoststring

Tracer server host.

trace_server_portall of

The tracer server port.

web_failed_auth_amountinteger (int32)

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

web_blacklist_time_intervalinteger (int32)

The web blocked time in seconds.

sip_failed_auth_amountinteger (int32)

The number of authentication failures.

sip_failed_challenge_requests_amountinteger (int32)

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.

sip_blacklist_time_intervalinteger (int32)

The sip blocked time in seconds.

sip_detection_periodinteger (int32)

The detection period in seconds.

sip_barrier_1_packetsinteger (int32)

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

sip_barrier_1_blocking_timeinteger (int32)

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

sip_barrier_2_packetsinteger (int32)

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

sip_barrier_2_blocking_timeinteger (int32)

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

custom_optionsstring

Some custom configuration options serialized as json string.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/admin/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "user_agent": "PortSIP UC",
  "blocked_user_agents": "text",
  "enable_shared_address_space_address_range": true,
  "enable_digest_auth": true,
  "enable_auth_mid_dialog": false,
  "enable_digest_auth_int": false,
  "enable_external_recording": true,
  "enable_reject_bad_nonce": false,
  "enable_session_timer": true,
  "enable_to_tag_in_register": false,
  "enable_congestion_management": true,
  "congestion_management_metric": "WAIT_TIME",
  "enable_create_non_exist_extension": false,
  "enable_prack": false,
  "enable_tenant_level_trunk": true,
  "enable_diversion_support": false,
  "enable_history_info_support": false,
  "enable_outbound_support": true,
  "enable_auto_answer_alert_info_header": false,
  "auto_answer_alert_info_header": "INTERCOM",
  "enable_auto_answer_call_info_header": true,
  "enable_require_answer_mode": false,
  "enable_www_auth": false,
  "user_equal_required_for_auth_name": true,
  "trace_server_host": "text",
  "trace_server_port": {},
  "custom_options": "text"
}

Update system settings

Update settings for PortSIP PBX

POSThttp://127.0.0.1:8888/api/admin/settings

Body

application/json

user_agentstring

User agent.

blocked_user_agentsstring

The semicolon separated list of blocked user agents.

enable_shared_address_space_address_rangeboolean

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

enable_digest_authboolean

Indicates if DIGEST authentication would be enabled.

enable_auth_mid_dialogboolean

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

enable_digest_auth_intboolean

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

enable_external_recordingboolean

Allow external calls recording.

enable_reject_bad_nonceboolean

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.

statistics_log_intervalinteger (int32)

Interval for statistics logs, in seconds.

dead_session_timeoutinteger (int32)

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

enable_session_timerboolean

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

session_timer_durationinteger (int32)

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

enable_to_tag_in_registerboolean

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

enable_congestion_managementboolean

Indicates if congestion management would be enabled.

congestion_management_metricenum

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:

WAIT_TIMETIME_DEPTHSIZE

congestion_management_toleranceinteger (int32)

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.

enable_create_non_exist_extensionboolean

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.

enable_prackboolean

Enable prack or not.

enable_tenant_level_trunkboolean

Whether to enable tenant-level trunk.

enable_diversion_supportboolean

Enable Diversion support or not (RFC 5806).

enable_history_info_supportboolean

Enable History-Info support (RFC 7044).

enable_outbound_supportboolean

Enable Outbound Support or not (RFC 5626).

flow_timerinteger (int32)

The flow timer interval in seconds.

register_expiration_timeinteger

The register expiration time in seconds.

enable_auto_answer_alert_info_headerboolean

Enable call-info header for auto answer or not.

auto_answer_alert_info_headerenum

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.

INTERCOMALERT_AUTO_ANSWERAUTO_ANSWER

enable_auto_answer_call_info_headerboolean

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

enable_require_answer_modeboolean

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

enable_www_authboolean

Enable WWW authentication or not.

user_equal_required_for_auth_nameboolean

User equal required for authentication name.

trace_server_hoststring

Tracer server host.

trace_server_portall of

The tracer server port.

web_failed_auth_amountinteger (int32)

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

web_blacklist_time_intervalinteger (int32)

The web blocked time in seconds.

sip_failed_auth_amountinteger (int32)

The number of authentication failures.

sip_failed_challenge_requests_amountinteger (int32)

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.

sip_blacklist_time_intervalinteger (int32)

The sip blocked time in seconds.

sip_detection_periodinteger (int32)

The detection period in seconds.

sip_barrier_1_packetsinteger (int32)

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

sip_barrier_1_blocking_timeinteger (int32)

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

sip_barrier_2_packetsinteger (int32)

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

sip_barrier_2_blocking_timeinteger (int32)

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

custom_optionsstring

Some custom configuration options serialized as json string.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/admin/settings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();