PLESK RPC API

Section 4.3 Performing Operations on Plesk Servers

 The structures, described here, allow for creating packets with the info necessary for performing operations on Plesk servers, such as adding a new server, removing it, updating server info, and also receiving results on these operations.

Schema server_input.xsd


schema location:  server_input.xsd
 
Elements  Complex types 
packet  getType 


schema location:  plesk_server.xsd
 
Complex types  Simple types 
adminType  serverPassword 
componentsType  srvIdType 
diskspaceStatType  srvOpType 
initialSetupType 
interfacesType 
keyType 
load_avgStatType 
memStatType 
objectsStatType 
otherStatType 
serverGenInfoType 
serverPrefs 
serverSessionSetup 
servicesState 
shellType 
statType 
swapStatType 
versionStatType 


schema location:  plesk_common.xsd
 
Complex types  Simple types 
buttonDataType  expandIPUsageStatus 
forwardingURL 
garbageOutput 
ipType 
netInterface 
objectStatus 
pleskOS 


schema location:  common.xsd
 
Complex types  Simple types 
resultType  base64 
boolean 
date 
datetime 
double 
emailType 
id_type 
int 
ip_address 
passwdType 
result_status 
short 
size 
string 
text 
unsignedInt 
unsignedShort 
urlType 
zipcodeType 


element packet
diagram
properties
content complex
children server
attributes
Name  Type  Use  Default  Fixed  Annotation
version  stringrequired      
annotation
documentation 
Root node for any input

element packet/server
diagram
properties
isRef 0
content complex
children get_protos get set srv_man lic_install initial_setup
annotation
documentation 
Server operator

element packet/server/get_protos
diagram
properties
isRef 0
content complex
annotation
documentation 
Get supported PA protocols

element packet/server/get
diagram
type getType
properties
isRef 0
content complex
children key gen_info components stat admin interfaces services_state prefs shells
annotation
documentation 
"Get" operation

element packet/server/set
diagram
properties
isRef 0
content complex
children admin password prefs session_setup
annotation
documentation 
"Set" operation

element packet/server/set/admin
diagram
type adminType
properties
isRef 0
content complex
children admin_cname admin_pname admin_phone admin_fax admin_email admin_address admin_city admin_state admin_pcode admin_country send_announce

element packet/server/set/password
diagram
type serverPassword
properties
isRef 0
content simple
facets
minLength 5
maxLength 14
whiteSpace collapse

element packet/server/set/prefs
diagram
type serverPrefs
properties
isRef 0
content complex
children stat_ttl traffic_accounting restart_apache_interval

element packet/server/set/session_setup
diagram
type serverSessionSetup
properties
isRef 0
content complex
children login_timeout lock_interval lock_attempts lock_time

element packet/server/srv_man
diagram
properties
isRef 0
content complex
children id operation
annotation
documentation 
Services management

element packet/server/srv_man/id
diagram
type srvIdType
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Service ID

element packet/server/srv_man/operation
diagram
type srvOpType
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration start
enumeration stop
enumeration restart
annotation
documentation 
Operation to be completed for service

element packet/server/lic_install
diagram
properties
isRef 0
content complex
children license
annotation
documentation 
Install a new Plesk licence. TODO: Works only with *nix Plesk installations for now.

element packet/server/lic_install/license
diagram
type base64
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
License file. For *nix it is a self-extractor shell script

element packet/server/initial_setup
diagram
type initialSetupType
properties
isRef 0
content complex
children admin password server_name
annotation
documentation 
Plesk server initial setup. May be used only on a fresh Plesk server installation

complexType getType
diagram
children key gen_info components stat admin interfaces services_state prefs shells
used by
element packet/server/get
annotation
documentation 
Request server info

element getType/key
diagram
properties
isRef 0
annotation
documentation 
Plesk licence key info

element getType/gen_info
diagram
properties
isRef 0
annotation
documentation 
Server general info

element getType/components
diagram
properties
isRef 0
annotation
documentation 
Server componets

element getType/stat
diagram
properties
isRef 0
annotation
documentation 
Server statistics

element getType/admin
diagram
properties
isRef 0
annotation
documentation 
Server adminstrator info

