pax_global_header 0000666 0000000 0000000 00000000064 13405013377 0014515 g ustar 00root root 0000000 0000000 52 comment=f66e8c9fdea10f7d3928516b1dd70f5b262070f4 ispconfig3-f66e8c9fdea10f7d3928516b1dd70f5b262070f4-remoting_client-API-docs/ 0000775 0000000 0000000 00000000000 13405013377 0025310 5 ustar 00root root 0000000 0000000 ispconfig3-f66e8c9fdea10f7d3928516b1dd70f5b262070f4-remoting_client-API-docs/remoting_client/ 0000775 0000000 0000000 00000000000 13405013377 0030472 5 ustar 00root root 0000000 0000000 API-docs/ 0000775 0000000 0000000 00000000000 13405013377 0031752 5 ustar 00root root 0000000 0000000 ispconfig3-f66e8c9fdea10f7d3928516b1dd70f5b262070f4-remoting_client-API-docs/remoting_client client_add.html 0000664 0000000 0000000 00000014500 13405013377 0034726 0 ustar 00root root 0000000 0000000 ispconfig3-f66e8c9fdea10f7d3928516b1dd70f5b262070f4-remoting_client-API-docs/remoting_client/API-docs
Description:
Adds a new client.
Input Variables:
$session_id, $reseller_id, $params
Parameters (in $params):
company_name (varchar(64))
contact_name (varchar(64))
customer_no (varchar(64))
vat_id (varchar(64))
street (varchar(255))
zip (varchar(32))
city (varchar(64))
state (varchar(32))
country (char(2))
telephone (varchar(32))
mobile (varchar(32))
fax (varchar(32))
email (varchar(255))
internet (varchar(255))
icq (varchar(16))
notes (text)
default_mailserver (int(11))
limit_maildomain (int(11))
limit_mailbox (int(11))
limit_mailalias (int(11))
limit_mailaliasdomain (int(11))
limit_mailforward (int(11))
limit_mailcatchall (int(11))
limit_mailrouting (int(11))
limit_mailfilter (int(11))
limit_fetchmail (int(11))
limit_mailquota (int(11))
limit_spamfilter_wblist (int(11))
limit_spamfilter_user (int(11))
limit_spamfilter_policy (int(11))
default_webserver (int(11))
limit_web_ip (text)
limit_web_domain (int(11))
limit_web_quota (int(11))
web_php_options (varchar(255))
limit_web_subdomain (int(11))
limit_web_aliasdomain (int(11))
limit_ftp_user (int(11))
limit_shell_user (int(11))
ssh_chroot (varchar(255))
limit_webdav_user (int(11))
default_dnsserver (int(11))
limit_dns_zone (int(11))
limit_dns_slave_zone (int(11))
limit_dns_record (int(11))
default_dbserver (int(11))
limit_database (int(11))
limit_cron (int(11))
limit_cron_type (enum('url','chrooted','full'))
limit_cron_frequency (int(11))
limit_traffic_quota (int(11))
limit_client (varchar(64))
parent_client_id (int(11))
username (varchar(64))
password (varchar(64))
language (char(2))
usertheme (varchar(32))
template_master (int(11))
template_additional (varchar(255))
created_at (bigint(20))
Output:
Returns the ID of the newly added Client.
Description:
Changes a client's password.
Input Variables:
$session_id, $client_id, $new_password
Parameters (in $params):
None
Output:
Returns '1' if password has been changed.
SQL Interaction:
"SELECT client_id FROM client WHERE client_id = ".$client_id
Description:
Deletes a client.
Input Variables:
$session_id, $client_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Deletes client.
Input Variables:
$session_id, $client_id
Parameters (in $params):
None
Output:
SQL Interaction:
"SELECT groupid FROM sys_group WHERE client_id = $client_id"
Description:
Retrieves information about a client.
Input Variables:
$session_id, $client_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen client.
Description:
Shows client information of user.
Input Variables:
$session_id, $username
Parameters (in $params):
None
Output:
Returns client information of the user specified by his or her name.
SQL Interaction:
"SELECT * FROM sys_user WHERE username = '".$username."'"
Description:
Retrieves the client ID of the system user.
Input Variables:
$session_id, $sys_userid
Parameters (in $params):
None
Output:
Returns the client ID of the user with the entered system user ID.
Description:
Shows sites of a single user.
Input Variables:
$session_id, $sys_userid, $sys_groupid
Parameters (in $params):
None
Output:
Shows sites and its values belonging to the specified user.
SQL Interaction:
"SELECT domain, domain_id, document_root, active FROM web_domain WHERE ( (sys_userid = $sys_userid AND sys_perm_user LIKE '%r%') OR (sys_groupid IN ($group_list) AND sys_perm_group LIKE '%r%') OR sys_perm_other LIKE '%r%') AND type = 'vhost'"
Description:
Returns all client templates.
Input Variables:
$session_id
Parameters (in $params):
None.
Output:
Returns an array with the parameter values of all client templates.
SQL Interaction:
"SELECT * FROM client_template"
Updates a client.
$session_id, $client_id, $reseller_id, $params
Parameters (in $params):company_name (varchar(64))
contact_name (varchar(64))
customer_no (varchar(64))
vat_id (varchar(64))
street (varchar(255))
zip (varchar(32))
city (varchar(64))
state (varchar(32))
country (char(2))
telephone (varchar(32))
mobile (varchar(32))
fax (varchar(32))
email (varchar(255))
internet (varchar(255))
icq (varchar(16))
notes (text)
default_mailserver (int(11))
limit_maildomain (int(11))
limit_mailbox (int(11))
limit_mailalias (int(11))
limit_mailaliasdomain (int(11))
limit_mailforward (int(11))
limit_mailcatchall (int(11))
limit_mailrouting (int(11))
limit_mailfilter (int(11))
limit_fetchmail (int(11))
limit_mailquota (int(11))
limit_spamfilter_wblist (int(11))
limit_spamfilter_user (int(11))
limit_spamfilter_policy (int(11))
default_webserver (int(11))
limit_web_ip (text)
limit_web_domain (int(11))
limit_web_quota (int(11))
web_php_options (varchar(255))
limit_web_subdomain (int(11))
limit_web_aliasdomain (int(11))
limit_ftp_user (int(11))
limit_shell_user (int(11))
ssh_chroot (varchar(255))
limit_webdav_user (int(11))
default_dnsserver (int(11))
limit_dns_zone (int(11))
limit_dns_slave_zone (int(11))
limit_dns_record (int(11))
default_dbserver (int(11))
limit_database (int(11))
limit_cron (int(11))
limit_cron_type (enum('url','chrooted','full'))
limit_cron_frequency (int(11))
limit_traffic_quota (int(11))
limit_client (varchar(64))
parent_client_id (int(11))
username (varchar(64))
password (varchar(64))
language (char(2))
usertheme (varchar(32))
template_master (int(11))
template_additional (varchar(255))
created_at (bigint(20))
Output:Returns the number of affected rows.
Description:
Adds a dns IPv4 record if type is a.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx''naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added IPv4 resource record.
Description:
Deletes target dns IPv4 resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns IPv4 resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns IPv4 resource record.
Updates an IPv4 record if type is a.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx''naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns IPv6 resource record if type is aaaa.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx''naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added IPv6 resource record.
Description:
Deletes target dns IPv6 resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns IPv6 resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns IPv6 resource record.
Updates a dns IPv6 resource record if type is aaaa.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx''naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns server side alias record if type is alias.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added alias resource record.
Description:
Deletes target dns alias resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a dns server side alias resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns alias resource record.
Updates a dns server side alias record if type is alias.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns canonical alias name record if type is cname.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added cname resource record.
Description:
Deletes target dns cname resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns cname resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns cname resource record.
Updates a dns canonical alias name record if type is cname.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns host information record if type is hinfo.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added hinfo resource record.
Description:
Deletes target dns hinfo resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns hinfo resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns hinfo resource record.
Updates a dns host information record if type is hinfo.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns mail exchanger record if type is mx.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added mx resource record.
Description:
Deletes target dns mx resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns mx resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns mx resource record.
Updates a dns mail exchanger record if type is mx.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns authoritative nameserver record if type is ns.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added ns resource record.
Description:
Deletes target dns ns resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns ns resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns ns resource record.
Updates an authoritative nameserver record if type is ns.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns domain name pointer record if type is ptr.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added ptr resource record.
Description:
Deletes target dns ptr resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns ptr resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns ptr resource record.
Updates a dns domain name pointer record if type is ptr.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns responsible person record if type is rp.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added rp resource record.
Description:
Deletes target dns rp resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns rp resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns rp resource record.
Updates a dns responsible person record if type is rp.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Shows information about a zone's resource records.
Input Variables:
$session_id, $zone_id
Parameters (in $params):
None
Output:
Returns a record of the zone's parameter values.
SQL Interaction:
"SELECT * FROM dns_rr WHERE zone = ".intval($zone_id)
Description:
Adds a dns server location record if type is srv.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added srv resource record.
Description:
Deletes target dns srv resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns srv resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns srv resource record.
Updates a dns server location record if type is srv.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a dns text string record if type is txt.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:
Returns the ID of the newly added txt resource record.
Description:
Deletes target dns txt resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about target dns txt resource record.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns txt resource record.
Updates a dns text string record if type is txt.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
zone (int(11))
name (varchar(64))
type (enum('a','aaaa','alias','cname','hinfo','mx','naptr','ns','ptr','rp','srv','txt'))
data (varchar(255))
aux (int(11))
ttl (int(11))
active (enum('n','y'))
stamp (timestamp)
serial (int(10))
Output:Returns the number of affected rows.
Description:
Adds a new dns zone.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
origin (varchar(255))
ns (varchar(255))
mbox (varchar(255))
serial (int(11))
refresh (int(11))
retry (retry(11))
expire (int(11))
minimum (int(11))
ttl (int(11))
active (enum('n','y'))
xfer (varchar(255))
also_notify (varchar(255))
update_acl (varchar(255))
Output:
Returns the ID of the newly added dns zone.
Description:
Deletes a dns zone.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a dns zone.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen dns zone.
Description:
Shows information about a client's zones.
Input Variables:
$session_id, $client_id, $server_id
Parameters (in $params):
None
Output:
Returns a record of parameters of the client's zones.
SQL Interaction:
"SELECT id, origin FROM dns_soa d INNER JOIN sys_user s on(d.sys_groupid = s.default_group) WHERE client_id = $client_id AND server_id = $server_id"
Description:
Switches a zone's status to either 'active' or 'inactive'.
Input Variables:
$session_id, $primary_id, $status
Parameters (in $params):
None
Output:
Returns '1' if status has been changed or '0' if no changes were taken.
SQL Interaction (if status is changed to 'active'):
"UPDATE dns_soa SET active = '$status' WHERE id = ".intval($primary_id)
Updates a dns zone.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
origin (varchar(255))
ns (varchar(255))
mbox (varchar(255))
serial (int(11))
refresh (int(11))
retry (retry(11))
expire (int(11))
minimum (int(11))
ttl (int(11))
active (enum('n','y'))
xfer (varchar(255))
also_notify (varchar(255))
update_acl (varchar(255))
Output:Returns the number of affected rows.
Description:
Adds a new domain.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
domain (varchar(255))
Output:
Returns the ID of the newly added domain.
Description:
Deletes a domain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a domain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen domain.
Description:
Returns information about the domains of the system group.
Input Variables:
$session_id, $group_id
Parameters (in $params):
None.
Output:
Returns an array with the domain parameters' values.
SQL Interaction:
"SELECT domain_id, domain FROM domain WHERE sys_groupid = $group_id "
Description:
Shows all available remote API functions.
Input Variables:
$session_id
Parameters (in $params):
None
Output:
Returns a record of all available remote API functions.
Description:
Starts a new remote session.
Input Variables:
$username, $password
Parameters (in $params):
None.
Output:
Returns session ID.
SQL Interaction:
"SELECT * FROM remote_user WHERE remote_username = '$username' and remote_password = md5('$password')"
Description:
Cancels a remote session.
Input Variables:
$session_id
Parameters (in $params):
None.
Output:
SQL Interaction:
"DELETE FROM remote_session WHERE remote_session = '$session_id'"
Description:
Adds a new mail alias if type is alias.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
destination (text)
type (enum('alias','aliasdomain','forward','catchall'))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail alias.
Description:
Deletes a mail alias.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail alias.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail alias.
Updates a mail alias if type is alias.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
source (varchar(255))
destination (text)
type (enum('alias','aliasdomain','forward','catchall'))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mail blacklist entry if access is REJECT.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
access (varchar(255))
type (set('recipient','sender','client'))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail blacklist entry.
Description:
Deletes a mail blacklist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail blacklist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail blacklist entry.
Updates a mail blacklist entry if access is REJECT.
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
access (varchar(255))
type (set('recipient','sender','client'))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mail catchall if type is catchall.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
destination (text)
type (enum('alias','aliasdomain','forward','catchall'))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail catchall.
Description:
Deletes a mail catchall.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail catchall.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail catchall.
Updates a mail catchall if type is catchall.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
source (varchar(255))
destination (text)
type (enum('alias','aliasdomain','forward','catchall'))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mail domain.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
domain (varchar(255))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail domain.
Description:
Deletes a mail domain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail domain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail domains.
Description:
Shows information about target mail domain.
Input Variables:
$session_id, $domain
Parameters (in $params):
None
Output:
Returns a record of parameters of target mail domain.
SQL Interaction:
"SELECT * FROM mail_domain WHERE domain = '$domain'"
Description:
Switches a mail domain's status to either 'active' or 'inactive'.
Input Variables:
$session_id, $primary_id, $status
Parameters (in $params):
None
Output:
Returns '1' if status has been changed or '0' if no changes were taken.
SQL Interaction (if status is changed to 'active'):
"UPDATE mail_domain SET active = '$status' WHERE domain_id = ".intval($primary_id)
Updates a mail domain.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
domain (varchar(255))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new fetchmail.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
type (varchar(255))
source_server (varchar(255))
source_username (varchar(255))
source_password (varchar(64))
source_delete (varchar(255))
destination (varchar(255))
active (varchar(255))
source_read_all (varchar(255))
Output:
Returns the ID of the newly added fetchmail.
Description:
Deletes a fetchmail.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a fetchmail.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen fetchmail.
Updates a fetchmail.
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
type (varchar(255))
source_server (varchar(255))
source_username (varchar(255))
source_password (varchar(64))
source_delete (varchar(255))
destination (varchar(255))
active (varchar(255))
source_read_all (varchar(255))
Output:Returns the number of affected rows.
Description:
Adds a new mail forwarding if type is forward.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
destination (text)
type (enum('alias','aliasdomain','forward','catchall'))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail forwarding.
Description:
Deletes a mail forwarding.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail forwarding.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail forwarding.
Updates a mail forwarding if type is forward.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
source (varchar(255))
destination (text)
type (enum('alias','aliasdomain','forward','catchall'))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mailinglist.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
domain (varchar(255))
listname (varchar(255))
email (varchar(255))
password (varchar(255))
Output:
Returns the ID of the newly added mailinglist.
Description:
Deletes a mailinglist.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mailinglist.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mailinglist.
Updates a mailinglist.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
domain (varchar(255))
listname (varchar(255))
email (varchar(255))
password (varchar(255))
Output:Returns the number of affected rows.
Description:
Adds a new mail policy.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
policy_name (varchar(64))
virus_lover (enum('N','Y'))
spam_lover (enum('N','Y'))
banned_files_lover (enum('N','Y'))
bad_header_lover (enum('N','Y'))
bypass_virus_checks (enum('N','Y'))
bypass_spam_checks (enum('N','Y'))
bypass_banned_checks (enum('N','Y'))
bypass_header_checks (enum('N','Y'))
spam_modifies_subj (enum('N','Y'))
virus_quarantine_to (varchar(255))
spam_quarantine_to (varchar(255))
banned_quarantine_to (varchar(255))
bad_header_quarantine_to (varchar(255))
clean_quarantine_to (varchar(255))
other_quarantine_to (varchar(255))
spam_tag_level (float)
spam_tag2_level (float)
spam_kill_level (float)
spam_dsn_cutoff_level (float)
spam_quarantine_cutoff_level (float)
addr_extension_virus (varchar(64))
addr_extension_spam (varchar(64))
addr_extension_banned (varchar(64))
addr_extension_bad_header (varchar(64))
warnvirusrecip (enum('N','Y'))
warnbannedrecip (enum('N','Y'))
warnbadhrecip (enum('N','Y'))
newvirus_admin (varchar(64))
virus_admin (varchar(64))
banned_admin (varchar(64))
bad_header_admin (varchar(64))
spam_admin (varchar(64))
spam_subject_tag (varchar(64))
spam_subject_tag2 (varchar(64))
message_size_limit (int(11))
banned_rulenames (varchar(64))
Output:
Returns the ID of the newly added mail policy.
Description:
Deletes a mail policy.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail policy.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail policy.
Updates a mail policy.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):policy_name (varchar(64))
virus_lover (enum('N','Y'))
spam_lover (enum('N','Y'))
banned_files_lover (enum('N','Y'))
bad_header_lover (enum('N','Y'))
bypass_virus_checks (enum('N','Y'))
bypass_spam_checks (enum('N','Y'))
bypass_banned_checks (enum('N','Y'))
bypass_header_checks (enum('N','Y'))
spam_modifies_subj (enum('N','Y'))
virus_quarantine_to (varchar(255))
spam_quarantine_to (varchar(255))
banned_quarantine_to (varchar(255))
bad_header_quarantine_to (varchar(255))
clean_quarantine_to (varchar(255))
other_quarantine_to (varchar(255))
spam_tag_level (float)
spam_tag2_level (float)
spam_kill_level (float)
spam_dsn_cutoff_level (float)
spam_quarantine_cutoff_level (float)
addr_extension_virus (varchar(64))
addr_extension_spam (varchar(64))
addr_extension_banned (varchar(64))
addr_extension_bad_header (varchar(64))
warnvirusrecip (enum('N','Y'))
warnbannedrecip (enum('N','Y'))
warnbadhrecip (enum('N','Y'))
newvirus_admin (varchar(64))
virus_admin (varchar(64))
banned_admin (varchar(64))
bad_header_admin (varchar(64))
spam_admin (varchar(64))
spam_subject_tag (varchar(64))
spam_subject_tag2 (varchar(64))
message_size_limit (int(11))
banned_rulenames (varchar(64))
Output:Returns the number of affected rows.
Description:
Adds a new mailing spamfilter blacklist entry if wb is B.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
wb (enum('W','B'))
rid (int(11))
email (varchar(255))
priority (tinyint(3))
active (enum('n','y'))
Output:
Returns the ID of the newly added spamfilter blacklist entry.
Description:
Deletes a mailing spamfilter blacklist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mailing spamfilter blacklist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen spamfilter blacklist entry.
Updates a mailing spamfilter blacklist entry if wb is B.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
wb (enum('W','B'))
rid (int(11))
email (varchar(255))
priority (tinyint(3))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mailing spamfilter user.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
priority (tinyint(3))
policy_id (int(11))
email (varchar(255))
fullname (varchar(64))
local (varchar(1))
Output:
Returns the ID of the newly added spamfilter user.
Description:
Deletes a mailing spamfilter user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mailing spamfilter user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen spamfilter user.
Updates a mailing spamfilter user.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
priority (tinyint(3))
policy_id (int(11))
email (varchar(255))
fullname (varchar(64))
local (varchar(1))
Output:Returns the number of affected rows.
Description:
Adds a new mailing spamfilter whitelist entry if wb is W.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
wb (enum('W','B'))
rid (int(11))
email (varchar(255))
priority (tinyint(3))
active (enum('n','y'))
Output:
Returns the ID of the newly added spamfilter whitelist entry.
Description:
Deletes a mailing spamfilter whitelist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mailing spamfilter whitelist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen spamfilter whitelist entry.
Updates a mailing spamfilter whitelist if wb is W.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
wb (enum('W','B'))
rid (int(11))
email (varchar(255))
priority (tinyint(3))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mail transport.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
domain (varchar(255))
transport (varchar(255))
sort_order (int(11))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail transport.
Description:
Deletes a mail transport.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail transport.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail transport.
Updates a mail transport.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
domain (varchar(255))
transport (varchar(255))
sort_order (int(11))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a mail user.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
email (varchar(255))
login (varchar(255))
password (varchar(255))
name (varchar(255))
uid (int(11))
gid (int(11))
maildir (varchar(255))
quota (bigint(20))
cc (varchar(255))
homedir (varchar(255))
autoresponder (enum('n','y'))
autoresponder_start_date (datetime)
autoresponder_end_date (datetime)
autoresponder_text (mediumtext)
move_junk (enum('n','y'))
custom_mailfilter (mediumtext)
postfix (enum('n','y'))
access (enum('n','y'))
disableimap (enum('n','y'))
disablepop3 (enum('n','y'))
disabledeliver (enum('n','y'))
disablesmtp (enum('n','y'))
Output:
Returns the ID of the newly added mail user.
Description:
Adds a new backup / restore task. Please note: $action_type must be backup_restore_mail
Input Variables:
$session_id, $primary_id, $action_type
Output:
Returns TRUE if successfull or FALSE if failure.
Description:
Gets list of all available mail backups. If no $primary_id (mail-domain-id) is given, all mail backups available on this server are read.
Input Variables:
$session_id, $primary_id (mail-domain-id)
Output:
Returns array of all available backups.
Description:
Deletes a mail user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Adds a new mail user filter.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
mailuser_id (int(11))
rulename (varchar(64))
source (varchar(255))
searchterm (varchar(255))
op (varchar(255))
action (varchar(255))
target (varchar(255))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail user filter.
Description:
Deletes a mail user filter.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail user filter.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail user filter.
Updates a mail user filter.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):mailuser_id (int(11))
rulename (varchar(64))
source (varchar(255))
searchterm (varchar(255))
op (varchar(255))
action (varchar(255))
target (varchar(255))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Retrieves information about a mail user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail user.
Description:
Updates a mail user.
Input Variables:
$session_id, $client_id, $primary_id, $params
Parameters (in $params):
server_id (int(11))
email (varchar(255))
password (varchar(255))
name (varchar(255))
uid (int(11))
gid (int(11))
maildir (varchar(255))
quota (bigint(20))
cc (varchar(255))
homedir (varchar(255))
autoresponder (enum('n','y'))
autoresponder_start_date (datetime)
autoresponder_end_date (datetime)
autoresponder_text (mediumtext)
move_junk (enum('n','y'))
custom_mailfilter (mediumtext)
postfix (enum('n','y'))
access (enum('n','y'))
disableimap (enum('n','y'))
disablepop3 (enum('n','y'))
disabledeliver (enum('n','y'))
disablesmtp (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new mail whitelist entry if access is OK.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
access (varchar(255))
type (set('recipient','sender','client'))
active (enum('n','y'))
Output:
Returns the ID of the newly added mail whitelist entry.
Description:
Deletes a mail whitelist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a mail whitelist entry.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen mail whitelist entry.
Updates a mail whitelist entry if access is OK.
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
source (varchar(255))
access (varchar(255))
type (set('recipient','sender','client'))
active (enum('n','y'))
Output:Returns the number of affected rows.
mail_spamfilter_blacklist_delete
mail_spamfilter_blacklist_update
mail_spamfilter_whitelist_delete
mail_spamfilter_whitelist_update
sites_aps_available_packages_list
sites_aps_get_package_settings
sites_aps_instance_settings_get
sites_database_get_all_by_user
openvz_get_free_ip.html 0000664 0000000 0000000 00000002600 13405013377 0036507 0 ustar 00root root 0000000 0000000 ispconfig3-f66e8c9fdea10f7d3928516b1dd70f5b262070f4-remoting_client-API-docs/remoting_client/API-docsDescription:
Shows the unreserved IPs for openvz virtual machines.
Input Variables:
$session_id, $server_id = 0
Parameters (in $params):
None
Output:
Returns the IPs available for an openvz virtual machine.
SQL Interaction (the matching server ID condition is left out if $server_id=0):
"SELECT ip_address_id, server_id, ip_address FROM openvz_ip WHERE reserved = 'n' AND vm_id = 0 AND server_id = $server_id LIMIT 0,1"
Description:
Adds a new openvz ip.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
ip_address (int(15))
vm_id (int(11))
reserved (varchar(255))
Output:
Returns the ID of the newly added openvz ip.
Description:
Deletes an openvz ip.
Input Variables:
$session_id, $ip_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about an openvz ip.
Input Variables:
$session_id, $ip_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen ip.
Updates an openvz ip.
$session_id, $client_id, $ip_id, $params
Parameters (in $params):server_id (int(11))
ip_address (int(15))
vm_id (int(11))
reserved (varchar(255))
Output:Returns the number of affected rows.
Description:
Adds a new openvz OS template.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
template_name (varchar(255))
template_file (varchar(255))
server_id (int(11))
allservers (varchar(255))
active (varchar(255))
description (text)
Output:
Returns the ID of the newly added openvz OS template.
Description:
Deletes an openvz OS template.
Input Variables:
$session_id, $ostemplate_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about an openvz OS template.
Input Variables:
$session_id, $ostemplate_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen OS template.
Updates an openvz OS template.
$session_id, $client_id, $ostemplate_id, $params
Parameters (in $params):template_name (varchar(255))
template_file (varchar(255))
server_id (int(11))
allservers (varchar(255))
active (varchar(255))
description (text)
Output:Returns the number of affected rows.
Description:
Adds a new openvz template.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
template_name (varchar(255))
diskspace (int(11))
traffic (int(11))
bandwidth (int(11))
ram (int(11))
ram_burst (int(11))
cpu_units (int(11))
cpu_num (int(11))
cpu_limit (int(11))
io_priority (int(11))
active (varchar(255))
description (text)
numproc (varchar(255))
numtcpsock (varchar(255))
numothersock (varchar(255))
vmguarpages (varchar(255))
kmemsize (varchar(255))
tcpsndbuf (varchar(255))
tcprcvbuf (varchar(255))
othersockbuf (varchar(255))
dgramrcvbuf (varchar(255))
oomguarpages (varchar(255))
privvmpages (varchar(255))
lockedpages (varchar(255))
shmpages (varchar(255))
physpages (varchar(255))
numfile (varchar(255))
avnumproc (varchar(255))
numflock (varchar(255))
numpty (varchar(255))
numsiginfo (varchar(255))
dcachesize (varchar(255))
numiptent (varchar(255))
swappages (varchar(255))
hostname (varchar(255))
nameserver (varchar(255))
create_dns (varchar(1))
capability (varchar(255))
Output:
Returns the ID of the newly added openvz template.
Description:
Deletes an openvz template.
Input Variables:
$session_id, $template_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about an openvz template.
Input Variables:
$session_id, $template_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen template.
Updates an openvz template.
$session_id, $client_id, $template_id, $params
Parameters (in $params):template_name (varchar(255))
diskspace (int(11))
traffic (int(11))
bandwidth (int(11))
ram (int(11))
ram_burst (int(11))
cpu_units (int(11))
cpu_num (int(11))
cpu_limit (int(11))
io_priority (int(11))
active (varchar(255))
description (text)
numproc (varchar(255))
numtcpsock (varchar(255))
numothersock (varchar(255))
vmguarpages (varchar(255))
kmemsize (varchar(255))
tcpsndbuf (varchar(255))
tcprcvbuf (varchar(255))
othersockbuf (varchar(255))
dgramrcvbuf (varchar(255))
oomguarpages (varchar(255))
privvmpages (varchar(255))
lockedpages (varchar(255))
shmpages (varchar(255))
physpages (varchar(255))
numfile (varchar(255))
avnumproc (varchar(255))
numflock (varchar(255))
numpty (varchar(255))
numsiginfo (varchar(255))
dcachesize (varchar(255))
numiptent (varchar(255))
swappages (varchar(255))
hostname (varchar(255))
nameserver (varchar(255))
create_dns (varchar(1))
capability (varchar(255))
Output:Returns the number of affected rows.
Description:
Adds a new openvz vm.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
veid (int(10))
ostemplate_id (int(11))
template_id (int(11))
ip_address (varchar(255))
hostname (varchar(255))
vm_password (varchar(255))
start_boot (varchar(255))
active (varchar(255))
active_until_date (date)
description (text)
diskspace (int(11))
traffic (int(11))
bandwidth (int(11))
ram (int(11))
ram_burst (int(11))
cpu_units (int(11))
cpu_num (int(11))
cpu_limit (int(11))
io_priority (int(11))
nameserver (varchar(255))
create_dns (varchar(1))
capability (text)
config (mediumtext)
Output:
Returns the ID of the newly added openvz vm.
Description:
Sets up a virtual machine on the first available ip by using templates.
Input Variables:
$session_id, $client_id, $ostemplate_id, $template_id, $override_params = array()
Parameters (in $params):
None
Output:
Returns added vm's ID.
SQL Interaction:
"SELECT * FROM openvz_template WHERE template_id = $template_id"
Description:
Deletes an openvz vm.
Input Variables:
$session_id, $vm_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about an openvz vm.
Input Variables:
$session_id, $vm_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen vm.
Description:
Shows all of a client's vms.
Input Variables:
$session_id, $client_id
Parameters (in $params):
None
Output:
Returns arrays of parameters of target client's vms.
SQL Interaction:
"SELECT * FROM openvz_vm WHERE sys_groupid = ".intval($tmp['groupid'])
Updates an openvz vm.
$session_id, $client_id, $vm_id, $params
Parameters (in $params):server_id (int(11))
veid (int(10))
ostemplate_id (int(11))
template_id (int(11))
ip_address (varchar(255))
hostname (varchar(255))
vm_password (varchar(255))
start_boot (varchar(255))
active (varchar(255))
active_until_date (date)
description (text)
diskspace (int(11))
traffic (int(11))
bandwidth (int(11))
ram (int(11))
ram_burst (int(11))
cpu_units (int(11))
cpu_num (int(11))
cpu_limit (int(11))
io_priority (int(11))
nameserver (varchar(255))
create_dns (varchar(1))
capability (text)
config (mediumtext)
Output:Returns the number of affected rows.
Returns server information by its ID.
$session_id, $server_id, $section =''
Parameters (in $params):None.
Output:Returns an array with the server parameter's values.
Returns the available PHP versions of the given server.
$session_id, $server_id, $php
Output:Returns an array with the available PHP versions.
Description:
Returns server information by its IP.
Input Variables:
$session_id, $ipaddress
Parameters (in $params):
None.
Output:
Returns an array with the server parameter's values.
SQL Interaction:
SELECT server_id FROM server_ip WHERE ip_address = '$ipaddress' LIMIT 1 "
Description:
Reads all available packages with state PACKAGE_ENABLED. If set param all_packages to true, also includes PACKAGE_LOCKED.
Input Variables:
$session_id, $params
Parameters (in $params):
all_packages (boolean)
Output:
Returns array with all selected package records.
Description:
Gets all possible details for selected package.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns array with all details of selected package.
Description:
Gets the file with given name (like screenshots or icon) of the selected package. Use sites_aps_get_package_details to get all available files of this package.
Input Variables:
$session_id, $primary_id, $filename
Parameters (in $params):
None
Output:
Returns base64_encoded file content of selected file.
Use the followoing example code to save file content over remote api:
file_put_contents($file, base64_decode(sites_aps_get_package_file($session_id, $primary_id, $filename)));
Description:
Gets all possible settings for selected package.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns array with all settings of selected package.
Description:
Starts installation of the selected package in given main_domains webfolder.
Input Variables:
$session_id, $primary_id, $params
Parameters (in $params):
main_domain (varchar(255))
Output:
Returns new instance id or false.
Description:
Starts deletion of the selected APS instance. If param keep_database is set true, database will not be deleted.
Input Variables:
$session_id, $primary_id, $params
Parameters (in $params):
keep_database (boolean)
Output:
Returns true if deletion is started.
Description:
Gets record of given instance id.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns record of APS instance.
Description:
Gets record of given instance ids settings.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns record of APS instance settings.
Description:
Update available package list. Starts the ApsCrawler in server mode. May take a while.
Input Variables:
$session_id
Parameters (in $params):
None
Output:
always true
Description:
Adds a new cronjob.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
parent_domain_id (int(11))
type (enum('url','chrooted','full'))
command (varchar(255))
run_min (varchar(100))
run_hour (varchar(100))
run_mday (varchar(100))
run_month (varchar(100))
run_wday (varchar(100))
active (enum('n','y'))
Output:
Returns the ID of the newly added cronjob.
Description:
Deletes a cronjob.
Input Variables:
$session_id, $cron_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a cronjob.
Input Variables:
$session_id, $cron_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen cronjob.
Updates a cronjob.
$session_id, $client_id, $cron_id, $params
Parameters (in $params):server_id (int(11))
parent_domain_id (int(11))
type (enum('url','chrooted','full'))
command (varchar(255))
run_min (varchar(100))
run_hour (varchar(100))
run_mday (varchar(100))
run_month (varchar(100))
run_wday (varchar(100))
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new database.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
website_id (int(11))
type (varchar(16))
database_name (varchar(64))
database_user_id (int(11))
database_ro_user_id (int(11))
database_password (varchar(64))
database_charset (varchar(64))
remote_access (enum('n','y'))
remote_ips (text)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
Output:
Returns the ID of the newly added database.
Description:
Deletes a database.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a database.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen database.
Description:
Returns information about the databases of the system user.
Input Variables:
$session_id, $client_id
Parameters (in $params):
None.
Output:
Returns an array with the parameter values of the client's databases.
SQL Interaction:
"SELECT database_id, database_name, database_user, database_password FROM web_database WHERE sys_userid = $client_id "
Updates a database.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
type (varchar(16))
database_name (varchar(64))
database_user (varchar(64))
database_password (varchar(64))
database_charset (varchar(64))
remote_access (enum('n','y'))
remote_ips (text)
active (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new database user.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
database_user (varchar(64))
database_password (varchar(64))
Output:
Returns the ID of the newly added database.
Description:
Deletes a database user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a database.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen database.
Updates a database.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
database_name (varchar(64))
database_password (varchar(64))
Output:Returns the number of affected rows.
Description:
Adds a new ftp user.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
parent_domain_id (int(11))
username (varchar(64))
password (varchar(64))
quota_size (bigint(20))
active (enum('n','y'))
uid (varchar(64))
gid (varchar(64))
dir (varchar(255))
quota_files (bigint(20))
ul_ratio (int(11))
dl_ratio (int(11))
ul_bandwidth (int(11))
dl_bandwidth (int(11))
Output:
Returns the ID of the newly added client.
Description:
Deletes an ftp user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about an ftp user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen ftp user.
Updates an ftp user.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
parent_domain_id (int(11))
username (varchar(64))
password (varchar(64))
quota_size (bigint(20))
active (enum('n','y'))
uid (varchar(64))
gid (varchar(64))
dir (varchar(255))
quota_files (bigint(20))
ul_ratio (int(11))
dl_ratio (int(11))
ul_bandwidth (int(11))
dl_bandwidth (int(11))
Output:Returns the number of affected rows.
Description:
Adds a new shell user.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
parent_domain_id (int(11))
username (varchar(64))
password (varchar(64))
quota_size (bigint(20))
active (enum('n','y'))
puser (varchar(64))
pgroup (varchar(64))
shell (varchar(255))
dir (bigint(20))
chroot (int(11))
Output:
Returns the ID of the newly added shell user.
Description:
Deletes a shell user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a shell user.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen shell user.
Updates a shell user.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
parent_domain_id (int(11))
username (varchar(64))
password (varchar(64))
quota_size (bigint(20))
active (enum('n','y'))
puser (varchar(64))
pgroup (varchar(64))
shell (varchar(255))
dir (bigint(20))
chroot (int(11))
Output:Returns the number of affected rows.
Description:
Adds a new web aliasdomain if type is alias.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
ip_address (varchar(39))
domain (varchar(255))
type (varchar(32))
parent_domain_id (int(11))
vhost_type (varchar(32))
document_root (varchar(255))
system_user (varchar(255))
system_group (varchar(255))
hd_quota (bigint(20))
traffic_quota (bigint(20))
cgi (enum('n','y'))
ssi (enum('n','y'))
suexec (enum('n','y'))
errordocs (tinyint(1))
is_subdomainwww (tinyint(1))
subdomain (enum('none','www','*'))
php (enum('n','y'))
ruby (enum('n','y'))
redirect_type (varchar(255))
redirect_path (varchar(255))
ssl (enum('n','y'))
ssl_state (varchar(255))
ssl_locality (varchar(255))
ssl_organisation (varchar(255))
ssl_organisation_unit (varchar(255))
ssl_country (varchar(255))
ssl_domain (varchar(255))
ssl_request (mediumtext)
ssl_cert (mediumtext)
ssl_bundle (mediumtext)
ssl_action (varchar(16))
stats_password (varchar(255))
stats_type (varchar(255))
allow_override (varchar(255))
apache_directives (mediumtext)
php_open_basedir (mediumtext)
custom_php_ini (mediumtext)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
traffic_quota_lock (enum('n','y'))
Output:
Returns the ID of the newly added web aliasdomain.
Description:
Deletes a web aliasdomain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a web aliasdomain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen web aliasdomain.
Updates a web aliasdomain if type is alias.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
ip_address (varchar(39))
domain (varchar(255))
type (varchar(32))
parent_domain_id (int(11))
vhost_type (varchar(32))
document_root (varchar(255))
system_user (varchar(255))
system_group (varchar(255))
hd_quota (bigint(20))
traffic_quota (bigint(20))
cgi (enum('n','y'))
ssi (enum('n','y'))
suexec (enum('n','y'))
errordocs (tinyint(1))
is_subdomainwww (tinyint(1))
subdomain (enum('none','www','*'))
php (enum('n','y'))
ruby (enum('n','y'))
redirect_type (varchar(255))
redirect_path (varchar(255))
ssl (enum('n','y'))
ssl_state (varchar(255))
ssl_locality (varchar(255))
ssl_organisation (varchar(255))
ssl_organisation_unit (varchar(255))
ssl_country (varchar(255))
ssl_domain (varchar(255))
ssl_key (mediumtext)
ssl_request (mediumtext)
ssl_cert (mediumtext)
ssl_bundle (mediumtext)
ssl_action (varchar(16))
stats_password (varchar(255))
stats_type (varchar(255))
allow_override (varchar(255))
apache_directives (mediumtext)
php_open_basedir (mediumtext)
custom_php_ini (mediumtext)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
traffic_quota_lock (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new web domain.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
ip_address (varchar(39))
domain (varchar(255))
type (varchar(32))
parent_domain_id (int(11))
vhost_type (varchar(32))
document_root (varchar(255))
system_user (varchar(255))
system_group (varchar(255))
hd_quota (bigint(20))
traffic_quota (bigint(20))
cgi (enum('n','y'))
ssi (enum('n','y'))
suexec (enum('n','y'))
errordocs (tinyint(1))
is_subdomainwww (tinyint(1))
subdomain (enum('none','www','*'))
php (enum('n','y'))
ruby (enum('n','y'))
redirect_type (varchar(255))
redirect_path (varchar(255))
ssl (enum('n','y'))
ssl_state (varchar(255))
ssl_locality (varchar(255))
ssl_organisation (varchar(255))
ssl_organisation_unit (varchar(255))
ssl_country (varchar(255))
ssl_domain (varchar(255))
ssl_key (mediumtext)
ssl_request (mediumtext)
ssl_cert (mediumtext)
ssl_bundle (mediumtext)
ssl_action (varchar(16))
stats_password (varchar(255))
stats_type (varchar(255))
allow_override (varchar(255))
apache_directives (mediumtext)
php_open_basedir (mediumtext)
custom_php_ini (mediumtext)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
traffic_quota_lock (enum('n','y'))
http_port (int(11))
https_port (int(11))
Output:
Returns the ID of the newly added web domain.
Description:
Adds a new backup / restore task. Please note: $action_type is either backup_download or backup_restore
Input Variables:
$session_id, $primary_id, $action_type
Output:
Returns TRUE if successfull or FALSE if failure.
Description:
Gets list of all available backups. If no $site_id given, all backups available on this server are read.
Input Variables:
$session_id, $site_id
Output:
Returns array of all available backups.
Description:
Deletes a web domain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a web domain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen web domain.
Description:
Changes status of a web domain to 'active' or 'inactive'.
Input Variables:
$session_id, $primary_id, $status
Parameters (in $params):
None
Output:
Returns '1' if status has been changed, '0' if no changes were taken.
SQL Interaction (if status is changed to 'active'):
"UPDATE web_domain SET active = '$status' WHERE domain_id = ".intval($primary_id)
Updates a web domain.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
ip_address (varchar(39))
domain (varchar(255))
type (varchar(32))
parent_domain_id (int(11))
vhost_type (varchar(32))
document_root (varchar(255))
system_user (varchar(255))
system_group (varchar(255))
hd_quota (bigint(20))
traffic_quota (bigint(20))
cgi (enum('n','y'))
ssi (enum('n','y'))
suexec (enum('n','y'))
errordocs (tinyint(1))
is_subdomainwww (tinyint(1))
subdomain (enum('none','www','*'))
php (enum('n','y'))
ruby (enum('n','y'))
redirect_type (varchar(255))
redirect_path (varchar(255))
ssl (enum('n','y'))
ssl_state (varchar(255))
ssl_locality (varchar(255))
ssl_organisation (varchar(255))
ssl_organisation_unit (varchar(255))
ssl_country (varchar(255))
ssl_domain (varchar(255))
ssl_request (mediumtext)
ssl_cert (mediumtext)
ssl_bundle (mediumtext)
ssl_action (varchar(16))
stats_password (varchar(255))
stats_type (varchar(255))
allow_override (varchar(255))
apache_directives (mediumtext)
php_open_basedir (mediumtext)
custom_php_ini (mediumtext)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
traffic_quota_lock (enum('n','y'))
Output:Returns the number of affected rows.
Description:
Adds a new web subdomain if type is subdomain.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (int(11))
ip_address (varchar(39))
domain (varchar(255))
type (varchar(32))
parent_domain_id (int(11))
vhost_type (varchar(32))
document_root (varchar(255))
system_user (varchar(255))
system_group (varchar(255))
hd_quota (bigint(20))
traffic_quota (bigint(20))
cgi (enum('n','y'))
ssi (enum('n','y'))
suexec (enum('n','y'))
errordocs (tinyint(1))
is_subdomainwww (tinyint(1))
subdomain (enum('none','www','*'))
php (enum('n','y'))
ruby (enum('n','y'))
redirect_type (varchar(255))
redirect_path (varchar(255))
ssl (enum('n','y'))
ssl_state (varchar(255))
ssl_locality (varchar(255))
ssl_organisation (varchar(255))
ssl_organisation_unit (varchar(255))
ssl_country (varchar(255))
ssl_domain (varchar(255))
ssl_request (mediumtext)
ssl_cert (mediumtext)
ssl_bundle (mediumtext)
ssl_action (varchar(16))
stats_password (varchar(255))
stats_type (varchar(255))
allow_override (varchar(255))
apache_directives (mediumtext)
php_open_basedir (mediumtext)
custom_php_ini (mediumtext)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
traffic_quota_lock (enum('n','y'))
Output:
Returns the ID of the newly added web subdomain.
Description:
Deletes a web subdomain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns the number of deleted records.
Description:
Retrieves information about a web subdomain.
Input Variables:
$session_id, $primary_id
Parameters (in $params):
None
Output:
Returns all fields and values of the chosen web subdomain.
Updates a web subdomain if type is subdomain.
$session_id, $client_id, $primary_id, $params
Parameters (in $params):server_id (int(11))
ip_address (varchar(39))
domain (varchar(255))
type (varchar(32))
parent_domain_id (int(11))
vhost_type (varchar(32))
document_root (varchar(255))
system_user (varchar(255))
system_group (varchar(255))
hd_quota (bigint(20))
traffic_quota (bigint(20))
cgi (enum('n','y'))
ssi (enum('n','y'))
suexec (enum('n','y'))
errordocs (tinyint(1))
is_subdomainwww (tinyint(1))
subdomain (enum('none','www','*'))
php (enum('n','y'))
ruby (enum('n','y'))
redirect_type (varchar(255))
redirect_path (varchar(255))
ssl (enum('n','y'))
ssl_state (varchar(255))
ssl_locality (varchar(255))
ssl_organisation (varchar(255))
ssl_organisation_unit (varchar(255))
ssl_country (varchar(255))
ssl_domain (varchar(255))
ssl_request (mediumtext)
ssl_cert (mediumtext)
ssl_bundle (mediumtext)
ssl_action (varchar(16))
stats_password (varchar(255))
stats_type (varchar(255))
allow_override (varchar(255))
apache_directives (mediumtext)
php_open_basedir (mediumtext)
custom_php_ini (mediumtext)
backup_interval (varchar(255))
backup_copies (int(11))
active (enum('n','y'))
traffic_quota_lock (enum('n','y'))
Output:Returns the number of affected rows.