Description of TRASSIR Cloud connection settings

Request to get the settings:

https://[server_address]:[port]/settings/cloud/?sid=[session_id]

Response:

{
    "name" : "cloud",
    "type" : "Cloud40",
    "subdirs" : [
        "news",
        "stat"
    ],
    "values" : [
        "account_password",
        "account_username",
        "amerge_enable",
        "bind_to_cloud_user",
        "cloud_connect_enable",
        "cloud_enabled",
        "cloud_host_binding",
        "cloud_login",
        "cloudbackup_automatic",
        "cloudbackup_download_now",
        "cloudbackup_last_made",
        "cloudbackup_upload_now",
        "depersonalised_stats_enabled",
        "dtun_decay_timeout_sec",
        "dtun_hole_expire_timeout_sec",
        "dtun_hole_kpalive_count",
        "dtun_hole_kpalive_interval_sec",
        "dtun_max_holes",
        "dtun_num_fast_ports",
        "dtun_num_symm_ports",
        "dtun_probe_addr",
        "dtun_reconnect_timeout_sec",
        "dtun_rendezvous_addr",
        "enable_vtrassir",
        "export_ticket",
        "export_username",
        "force_refresh",
        "health_enable",
        "import_channels_enabled",
        "import_username",
        "import_users_enable",
        "import_password",
        "predefined_user_login",
        "predefined_user_password",
        "register",
        "send_test_email",
        "send_test_sms",
        "tube_facility",
        "tube_verbosity",
        "webdog_enable",
        "webdog_max_interval_minutes",
        "webdog_min_interval_minutes"
    ]
}

Table 112. 

subdirs Description TRASSIR
news   ≥3.1
stat   ≥3.1

Retrieve a value (R):

https://[server_address]:[port]/settings/cloud/[setting]?sid=[session_id]

Write a value (W):

https://[server_address]:[port]/settings/cloud/[setting]=[value]?sid=[session_id]

Table 113. 

values Description Type   TRASSIR
account_password

TRASSIR Cloud user password

 string RW 3.1-3.2
account_username

TRASSIR Cloud username

 string RW 3.1-3.2
amerge_enable

Archive merge to the cloud:

1 - enabled, 0 - disabled

integer R ≥3.2
bind_to_cloud_user

Bind to the cloud user:

1 - yes, 0 - no

integer RW ≥3.2
cloud_connect_enable

Cloud Connect enabled:

1 - yes, 0 - no

integer RW ≥3.2
cloud_enable

Cloud enabled:

1 - yes, 0 - no

integer RW 3.1
cloud_enabled

Cloud enabled:

1 - yes, 0 - no

integer RW ≥4.0
cloud_host       3.1
cloud_host_binding       3.3
cloud_login

Cloud user login enabled:

1 - yes, 0 - no

integer RW ≥3.3
cloudbackup_automatic

Automatic backup of the server configuration

 integer RW ≥3.2
cloudbackup_download_now   string RW ≥3.1
cloudbackup_last_made

Last server configuration cloud save

 string R ≥3.2
cloudbackup_upload_now   integer RW ≥3.2
depersonalised_stats_enabled

Anonymous stats enabled:

1 - yes, 0 - no

integer RW ≥3.2
dtun_decay_timeout_sec   integer R ≥4.1
dtun_hole_expire_timeout_sec   integer R ≥4.1
dtun_hole_kpalive_count   integer R ≥4.1
dtun_hole_kpalive_interval_sec   integer R ≥4.1
dtun_max_holes   integer R ≥4.1
dtun_num_fast_ports   integer R ≥4.1
dtun_num_symm_ports   integer R ≥4.1
dtun_probe_addr   string R ≥4.1
dtun_reconnect_timeout_sec   integer R ≥4.1
dtun_rendezvous_addr   string R ≥4.1
enable_vtrassir   string R 3.3
export_ticket   string R ≥3.3
export_username

User name in TRASSIR Cloud personal cabinet

 string R ≥3.3
force_refresh   integer R ≥3.3
health_enable   integer RW ≥3.2
import_channels_enabled

Display cloud channels:

1 - yes, 0 - no

integer RW ≥3.2
import_username   string R ≥3.2
import_users_enable   integer R ≥3.2
import_password   integer R 3.2
predefined_user

TRASSIR Cloud local user login

1 - enabled, 0 - disabled

integer RW ≥3.2
predefined_user_login

TRASSIR Cloud local username

 string RW ≥3.2
predefined_user_password

TRASSIR Cloud local user password

 string R ≥3.2
register   string RW 3.2
send_test_email

Send test email

 integer RW 3.2
send_test_sms

Send test SMS

 integer RW 3.2
tube_facility   string RW 3.1
tube_verbosity   integer RW ≥3.1
webdog_enable     R 3.1
webdog_max_interval_minutes   integer R ≥3.2
webdog_min_interval_minutes   integer R ≥3.2

Request to get the settings:

https://[server_address]:[port]/settings/cloud/news/?sid=[session_id]

Response:

{
    "name" : "news",
    "type" : "CloudNews",
    "subdirs" : [

    ],
    "values" : [
        "url"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/cloud/news/[setting]?sid=[session_id]

Table 114. 

values Description Type   TRASSIR
url

http://trassir.com

 string R ≥3.1

Request for connection state parameters

https://[server_address]:[port]/settings/cloud/stat/?sid=[session_id]

Response:

{
    "name" : "stat",
    "type" : "CloudStat40",
    "subdirs" : [

    ],
    "values" : [
        "balance",
        "balance_received",
        "cloud_backups",
        "cloud_license_backup",
        "cloudbackup_download_progress",
        "cloudbackup_upload_progress",
        "export_accounts",
        "import_accounts",
        "kicked_out",
        "last_error_code",
        "last_error_code_bkp",
        "last_error_code_cc",
        "last_error_code_cl",
        "last_health_report",
        "last_login",
        "last_registration_result",
        "local_httpserver_port",
        "redirector_state",
        "update_message",
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/cloud/stat/[setting]?sid=[session_id]

Table 115. 

values Description Type   TRASSIR
balance

Current balance

 string R ≥3.1
balance_received

Balance refilled:

1 - yes, 0 - no

integer R ≥4.0
cloud_backups

Cloud backups

 string R ≥3.2
cloud_license_backup

Cloud license backup:

1 - yes, 0 - no

integer R ≥4.0
cloudbackup_download_progress   integer R ≥3.2
cloudbackup_upload_progress   integer R ≥3.2
connected

Connection established

 integer R 3.1
export_accounts   string R ≥4.0
import_accounts   string R ≥4.0
kicked_out   integer R ≥4.0
last_error_code

Last error code

 string R ≥3.1
last_error_code_bkp

Last backup copy error code

 string R ≥4.0
last_error_code_cc   string R ≥4.0
last_error_code_cl   string R ≥4.0
last_health_report

Last health status report

 string R ≥3.2
last_health_report

Last authorization

 string R ≥3.2
last_registration_result   string R 3.2
local_httpserver_port

HTTP server port

 integer R ≥4.0
redirector_state   string R ≥4.0
update_message

Update message

 string R ≥4.0

See also