element getType/interfaces
diagram
properties
isRef 0
annotation
documentation 
The list of Server Network Interfaces

element getType/services_state
diagram
properties
isRef 0
annotation
documentation 
Server Services State

element getType/prefs
diagram
properties
isRef 0
annotation
documentation 
Server Preferences

element getType/shells
diagram
properties
isRef 0
annotation
documentation 
Server shells

complexType adminType
diagram
children admin_cname admin_pname admin_phone admin_fax admin_email admin_address admin_city admin_state admin_pcode admin_country send_announce
used by
elements packet/server/set/admin initialSetupType/admin
annotation
documentation 
Admin info

element adminType/admin_cname
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_pname
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_phone
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_fax
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_email
diagram
type emailType
properties
isRef 0
content simple
facets
minLength 3
maxLength 255
whiteSpace collapse
pattern [\-\p{L}\p{N}\.]*@([\p{L}\p{N}][\-\p{L}\p{N}]*\.)*[\p{L}][\-\p{L}\p{N}]*\.?

element adminType/admin_address
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_city
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_state
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/admin_pcode
diagram
type zipcodeType
properties
isRef 0
content simple
facets
maxLength 10
whiteSpace collapse

element adminType/admin_country
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element adminType/send_announce
diagram
type boolean
properties
isRef 0
content simple
default false
facets
whiteSpace collapse

complexType componentsType
diagram
children component
annotation
documentation 
Server componets info

element componentsType/component
diagram
properties
isRef 0
content complex
children name version

element componentsType/component/name
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
Component Name

element componentsType/component/version
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
Component Version

complexType diskspaceStatType
diagram
children device
used by
element statType/diskspace
annotation
documentation 
Disk usage

element diskspaceStatType/device
diagram
properties
isRef 0
content complex
children name total used free
annotation
documentation 
Partitions or devices

element diskspaceStatType/device/name
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse
annotation
documentation 
Partition or device name

element diskspaceStatType/device/total
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element diskspaceStatType/device/used
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element diskspaceStatType/device/free
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType initialSetupType
diagram
children admin password server_name
used by
element packet/server/initial_setup
annotation
documentation 
Data required for initial Plesk server setup

element initialSetupType/admin
diagram
type adminType
properties
isRef 0
content complex
children admin_cname admin_pname admin_phone admin_fax admin_email admin_address admin_city admin_state admin_pcode admin_country send_announce
annotation
documentation 
Server administrator data

element initialSetupType/password
diagram
type serverPassword
properties
isRef 0
content simple
facets
minLength 5
maxLength 14
whiteSpace collapse
annotation
documentation 
New Plesk server administrator password to be set on the server

element initialSetupType/server_name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Full hostname to be set on the server

complexType interfacesType
diagram
children interface
annotation
documentation 
Network interfaces

element interfacesType/interface
diagram
type netInterface
properties
isRef 0
content simple
facets
minLength 1
maxLength 200
whiteSpace collapse

complexType keyType
diagram
children plesk_key_id prod_type lim_date lim_slaves lim_cl lim_dom lim_mn lim_wu MLS MPCID noMPC noMngMPC key_vz key_mssql key_postgresql key_tomcat key_gch key_shell key_traffic key_cl_tmpl key_notifmgr key_eventmgr key_actionmgr key_dombackup key_expiration key_subdomains key_coldfusion key_cgitory key_spamassassin key_drweb key_sitebuilder key_tts license_update_date reseller_email key_migration key_askupdate key_nosappactivation store_id autoinstaller_config
annotation
documentation 
Server license key info

element keyType/plesk_key_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element keyType/prod_type
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element keyType/lim_date
diagram
type string
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
Expiration date, format YYYY-MM-DD

element keyType/lim_slaves
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/lim_cl
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element keyType/lim_dom
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element keyType/lim_mn
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element keyType/lim_wu
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element keyType/MLS
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/MPCID
diagram
type string
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/noMPC
diagram
type string
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/noMngMPC
diagram
type string
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_vz
diagram
type short
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_mssql
diagram
type short
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_postgresql
diagram
type short
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_tomcat
diagram
type short
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_gch
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_shell
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_traffic
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_cl_tmpl
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_notifmgr
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_eventmgr
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_actionmgr
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_dombackup
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_expiration
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_subdomains
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_coldfusion
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_cgitory
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_spamassassin
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_drweb
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/key_sitebuilder
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/key_tts
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element keyType/license_update_date
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/reseller_email
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/key_migration
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/key_askupdate
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/key_nosappactivation
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/store_id
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element keyType/autoinstaller_config
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

