Master Settings API provides functionality to display all the configuration parameters of the Virtualizor master server.
Virtualizor supports master slave cluster architecture. Master settings are the global settings, which means any settings saved on master will reflect on all of its slave servers.
There are many settings which are available in master settings as well as slave settings so Virtualizor will give preference to the master settings until the same setting is saved for the slave setting.
HTTP Request
https://hostname:4085/index.php?act=config
Parameters
| Name | Method | Value | Description | Required |
|---|---|---|---|---|
| act | GET | config | The action will return data regarding the master configuration of the Virtualizor server | Yes |
Sample Code
<?php
require_once('/usr/local/virtualizor/sdk/admin.php');
$key = 'your_api_key';
$pass = 'your_api_pass';
$ip = 'your_server_ip';
$admin = new Virtualizor_Admin_API($ip, $key, $pass);
$output = $admin->config();
print_r(json_encode($output));
?>Output
{
"title": "Configuration",
"globals": {
"path": "/usr/local/virtualizor",
"slave": 0,
"masterkey": "",
"masterip": "",
"key": "master-api-key",
"pass": "master-api-pass",
"kernel": "kvm",
"lv": "",
"thin_lv": "",
"disk_path": "",
"dbhost": "localhost",
"db": "virtualizor",
"dbuser": "root",
"dbpass": "xxxx",
"sn": "Virtualizor",
"cookie_name": "SIMCookies7614",
"gzip": 1,
"cpu_nm": 1,
"overcommit": 0,
"language": "english",
"soft_email": "samplemail@virtualizor.com",
"theme_folder": "default",
"timezone": "0",
"update": 1,
"email_update": 1,
"email_update_client": 0,
"cron_time": "3 11 * * *",
"emps_cron_time": "46 18 6,21 * *",
"logo_url": "",
"logo_login_url": "",
"mail": 1,
"mail_server": "",
"mail_port": "",
"mail_user": "",
"mail_pass": "",
"mail_smtp_secure": 0,
"mail_debug": 0,
"mail_connect_timeout": 0,
"off": 0,
"off_subject": "",
"off_message": "",
"admin_logs": 180,
"vps_logs": 180,
"login_logs": 180,
"system_logs": 90,
"status_logs": 90,
"bandwidth_logs": 0,
"sess_len": 10000,
"copyright": "",
"interface": "",
"xen_pvbridge": "",
"xen_hvmbridge": "",
"xen_dom0mem": 0,
"use_xl": "",
"ipadd": "",
"netmask": "",
"gateway": "",
"ip6add": "",
"gateway6": "",
"int_bridge": "",
"int_ipadd": "",
"int_netmask": "",
"login_attempts": 5,
"login_ban_time": 15,
"alert_load_limit": 0,
"alert_disk_limit": 0,
"vswap": 0,
"noc_apikey": "",
"noc_apipass": "",
"disable_webuzo": "",
"disabled_scripts": "",
"disable_icons_monitor": 0,
"disable_icons_cp": 0,
"disable_email": 0,
"node_bandwidth": 0,
"vps_bandwidth_threshold": 90,
"change_ssh_port": 0,
"max_ssh_login": 0,
"vnc_ip": "192.168.1.240",
"ping_ip": "",
"distro": "",
"dhcp_interface": "",
"support": "",
"addvs_io_class": "",
"addvs_io_prio": "",
"addvs_cpu_prio": "",
"vpslimit": "",
"ploop": 0,
"enable_tuntap_cp": 0,
"enable_ppp_cp": 0,
"enable_fuse_cp": 0,
"enable_ipip_cp": 0,
"enable_ipgre_cp": 0,
"enable_nfs_cp": 0,
"enable_quotaugidlimit_cp": 0,
"enable_iolimit_cp": 0,
"enable_iopslimit_cp": 0,
"enable_enduser_vnc": 0,
"show_server": 0,
"band_suspend": 0,
"speed_cap_disable": 0,
"is_master_only": 0,
"xcp_lv_prefix": "",
"novnc": 1,
"novnc_master_only": 0,
"novnc_server_name": 0,
"queue_creation": 0,
"disable_dd_flags": 0,
"dbbackup_email": "",
"dbbackup_cron": "",
"dbbackup_type": "EMAIL",
"dbbackup_server": 0,
"dbbackup_server_dir": "",
"is_cloud": "",
"bridge": "viifbr0",
"pv_on_hvm": 0,
"band_calc_creation": 0,
"no_ebtables_on_plans": "",
"master_name": "",
"inodes_gb": "",
"openvz_suspend_load": 0,
"disable_login_logo": 0,
"enable_rdns": 0,
"disable_backup_cp": 0,
"auto_add_zone": 0,
"enable_console": 0,
"curl_timeout": "",
"del_novps_user": 0,
"del_slave_ostemplate": 0,
"disable_master_vpsname": 0,
"showsearch": 0,
"site_domain": "",
"use_new_theme": "",
"turnoff_virtdf": 1,
"disable_newtheme": 0,
"disable_recipes": 0,
"enable_virtio": 0,
"disable_suspend_email": 0,
"enable_idsort": 0,
"del_tasks": 0,
"disable_apicredential": 0,
"disable_rescue": 0,
"disable_change_hostname": 0,
"disable_change_password": 0,
"disable_vps_config": 0,
"disable_os_reinstall": 0,
"disable_ssh": 0,
"disable_java_vnc": 0,
"disable_self_shutdown": 0,
"disable_server_location": 0,
"disable_enduser_sshkeys": 0,
"disable_vga": 0,
"enable_nic": 0,
"cb_hash": "master_callback_hash",
"enable_cb": 0,
"cb_use_https": 0,
"cb_url": "",
"cb_suspend": 0,
"cb_unsuspend": 0,
"cb_hostname": 0,
"cb_terminate": 0,
"cb_changeips": 0,
"default_sg_name": "",
"default_sg_reseller_name": "",
"default_sg_desc": "",
"custom_mac": "",
"cloud_allow_virtio": 0,
"le_primary_domain": "",
"le_contact_email": "",
"le_key_size": 4096,
"le_renew_days": 80,
"le_staging": 0,
"le_enable_force": 0,
"2fa_email_otp": 0,
"enable_2fa": 0,
"eu_allow_virtio": 0,
"keep_orphan_template": 0,
"pass_strength": 0,
"haproxy_enable": 0,
"haproxy_src_ips": "202.168.147.144",
"haproxy_reservedports": "",
"haproxy_reservedports_http": "80,443",
"haproxy_allowedports": "",
"haproxy_cron_logs": 7,
"backup_queue": 0,
"restore_queue": 0,
"server_latitude": 0,
"server_longitude": 0,
"disable_nw_config": 0,
"enable_eu_iso": 0,
"eu_iso_size": "",
"eu_iso_limit": "",
"eu_iso_space": "",
"eu_iso_del_hr": "",
"secure_allowed_ips": "",
"backup_email": "",
"backup_disable_success_mail": 0,
"disable_virttop": 0,
"set_def_hvm": 0,
"memory_limit": 0,
"proxmox_server_pass": "",
"proxmox_server_name": "",
"proxmox_server_pass_salt": "",
"max_ips": 250,
"cp_url": "http://",
"inhouse_billing": 0,
"enable_registration": 0,
"user_pass_min_char": 8,
"support_email": "",
"default_uplid": 0,
"billing_warn_bal": 80,
"billing_currency": "USD",
"billing_symbol": "$",
"billing_min": "50",
"billing_max": "1000",
"billing_day": 0,
"billing_comp": "",
"billing_addr1": "",
"billing_addr2": "",
"paypal_account": "",
"paypal_api_user": "",
"paypal_api_pass": "",
"paypal_api_sig": "",
"paypal_env": "",
"captcha_secret": "",
"captcha_sitekey": "",
"resource_pricing": "",
"recipe_shell": "#!/bin/sh",
"hf_loaded": 1,
"charset": "UTF-8",
"showntimetaken": 1,
"version": "2.9.7",
"patch": "0",
"license": "master-licence-info",
"port": 4082,
"vpsid": 0,
"index": "index.php?",
"server": 0,
"queries": 0,
"docs": "https://www.virtualizor.com/wiki/",
"apiurl": "https://api.virtualizor.com/",
"openvzos": "/vz/template/cache",
"xenos": "/var/virtualizor/xen",
"kvmos": "/var/virtualizor/kvm",
"xcpos": "/var/virtualizor/xcp",
"lxcos": "/var/virtualizor/lxc",
"proxoos": "/var/virtualizor/proxo",
"proxkos": "/var/virtualizor/proxk",
"proxlos": "/var/virtualizor/proxl",
"vzoos": "/vz/template/cache",
"vzkos": "/var/virtualizor/vzk",
"isos": "/var/virtualizor/iso",
"euisos": "/var/virtualizor/euiso",
"virtualboxos": "/var/virtualizor/virtualbox",
"var": "/var/virtualizor",
"lxc_path": "/var/lib/lxc/",
"virts": {
"openvz": "openvz",
"xen": "xen",
"xenhvm": "xenhvm",
"kvm": "kvm",
"xcp": "xcp",
"xcphvm": "xcphvm",
"lxc": "lxc",
"proxo": "proxo",
"proxk": "proxk",
"proxl": "proxl",
"vzk": "vzk",
"vzo": "vzo"
},
"mainfiles": "/usr/local/virtualizor/main",
"adminfiles": "/usr/local/virtualizor/admin",
"themes": "/usr/local/virtualizor/enduser/themes",
"runtime_theme": "api",
"webuzo_scripts": "/var/virtualizor/webuzo_scripts",
"_disabled_scripts": [],
"notupdated_task": 3600,
"os": "linux",
"com": {
"vgdisplay": "/sbin/vgdisplay",
"lvdisplay": "/sbin/lvdisplay",
"lvscan": "/sbin/lvscan",
"lvcreate": "/sbin/lvcreate",
"lvremove": "/sbin/lvremove",
"resizefs": "/sbin/resize2fs",
"php": "/usr/local/emps/bin/php",
"pgzip": "/bin/gzip"
},
"vcores": 0,
"resource_types": [
"space",
"cores",
"ram",
"ips"
],
"HTTP_HOST": "192.168.1.240",
"lictype": "-1",
"lictype_txt": "Trial",
"active": 1,
"active_txt": "Active",
"licnumvs": "0",
"primary_ip": "127.127.127.1",
"licexpires": "20180930",
"licexpires_txt": "30/09/2018 GMT",
"last_edit": "1530596724",
"fast_mirrors": [
"https://s1.softaculous.com/a/virtualizor",
"https://s2.softaculous.com/a/virtualizor",
"https://s3.softaculous.com/a/virtualizor",
"https://s4.softaculous.com/a/virtualizor",
"https://s7.softaculous.com/a/virtualizor"
],
"pgtimezone": 0,
"apicall": "kjuba4ui",
"apidata": [],
"ind": "index.php?"
},
"info": {
"path": "/usr/local/virtualizor",
"slave": 0,
"masterkey": "",
"masterip": "",
"key": "master-api-key",
"pass": "master-api-pass",
"kernel": "kvm",
"lv": "",
"thin_lv": "",
"disk_path": "",
"dbhost": "localhost",
"db": "virtualizor",
"dbuser": "root",
"dbpass": "database-password",
"sn": "Virtualizor",
"cookie_name": "SIMCookies7614",
"gzip": 1,
"cpu_nm": 1,
"overcommit": 0,
"language": "english",
"soft_email": "samplemail@virtualizor.com",
"theme_folder": "default",
"timezone": "0",
"update": 1,
"email_update": 1,
"email_update_client": 0,
"cron_time": "3 11 * * *",
"emps_cron_time": "46 18 6,21 * *",
"logo_url": "",
"logo_login_url": "",
"mail": 1,
"mail_server": "",
"mail_port": "",
"mail_user": "",
"mail_pass": "",
"mail_smtp_secure": 0,
"mail_debug": 0,
"mail_connect_timeout": 0,
"off": 0,
"off_subject": "",
"off_message": "",
"admin_logs": 180,
"vps_logs": 180,
"login_logs": 180,
"system_logs": 90,
"status_logs": 90,
"bandwidth_logs": 0,
"sess_len": 10000,
"copyright": "",
"interface": "",
"xen_pvbridge": "",
"xen_hvmbridge": "",
"xen_dom0mem": 0,
"use_xl": "",
"ipadd": "",
"netmask": "",
"gateway": "",
"ip6add": "",
"gateway6": "",
"int_bridge": "",
"int_ipadd": "",
"int_netmask": "",
"login_attempts": 5,
"login_ban_time": 15,
"alert_load_limit": 0,
"alert_disk_limit": 0,
"vswap": 0,
"noc_apikey": "",
"noc_apipass": "",
"disable_webuzo": "",
"disabled_scripts": "",
"disable_icons_monitor": 0,
"disable_icons_cp": 0,
"disable_email": 0,
"node_bandwidth": 0,
"vps_bandwidth_threshold": 90,
"change_ssh_port": 0,
"max_ssh_login": 0,
"vnc_ip": "192.168.1.240",
"ping_ip": "",
"distro": "",
"dhcp_interface": "",
"support": "",
"addvs_io_class": "",
"addvs_io_prio": "",
"addvs_cpu_prio": "",
"vpslimit": "",
"ploop": 0,
"enable_tuntap_cp": 0,
"enable_ppp_cp": 0,
"enable_fuse_cp": 0,
"enable_ipip_cp": 0,
"enable_ipgre_cp": 0,
"enable_nfs_cp": 0,
"enable_quotaugidlimit_cp": 0,
"enable_iolimit_cp": 0,
"enable_iopslimit_cp": 0,
"enable_enduser_vnc": 0,
"show_server": 0,
"band_suspend": 0,
"speed_cap_disable": 0,
"is_master_only": 0,
"xcp_lv_prefix": "",
"novnc": 1,
"novnc_master_only": 0,
"novnc_server_name": 0,
"queue_creation": 0,
"disable_dd_flags": 0,
"dbbackup_email": "",
"dbbackup_cron": "",
"dbbackup_type": "EMAIL",
"dbbackup_server": 0,
"dbbackup_server_dir": "",
"is_cloud": "",
"bridge": "viifbr0",
"pv_on_hvm": 0,
"band_calc_creation": 0,
"no_ebtables_on_plans": "",
"master_name": "",
"inodes_gb": "",
"openvz_suspend_load": 0,
"disable_login_logo": 0,
"enable_rdns": 0,
"disable_backup_cp": 0,
"auto_add_zone": 0,
"enable_console": 0,
"curl_timeout": "",
"del_novps_user": 0,
"del_slave_ostemplate": 0,
"disable_master_vpsname": 0,
"showsearch": 0,
"site_domain": "",
"use_new_theme": "",
"turnoff_virtdf": 1,
"disable_newtheme": 0,
"disable_recipes": 0,
"enable_virtio": 0,
"disable_suspend_email": 0,
"enable_idsort": 0,
"del_tasks": 0,
"disable_apicredential": 0,
"disable_rescue": 0,
"disable_change_hostname": 0,
"disable_change_password": 0,
"disable_vps_config": 0,
"disable_os_reinstall": 0,
"disable_ssh": 0,
"disable_java_vnc": 0,
"disable_self_shutdown": 0,
"disable_server_location": 0,
"disable_enduser_sshkeys": 0,
"disable_vga": 0,
"enable_nic": 0,
"cb_hash": "master-cb-hash",
"enable_cb": 0,
"cb_use_https": 0,
"cb_url": "",
"cb_suspend": 0,
"cb_unsuspend": 0,
"cb_hostname": 0,
"cb_terminate": 0,
"cb_changeips": 0,
"default_sg_name": "",
"default_sg_reseller_name": "",
"default_sg_desc": "",
"custom_mac": "",
"cloud_allow_virtio": 0,
"le_primary_domain": "",
"le_contact_email": "",
"le_key_size": 4096,
"le_renew_days": 80,
"le_staging": 0,
"le_enable_force": 0,
"2fa_email_otp": 0,
"enable_2fa": 0,
"eu_allow_virtio": 0,
"keep_orphan_template": 0,
"pass_strength": 0,
"haproxy_enable": 0,
"haproxy_src_ips": "202.168.147.144",
"haproxy_reservedports": "",
"haproxy_reservedports_http": "80,443",
"haproxy_allowedports": "",
"haproxy_cron_logs": 7,
"backup_queue": 0,
"restore_queue": 0,
"server_latitude": 0,
"server_longitude": 0,
"disable_nw_config": 0,
"enable_eu_iso": 0,
"eu_iso_size": "",
"eu_iso_limit": "",
"eu_iso_space": "",
"eu_iso_del_hr": "",
"secure_allowed_ips": "",
"backup_email": "",
"backup_disable_success_mail": 0,
"disable_virttop": 0,
"set_def_hvm": 0,
"memory_limit": 0,
"proxmox_server_pass": "",
"proxmox_server_name": "",
"proxmox_server_pass_salt": "",
"max_ips": 250,
"cp_url": "http://",
"inhouse_billing": 0,
"enable_registration": 0,
"user_pass_min_char": 8,
"support_email": "",
"default_uplid": 0,
"billing_warn_bal": 80,
"billing_currency": "USD",
"billing_symbol": "$",
"billing_min": "50",
"billing_max": "1000",
"billing_day": 0,
"billing_comp": "",
"billing_addr1": "",
"billing_addr2": "",
"paypal_account": "",
"paypal_api_user": "",
"paypal_api_pass": "",
"paypal_api_sig": "",
"paypal_env": "",
"captcha_secret": "",
"captcha_sitekey": "",
"resource_pricing": "",
"recipe_shell": "#!/bin/sh",
"vg_in_use": 1
},
"langs": {
"chinese": "chinese",
"dutch": "dutch",
"english": "english",
"french": "french",
"german": "german",
"polish": "polish",
"portuguese": "portuguese",
"russian": "russian",
"spanish": "spanish",
"ukraine": "ukraine"
},
"skins": {
"default": "default"
},
"timenow": 1536163383,
"time_taken": "0.233"
}