Description of network settings

Request to get the settings:

https://[address_server]:[port]/settings/network/?sid=[id_session]

Response:

{
    "name" : "network",
    "type" : "NetworkFolder",
    "subdirs" : [
        "cloudtrassir",
        "IfSn4Y9n",
        "network_node_add"
    ],
    "values" : [
        "banned_server_guid",
        "cloud_connect_enable",
        "cloud_connect_login",
        "icon",
        "cloud_connect_password",
        "limit_client_count",
        "offline_passwords",
        "upnp_gate",
        "upnp_prefix",
        "video_protection_level"
    ]
}

Table 156.

subdirs	Description	TRASSIR
cloudtrassir	Cloud connection	3.3
[GUID_connection]	Connection ID	≥3.1
network_node_add	Add new connection	≥3.1

Retrieve a value (R):

https://[address_server]:[port]/settings/network/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/network/[settings]=[value]?sid=[id_session]

Table 157.

values	Description	Type		TRASSIR
banned_server_guids				≥4.0
cloud_connect_enable	Connection via Cloud Connect: 0 - no, 1 - yes	integer	RW	≥3.2
cloud_connect_login	Cloud user	string	RW	≥3.2
cloud_connect_login	Password of cloud user	string	W	≥3.2
icon	Network connection icon path	string	RW	≥3.1
limit_client_count	Maximal number of connections to this server	string	RW	≥3.2
mmauth_available		integer	R	≥3.2
offline_passwords				≥4.0
upnp_gate		string	RW	≥4.0
upnp_prefix		string	RW	≥4.0
video_protection_level		integer	RW	≥4.1

Request to get connection settings:

https://[address_server]:[port]/settings/network/[GUID_connection]/?sid=[id_session]

Response:

{
    "name" : "IfSn4Y9n",
    "type" : "NetworkNode",
    "subdirs" : [
        "stats"
    ],
    "values" : [
        "accepted_fingerprint",
        "address_from_cc_success",
        "autocredentials",
        "buffering",
        "cc_mode",
        "cloud_id",
        "disable_mainstream",
        "economy_mode",
        "generated",
        "icon",
        "ip_address",
        "ip_addresses",
        "last_cc_timestamp",
        "name",
        "network_recurse_level",
        "origin_account",
        "password",
        "port_rpc",
        "port_video",
        "reachable_via_this_node",
        "should_be_connected",
        "use_cloud_connect",
        "username"
    ]
}

Table 158.

subdirs	Description	TRASSIR
stats	Connection info	≥3.1

Retrieve a value (R):

https://[address_server]:[port]/settings/network/[GUID_connection]/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/network/[GUID_connection]/[setting]=[value]?sid=[id_session]

Table 159.

values	Description	Type		TRASSIR
accepted_fingerprint	SSL Fingerprint	string	RW	≥3.1
address_from_cc_success		integer	RW	≥3.3
autocredentials	Local Cloud user automatic login: 0 - no, 1 - yes	integer	RW	≥3.3
buffering		integer	RW	≥3.1
cc_mode	Cloud Connect connection mode: 0 - auto, 1 - P2P only, 2 - enable DTUN	string	RW	≥4.0
cloud_id	Cloud identifier	string	RW	≥3.1
disable_mainstream	Main stream disabled on all channels: 0 - no, 1 - yes	integer	RW	≥3.1
economy_mode	Economy mode is on: 0 - no, 1 - yes	integer	RW	≥3.1
generated	Connection generated by script: 0 - no, 1 - yes	integer	RW	≥3.3
icon	Icon path	string	RW	≥3.1
ip_address	Connection IP address	string	RW	≥3.1
ip_addresses		string	RW	3.3
last_cc_timestamp	Cloud Connect last login time	string	RW	≥3.3
name	Connection name	string	RW	≥3.1
network_recurse_level	Recursion level	integer	RW	≥3.1
origin_account	Cloud account	string	R	≥4.0
password	Password	string	W	≥3.1
port_rpc	Port (control)	integer	RW	≥3.1
port_video	Port (video)	integer	RW	≥3.1
reachable_via_this_node		string	R	≥3.1
should_be_connected	Allow connection: 0 - no, 1 - yes	integer	RW	≥3.1
use_cloud_connect	Cloud Connect connection is used: 0 - no, 1 - yes	integer	RW	≥3.2
username	User name	string	RW	≥3.1

Connection info request:

https://[address_server]:[port]/settings/network/[GUID_connection]/stats/?sid=[id_session]

Response:

{
    "name" : "stats",
    "type" : "NetworkNodeStats",
    "subdirs" : [

    ],
    "values" : [
        "connected",
        "connected_using",
        "dtun_connection",
        "fingerprint",
        "interface_version",
        "last_error",
        "relay_connection",
        "resolve_warning",
        "trail_connection"
    ]
}

Retrieve a value (R):

https://[address_server]:[port]/settings/network/[GUID_connection]/stats/[setting]?sid=[id_session]

Table 160.

values	Description	Type		TRASSIR
connected	Connection established: 0 - no, 1 - yes	integer	R	≥3.1
connected_using		string	R	≥4.0
dtun_connection	Connection via DTUN: 0 -disabled, 1 - enabled, -1 - host address connection method is selected	integer	R	≥4.1
fingerprint	Fingerprint	string	R	≥3.1
interface_version	Interface version	integer	R	≥4.0
last_error	Last error	string	R	≥3.1
relay_connection	Connection via Cloud	integer	R	≥4.0
resolve_warning		string	R	≥3.1
trail_connection		integer	RW	≥4.0

Request to create a new connection:

https://[address_server]:[port]/settings/network/network_node_add/?sid=[id_session]

Response:

{
    "name" : "network_node_add",
    "type" : "NetworkNodeAdd",
    "subdirs" : [

    ],
    "values" : [
        "create_now",
        "delete_node_id",
        "new_node_autocredentials",
        "new_node_cc_mode",
        "new_node_cloud_id",
        "new_node_economy",
        "new_node_generated",
        "new_node_id",
        "new_node_name",
        "new_node_password",
        "new_node_port_rpc",
        "new_node_port_video",
        "new_node_use_cloud_connect",
        "new_node_username",
        "new_origin_account"
    ]
}

Retrieve a value (R):

https://[address_server]:[port]/settings/network/network_node_add/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/network/network_node_add/[setting]=[value]?sid=[id_session]

Table 161.

values	Description	Type		TRASSIR
create_now	Create connection	integer	RW	≥3.1
create_now	Delete connection	integer	W	≥3.1
new_node_autocredentials	Automatic login under local user	string	W	≥3.3
new_node_cloud_id	New cloud identifier	string	W	≥3.3
new_node_cloud_id	New connection economy mode	string	W	≥3.3
new_node_generated		string	W	≥3.3
new_node_id	New connection identifier	string	W	≥3.1
new_node_name	New connection name or IP address	string	RW	≥3.1
new_node_password	Password	string	W	≥3.1
new_node_password	Port (control)	integer	RW	≥3.1
new_node_password	Port (video)	integer	RW	≥3.1
new_node_use_cloud_connect	New connection via Cloud Connect	integer	RW	≥3.2
new_node_use_cloud_connect	User name	string	W	≥3.1

Tip

Set up connection parameters and make the following request to add a new connection:

https://[server_address]:[port]/settings/network/network_node_add/create_now=1?sid=session_id

Server setting descriptions

Description of network settings

Tip

See also