complexType load_avgStatType
diagram
children l1 l5 l15
used by
element statType/load_avg
annotation
documentation 
Server loads

element load_avgStatType/l1
diagram
type double
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element load_avgStatType/l5
diagram
type double
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element load_avgStatType/l15
diagram
type double
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

complexType memStatType
diagram
children total used free shared buffer cached
used by
element statType/mem
annotation
documentation 
Memory usage

element memStatType/total
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element memStatType/used
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element memStatType/free
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element memStatType/shared
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element memStatType/buffer
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element memStatType/cached
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType objectsStatType
diagram
children clients domains active_domains mail_boxes mail_redirects mail_groups mail_responders web_users databases database_users problem_clients problem_domains
used by
element statType/objects
annotation
documentation 
Objects statistics

element objectsStatType/clients
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/domains
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/active_domains
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/mail_boxes
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/mail_redirects
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/mail_groups
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/mail_responders
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/web_users
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/databases
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/database_users
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/problem_clients
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element objectsStatType/problem_domains
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

complexType otherStatType
diagram
children cpu uptime inside_vz
used by
element statType/other
annotation
documentation 
Miscellaneous server statistics

element otherStatType/cpu
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element otherStatType/uptime
diagram
type unsignedInt
properties
isRef 0
content simple
facets
whiteSpace collapse

element otherStatType/inside_vz
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType serverGenInfoType
diagram
children server_name
annotation
documentation 
Server general info

element serverGenInfoType/server_name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType serverPrefs
diagram
children stat_ttl traffic_accounting restart_apache_interval
used by
element packet/server/set/prefs
annotation
documentation 
Server preferences

element serverPrefs/stat_ttl
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Time-To-Live for traffic statistics (months)

element serverPrefs/traffic_accounting
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Traffic accounting type, bit mask, 1=in, 2=out
documentation 
Time-To-Live for traffic statistics (months)

element serverPrefs/restart_apache_interval
diagram
type int
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Apache restart interval (secs), not for Windows

complexType serverSessionSetup
diagram
children login_timeout lock_interval lock_attempts lock_time
used by
element packet/server/set/session_setup
annotation
documentation 
Server Sessions Setup

element serverSessionSetup/login_timeout
diagram
type restriction of int
properties
isRef 0
content simple
facets
minInclusive 1
maxInclusive 99999
whiteSpace collapse
annotation
documentation 
Login timeout/Session idle time (minutes)

element serverSessionSetup/lock_interval
diagram
type restriction of int
properties
isRef 0
content simple
facets
minInclusive 1
maxInclusive 99999
whiteSpace collapse
annotation
documentation 
Invalid login interval (minutes)

element serverSessionSetup/lock_attempts
diagram
type restriction of int
properties
isRef 0
content simple
facets
minInclusive 1
maxInclusive 99999
whiteSpace collapse
annotation
documentation 
Invalid login attempts (amount)

element serverSessionSetup/lock_time
diagram
type restriction of int
properties
isRef 0
content simple
facets
minInclusive 1
maxInclusive 99999
whiteSpace collapse
annotation
documentation 
Invalid login lock time (minutes)

complexType servicesState
diagram
children srv
annotation
documentation 
Server services state

element servicesState/srv
diagram
properties
isRef 0
content complex
children id title state error

element servicesState/srv/id
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
Service ID

element servicesState/srv/title
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
Service Title

element servicesState/srv/state
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 255
whiteSpace collapse
enumeration running
enumeration stopped
enumeration none
annotation
documentation 
Service State

element servicesState/srv/error
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
Optional Error

complexType shellType
diagram
children name path
annotation
documentation 
Server shell

element shellType/name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element shellType/path
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType statType
diagram
children objects version other load_avg mem swap diskspace
annotation
documentation 
Server statistics info

element statType/objects
diagram
type objectsStatType
properties
isRef 0
content complex
children clients domains active_domains mail_boxes mail_redirects mail_groups mail_responders web_users databases database_users problem_clients problem_domains
annotation
documentation 
Logical objects usage

element statType/version
diagram
type versionStatType
properties
isRef 0
content complex
children plesk_name plesk_version plesk_os plesk_os_version plesk_build os_release
annotation
documentation 
Server version info

element statType/other
diagram
type otherStatType
properties
isRef 0
content complex
children cpu uptime inside_vz
annotation
documentation 
Miscellaneous server statistics

element statType/load_avg
diagram
type load_avgStatType
properties
isRef 0
content complex
children l1 l5 l15
annotation
documentation 
Server load

element statType/mem
diagram
type memStatType
properties
isRef 0
content complex
children total used free shared buffer cached
annotation
documentation 
Memory usage

element statType/swap
diagram
type swapStatType
properties
isRef 0
content complex
children total used free
annotation
documentation 
Swap usage

element statType/diskspace
diagram
type diskspaceStatType
properties
isRef 0
content complex
children device
annotation
documentation 
Disk usage

complexType swapStatType
diagram
children total used free
used by
element statType/swap
annotation
documentation 
Swap usage

element swapStatType/total
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element swapStatType/used
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

element swapStatType/free
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType versionStatType
diagram
children plesk_name plesk_version plesk_os plesk_os_version plesk_build os_release
used by
element statType/version
annotation
documentation 
Server versions

element versionStatType/plesk_name
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse

element versionStatType/plesk_version
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse

element versionStatType/plesk_os
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse
annotation
documentation 
e.g. "RedHat","FedoraCore"

element versionStatType/plesk_os_version
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse
annotation
documentation 
e.g. "9.0"

element versionStatType/plesk_build
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse

element versionStatType/os_release
diagram
type restriction of xs:string
properties
isRef 0
content simple
facets
minLength 1
whiteSpace collapse

simpleType serverPassword
type restriction of string
used by
elements packet/server/set/password initialSetupType/password
facets
minLength 5
maxLength 14
whiteSpace collapse
annotation
documentation 
Server Admin password

simpleType srvIdType
type string
used by
element packet/server/srv_man/id
facets
whiteSpace collapse
annotation
documentation 
Service ID

simpleType srvOpType
type restriction of string
used by
element packet/server/srv_man/operation
facets
whiteSpace collapse
enumeration start
enumeration stop
enumeration restart
annotation
documentation 
Service operation

complexType buttonDataType
diagram
children code type name name_id group_name group_name_id href js_onclick enabled new_window tabindex
annotation
documentation 
Button data

element buttonDataType/code
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button string ID

element buttonDataType/type
diagram
type restriction of string
properties
isRef 0
content simple
facets
whiteSpace collapse
enumeration link_button
enumeration comm_button
annotation
documentation 
Button type

element buttonDataType/name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button name

element buttonDataType/name_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button name (string ID for localization)

element buttonDataType/group_name
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button owner group name

element buttonDataType/group_name_id
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button owner group name (string ID for localization)

element buttonDataType/href
diagram
type urlType
properties
isRef 0
content simple
facets
maxLength 255
whiteSpace collapse
annotation
documentation 
Button linked to

element buttonDataType/js_onclick
diagram
type text
properties
isRef 0
content simple
facets
whiteSpace preserve
annotation
documentation 
JavaScript code associated with the button onClick event handle

element buttonDataType/enabled
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Button enabled flag

element buttonDataType/new_window
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
New window flag. It should be specified in protocol 1.3.1.7 and higher

element buttonDataType/tabindex
diagram
type int
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
Button tabulation index

simpleType expandIPUsageStatus
type restriction of string
facets
whiteSpace collapse
enumeration free
enumeration reserved
enumeration assigned
annotation
documentation 
IP address usage status in Expand DB

simpleType forwardingURL
type restriction of string
facets
minLength 1
maxLength 255
whiteSpace collapse
annotation
documentation 
URL, only symbolic name, not an IP

simpleType garbageOutput
type string
facets
whiteSpace collapse
annotation
documentation 
Garbage Output, for debug

simpleType ipType
type restriction of string
facets
whiteSpace collapse
enumeration shared
enumeration exclusive
annotation
documentation 
IP address usage status in Expand DB

simpleType netInterface
type restriction of string
used by
element interfacesType/interface
facets
minLength 1
maxLength 200
whiteSpace collapse
annotation
documentation 
Server Network Interface name

simpleType objectStatus
type int
facets
whiteSpace collapse
annotation
documentation 
Plesk client and domain status.
Bit mask with bit flags:

0 - object is active
4 - object is under backup/restore

16 - object is disabled by Administrator

64 - object is disabled by Client

256 - object expired
Only 0, 16 and 64 flags are available for setting

simpleType pleskOS
type restriction of string
facets
whiteSpace collapse
enumeration Windows
enumeration RedHat
annotation
documentation 
Operation System, see enumerations for details

complexType resultType
diagram
children status errcode errtext
annotation
documentation 
Operation result

element resultType/status
diagram
type result_status
properties
isRef 0
content simple
facets
enumeration ok
enumeration error
annotation
documentation 
Result status (ok/error)

element resultType/errcode
diagram
type unsignedInt
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Error code if error occurred

element resultType/errtext
diagram
type xs:string
properties
isRef 0
content simple
annotation
documentation 
Error message if error occurred

simpleType base64
type restriction of xs:base64Binary
used by
element packet/server/lic_install/license
facets
whiteSpace collapse

simpleType boolean
type restriction of xs:boolean
used by
elements buttonDataType/enabled otherStatType/inside_vz buttonDataType/new_window adminType/send_announce
facets
whiteSpace collapse

simpleType date
type restriction of xs:date
facets
whiteSpace collapse

simpleType datetime
type restriction of xs:dateTime
facets
whiteSpace collapse

simpleType double
type restriction of xs:double
used by
elements load_avgStatType/l1 load_avgStatType/l15 load_avgStatType/l5
facets
whiteSpace collapse

simpleType emailType
type restriction of string
used by
element adminType/admin_email
facets
minLength 3
maxLength 255
whiteSpace collapse
pattern [\-\p{L}\p{N}\.]*@([\p{L}\p{N}][\-\p{L}\p{N}]*\.)*[\p{L}][\-\p{L}\p{N}]*\.?
annotation
documentation 
Any e-mail address

simpleType id_type
type restriction of xs:positiveInteger
facets
whiteSpace collapse
annotation
documentation 
Item ID

simpleType int
type restriction of xs:integer
used by
elements keyType/autoinstaller_config keyType/key_actionmgr keyType/key_askupdate keyType/key_cgitory keyType/key_cl_tmpl keyType/key_coldfusion keyType/key_dombackup keyType/key_drweb keyType/key_eventmgr keyType/key_expiration keyType/key_gch keyType/key_migration keyType/key_nosappactivation keyType/key_notifmgr keyType/key_shell keyType/key_sitebuilder keyType/key_spamassassin keyType/key_subdomains keyType/key_traffic keyType/key_tts keyType/license_update_date serverSessionSetup/lock_attempts serverSessionSetup/lock_interval serverSessionSetup/lock_time serverSessionSetup/login_timeout serverPrefs/restart_apache_interval serverPrefs/stat_ttl keyType/store_id buttonDataType/tabindex serverPrefs/traffic_accounting
simpleType objectStatus
facets
whiteSpace collapse

simpleType ip_address
type restriction of xs:string
facets
minLength 1
maxLength 15
whiteSpace collapse

simpleType passwdType
type restriction of string
facets
minLength 4
maxLength 64
whiteSpace collapse
annotation
documentation 
Typical password

simpleType result_status
type restriction of xs:string
used by
element resultType/status
facets
enumeration ok
enumeration error
annotation
documentation 
Result status

simpleType short
type restriction of xs:short
used by
elements keyType/key_mssql keyType/key_postgresql keyType/key_tomcat keyType/key_vz
facets
whiteSpace collapse

simpleType size
type restriction of xs:unsignedLong
used by
elements memStatType/buffer memStatType/cached memStatType/free swapStatType/free diskspaceStatType/device/free memStatType/shared memStatType/total swapStatType/total diskspaceStatType/device/total memStatType/used swapStatType/used diskspaceStatType/device/used
facets
whiteSpace collapse

simpleType string
type restriction of xs:string
used by
elements adminType/admin_address adminType/admin_city adminType/admin_cname adminType/admin_country adminType/admin_fax adminType/admin_phone adminType/admin_pname adminType/admin_state buttonDataType/code otherStatType/cpu servicesState/srv/error buttonDataType/group_name buttonDataType/group_name_id servicesState/srv/id keyType/lim_cl keyType/lim_date keyType/lim_dom keyType/lim_mn keyType/lim_wu keyType/MPCID buttonDataType/name componentsType/component/name shellType/name buttonDataType/name_id keyType/noMngMPC keyType/noMPC shellType/path keyType/plesk_key_id keyType/prod_type keyType/reseller_email initialSetupType/server_name serverGenInfoType/server_name servicesState/srv/state servicesState/srv/title buttonDataType/type componentsType/component/version
simpleTypes emailType expandIPUsageStatus forwardingURL garbageOutput ipType netInterface passwdType pleskOS serverPassword srvIdType srvOpType urlType zipcodeType
attribute packet/@version
facets
whiteSpace collapse

simpleType text
type restriction of xs:string
used by
element buttonDataType/js_onclick
facets
whiteSpace preserve

simpleType unsignedInt
type restriction of xs:unsignedInt
used by
elements objectsStatType/active_domains objectsStatType/clients objectsStatType/database_users objectsStatType/databases objectsStatType/domains resultType/errcode keyType/lim_slaves objectsStatType/mail_boxes objectsStatType/mail_groups objectsStatType/mail_redirects objectsStatType/mail_responders keyType/MLS objectsStatType/problem_clients objectsStatType/problem_domains otherStatType/uptime objectsStatType/web_users
facets
whiteSpace collapse

simpleType unsignedShort
type restriction of xs:unsignedShort
facets
whiteSpace collapse

simpleType urlType
type restriction of string
used by
element buttonDataType/href
facets
maxLength 255
whiteSpace collapse
annotation
documentation 
URL

simpleType zipcodeType
type restriction of string
used by
element adminType/admin_pcode
facets
maxLength 10
whiteSpace collapse


Schema server_output.xsd


schema location:  server_output.xsd
 
Elements 
packet 


schema location:  plesk_server.xsd
 
Complex types  Simple types 
adminType  serverPassword 
componentsType  srvIdType 
diskspaceStatType  srvOpType 
initialSetupType 
interfacesType 
keyType 
load_avgStatType 
memStatType 
objectsStatType 
otherStatType 
serverGenInfoType 
serverPrefs 
serverSessionSetup 
servicesState 
shellType 
statType 
swapStatType 
versionStatType 


schema location:  plesk_common.xsd
 
Complex types  Simple types 
buttonDataType  expandIPUsageStatus 
forwardingURL 
garbageOutput 
ipType 
netInterface 
objectStatus 
pleskOS 


schema location:  common.xsd
 
Complex types  Simple types 
resultType  base64 
boolean 
date 
datetime 
double 
emailType 
id_type 
int 
ip_address 
passwdType 
result_status 
short 
size 
string 
text 
unsignedInt 
unsignedShort 
urlType 
zipcodeType 


element packet
diagram
properties
content complex
children server system output
attributes
Name  Type  Use  Default  Fixed  Annotation
version  stringrequired      
annotation
documentation 
Root node for any input

element packet/server
diagram
properties
isRef 0
content complex
children get_protos get set srv_man lic_install initial_setup
annotation
documentation 
Server operator

element packet/server/get_protos
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
Get supported PA protocols

element packet/server/get_protos/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext protos

element packet/server/get_protos/result/protos
diagram
properties
isRef 0
content complex
children proto

element packet/server/get_protos/result/protos/proto
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element packet/server/get
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
"Get" operation

element packet/server/get/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext key gen_info components stat admin interfaces services_state prefs shells session_setup

element packet/server/get/result/key
diagram