PLESK RPC API

Chapter 4. Plesk RPC API Protocol

In the further given schemas, used for forming packets with data for various operations, the schemas with the INPUT term describe packets with the data received at the input by Plesk. Correspondingly, the schemas with the OUTPUT term describe packets with the data returned by Plesk to an external application after the action of the handler that was called in by an incoming INPUT packet. 

Section 4.1 Performing Operations on Client Accounts

These operations allow for managing client data, i.e. creating new client accounts, editing client account properties, receiving info on certain client accounts.

Client input:

Schema client_input.xsd


schema location:  client_input.xsd
 
Elements  Complex types 
packet  filterType 


schema location:  plesk_client.xsd
 
Complex types 
clientAddGenInfo 
clientData 
clientGetGenInfo 
clientLimits 
clientPerms 
clientSetGenInfo 
datasetType 
ipPoolOperateType 
ipPoolType 
poolOperationResult 
statType 


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 client
attributes
Name  Type  Use  Default  Fixed  Annotation
version  stringrequired      
annotation
documentation 
Root node for any input

element packet/client
diagram
properties
isRef 0
content complex
children add get del set ippool_add_ip ippool_del_ip cform_buttons_list
annotation
documentation 
Client operator request

element packet/client/add
diagram
properties
isRef 0
content complex
children gen_info

element packet/client/add/gen_info
diagram
type clientAddGenInfo
properties
isRef 0
content complex
children cname pname login passwd status phone fax email address city state pcode country locale

element packet/client/get
diagram
properties
isRef 0
content complex
children filter dataset
annotation
documentation 
Get client accounts data from server

element packet/client/get/filter
diagram
type filterType
properties
isRef 0
content complex
children id
annotation
documentation 
Filter client accounts to be refreshed

element packet/client/get/dataset
diagram
type datasetType
properties
isRef 0
content complex
children gen_info stat permissions limits ippool
annotation
documentation 
Client information to be updated

element packet/client/del
diagram
properties
isRef 0
content complex
children filter
annotation
documentation 
Delete client account(s) from server

element packet/client/del/filter
diagram
type filterType
properties
isRef 0
content complex
children id
annotation
documentation 
Filter client accounts to be deleted

element packet/client/set
diagram
properties
isRef 0
content complex
children filter values
annotation
documentation 
Set client account properties

element packet/client/set/filter
diagram
type filterType
properties
isRef 0
content complex
children id
annotation
documentation 
Filter client accounts to be refreshed

element packet/client/set/values
diagram
properties
isRef 0
content complex
children gen_info limits permissions

element packet/client/set/values/gen_info
diagram
type clientSetGenInfo
properties
isRef 0
content complex
children cname pname login passwd status phone fax email address city state pcode country locale
annotation
documentation 
Client info

element packet/client/set/values/limits
diagram
type clientLimits
properties
isRef 0
content complex
children expiration max_webapps max_maillists max_resp max_mg max_redir mbox_quota max_box max_db max_wu max_traffic disk_space max_subdom max_dom
annotation
documentation 
Client limits

element packet/client/set/values/permissions
diagram
type clientPerms
properties
isRef 0
content complex
children create_domains manage_phosting manage_quota manage_subdomains manage_not_chroot_shell change_limits manage_dns manage_log manage_crontab manage_anonftp manage_webapps manage_sh_access manage_maillists manage_drweb make_dumps site_builder
annotation
documentation 
Client Permissions

element packet/client/ippool_add_ip
diagram
type ipPoolOperateType
properties
isRef 0
content complex
children client_id ip_address
annotation
documentation 
Add IP address(es) to the client's IP pool

element packet/client/ippool_del_ip
diagram
type ipPoolOperateType
properties
isRef 0
content complex
children client_id ip_address
annotation
documentation 
Delete the IP address(es) from the client's IP pool

element packet/client/cform_buttons_list
diagram
properties
isRef 0
content complex
children filter
annotation
documentation 
Show the list of buttons from the client page

element packet/client/cform_buttons_list/filter
diagram
type filterType
properties
isRef 0
content complex
children id
annotation
documentation 
Filter client accounts to be listed

complexType filterType
diagram
children id
used by
elements packet/client/get/filter packet/client/del/filter packet/client/set/filter packet/client/cform_buttons_list/filter
annotation
documentation 
Filter the list of client acounts

element filterType/id
diagram
type id_type
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Client ID

complexType clientAddGenInfo
diagram
children cname pname login passwd status phone fax email address city state pcode country locale
used by
element packet/client/add/gen_info
annotation
documentation 
General info required for adding a Client

element clientAddGenInfo/cname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 60
whiteSpace collapse

element clientAddGenInfo/pname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 60
whiteSpace collapse

element clientAddGenInfo/login
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 20
whiteSpace collapse

element clientAddGenInfo/passwd
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 5
maxLength 14
whiteSpace collapse

element clientAddGenInfo/status
diagram
type objectStatus
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
0:ACTIVE, 16:DISABLED_BY ADMIN, 4:UNDER BACKUP/RESTORE, 256: EXPIRED

element clientAddGenInfo/phone
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientAddGenInfo/fax
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientAddGenInfo/email
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 255
whiteSpace collapse

element clientAddGenInfo/address
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 255
whiteSpace collapse

element clientAddGenInfo/city
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 50
whiteSpace collapse

element clientAddGenInfo/state
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 50
whiteSpace collapse
annotation
documentation 
Should be filled in for US

element clientAddGenInfo/pcode
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 10
whiteSpace collapse
annotation
documentation 
Should be filled in for US

element clientAddGenInfo/country
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 2
maxLength 2
whiteSpace collapse
annotation
documentation 
Example: US

element clientAddGenInfo/locale
diagram
type string
properties
isRef 0
content simple
default en
facets
whiteSpace collapse

complexType clientData
diagram
children gen_info stat permissions limits ippool
annotation
documentation 
Client data

element clientData/gen_info
diagram
type clientGetGenInfo
properties
isRef 0
content complex
children cr_date cname pname login status phone fax email address city state pcode country locale

element clientData/stat
diagram
type statType
properties
isRef 0
content complex
children active_domains subdomains disk_space postboxs redirects mail_groups mail_resps mail_lists web_users data_bases webapps traffic traffic_prevday

element clientData/permissions
diagram
type clientPerms
properties
isRef 0
content complex
children create_domains manage_phosting manage_quota manage_subdomains manage_not_chroot_shell change_limits manage_dns manage_log manage_crontab manage_anonftp manage_webapps manage_sh_access manage_maillists manage_drweb make_dumps site_builder
annotation
documentation 
Client Permissions

element clientData/limits
diagram
type clientLimits
properties
isRef 0
content complex
children expiration max_webapps max_maillists max_resp max_mg max_redir mbox_quota max_box max_db max_wu max_traffic disk_space max_subdom max_dom

element clientData/ippool
diagram
type ipPoolType
properties
isRef 0
content complex
children ip_address

complexType clientGetGenInfo
diagram
children cr_date cname pname login status phone fax email address city state pcode country locale
used by
element clientData/gen_info
annotation
documentation 
General info received when requesting about a Client

element clientGetGenInfo/cr_date
diagram
type date
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientGetGenInfo/cname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 60
whiteSpace collapse

element clientGetGenInfo/pname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 60
whiteSpace collapse

element clientGetGenInfo/login
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 20
whiteSpace collapse

element clientGetGenInfo/status
diagram
type objectStatus
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element clientGetGenInfo/phone
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientGetGenInfo/fax
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientGetGenInfo/email
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 255
whiteSpace collapse

element clientGetGenInfo/address
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 255
whiteSpace collapse

element clientGetGenInfo/city
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 50
whiteSpace collapse

element clientGetGenInfo/state
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 50
whiteSpace collapse

element clientGetGenInfo/pcode
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 10
whiteSpace collapse

element clientGetGenInfo/country
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 2
whiteSpace collapse

element clientGetGenInfo/locale
diagram
type string
properties
isRef 0
content simple
default en
facets
whiteSpace collapse

complexType clientLimits
diagram
children expiration max_webapps max_maillists max_resp max_mg max_redir mbox_quota max_box max_db max_wu max_traffic disk_space max_subdom max_dom
used by
elements packet/client/set/values/limits clientData/limits
annotation
documentation 
Client Limits

element clientLimits/expiration
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_webapps
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_maillists
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_resp
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_mg
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_redir
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/mbox_quota
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_box
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_db
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_wu
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_traffic
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/disk_space
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_subdom
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientLimits/max_dom
diagram
type string
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType clientPerms
diagram
children create_domains manage_phosting manage_quota manage_subdomains manage_not_chroot_shell change_limits manage_dns manage_log manage_crontab manage_anonftp manage_webapps manage_sh_access manage_maillists manage_drweb make_dumps site_builder
used by
elements packet/client/set/values/permissions clientData/permissions
annotation
documentation 
Client Permissions

element clientPerms/create_domains
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_phosting
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_quota
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_subdomains
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_not_chroot_shell
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/change_limits
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_dns
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_log
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_crontab
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_anonftp
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_webapps
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_sh_access
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_maillists
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/manage_drweb
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

element clientPerms/make_dumps
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse

element clientPerms/site_builder
diagram
type boolean
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Plesk >= 7.1

complexType clientSetGenInfo
diagram
children cname pname login passwd status phone fax email address city state pcode country locale
used by
element packet/client/set/values/gen_info
annotation
documentation 
General info to be set for a Client

element clientSetGenInfo/cname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 60
whiteSpace collapse

element clientSetGenInfo/pname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 60
whiteSpace collapse

element clientSetGenInfo/login
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 20
whiteSpace collapse

element clientSetGenInfo/passwd
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 5
maxLength 14
whiteSpace collapse

element clientSetGenInfo/status
diagram
type objectStatus
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element clientSetGenInfo/phone
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientSetGenInfo/fax
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientSetGenInfo/email
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 255
whiteSpace collapse

element clientSetGenInfo/address
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 255
whiteSpace collapse

element clientSetGenInfo/city
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 50
whiteSpace collapse

element clientSetGenInfo/state
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 50
whiteSpace collapse

element clientSetGenInfo/pcode
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 10
whiteSpace collapse

element clientSetGenInfo/country
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 2
whiteSpace collapse

element clientSetGenInfo/locale
diagram
type string
properties
isRef 0
content simple
default en
facets
whiteSpace collapse

complexType datasetType
diagram
children gen_info stat permissions limits ippool
used by
element packet/client/get/dataset
annotation
documentation 
Data to be operated

element datasetType/gen_info
diagram
properties
isRef 0
annotation
documentation 
Client general info

element datasetType/stat
diagram
properties
isRef 0
annotation
documentation 
Client statistics

element datasetType/permissions
diagram
properties
isRef 0
annotation
documentation 
Client permissions

element datasetType/limits
diagram
properties
isRef 0
annotation
documentation 
Client limits

element datasetType/ippool
diagram
properties
isRef 0
annotation
documentation 
IP pool configuration

complexType ipPoolOperateType
diagram
children client_id ip_address
used by
elements packet/client/ippool_add_ip packet/client/ippool_del_ip
annotation
documentation 
Data to operate the client IP pool

element ipPoolOperateType/client_id
diagram
type id_type
properties
isRef 0
content simple
facets
whiteSpace collapse

element ipPoolOperateType/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

complexType ipPoolType
diagram
children ip_address
used by
element clientData/ippool
annotation
documentation 
Client IP pool data

element ipPoolType/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

complexType poolOperationResult
diagram
type extension of resultType
properties
base resultType
children status errcode errtext ip_address client_id
annotation
documentation 
IP pool operation result

element poolOperationResult/ip_address
diagram
type ip_address
properties
isRef 0
content simple
facets
minLength 1
maxLength 15
whiteSpace collapse

element poolOperationResult/client_id
diagram
type id_type
properties
isRef 0
content simple
facets
whiteSpace collapse

complexType statType
diagram
children active_domains subdomains disk_space postboxs redirects mail_groups mail_resps mail_lists web_users data_bases webapps traffic traffic_prevday
used by
element clientData/stat
annotation
documentation 
Client statistics

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

element statType/subdomains
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element statType/disk_space
diagram
type size
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element statType/postboxs
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element statType/redirects
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

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

element statType/mail_resps
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element statType/mail_lists
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

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

element statType/data_bases
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element statType/webapps
diagram
type unsignedInt
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse

element statType/traffic
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Monthly traffic in bytes

element statType/traffic_prevday
diagram
type size
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Total traffic for prev.day (in bytes)

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
facets
minLength 1
maxLength 200
whiteSpace collapse
annotation
documentation 
Server Network Interface name

simpleType objectStatus
type int
used by
elements clientAddGenInfo/status clientSetGenInfo/status clientGetGenInfo/status
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
used by
complexType poolOperationResult
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
facets
whiteSpace collapse

simpleType boolean
type restriction of xs:boolean
used by
elements clientPerms/change_limits clientPerms/create_domains buttonDataType/enabled clientPerms/make_dumps clientPerms/manage_anonftp clientPerms/manage_crontab clientPerms/manage_dns clientPerms/manage_drweb clientPerms/manage_log clientPerms/manage_maillists clientPerms/manage_not_chroot_shell clientPerms/manage_phosting clientPerms/manage_quota clientPerms/manage_sh_access clientPerms/manage_subdomains clientPerms/manage_webapps buttonDataType/new_window clientPerms/site_builder
facets
whiteSpace collapse

simpleType date
type restriction of xs:date
used by
element clientGetGenInfo/cr_date
facets
whiteSpace collapse

simpleType datetime
type restriction of xs:dateTime
facets
whiteSpace collapse

simpleType double
type restriction of xs:double
facets
whiteSpace collapse

simpleType emailType
type restriction of string
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
used by
elements ipPoolOperateType/client_id poolOperationResult/client_id filterType/id
facets
whiteSpace collapse
annotation
documentation 
Item ID

simpleType int
type restriction of xs:integer
used by
element buttonDataType/tabindex
simpleType objectStatus
facets
whiteSpace collapse

simpleType ip_address
type restriction of xs:string
used by
elements ipPoolType/ip_address ipPoolOperateType/ip_address poolOperationResult/ip_address
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
facets
whiteSpace collapse

simpleType size
type restriction of xs:unsignedLong
used by
elements statType/disk_space statType/traffic statType/traffic_prevday
facets
whiteSpace collapse

simpleType string
type restriction of xs:string
used by
elements clientSetGenInfo/address clientGetGenInfo/address clientAddGenInfo/address clientSetGenInfo/city clientAddGenInfo/city clientGetGenInfo/city clientAddGenInfo/cname clientGetGenInfo/cname clientSetGenInfo/cname buttonDataType/code clientSetGenInfo/country clientAddGenInfo/country clientGetGenInfo/country clientLimits/disk_space clientAddGenInfo/email clientGetGenInfo/email clientSetGenInfo/email clientLimits/expiration clientGetGenInfo/fax clientAddGenInfo/fax clientSetGenInfo/fax buttonDataType/group_name buttonDataType/group_name_id clientSetGenInfo/locale clientAddGenInfo/locale clientGetGenInfo/locale clientAddGenInfo/login clientGetGenInfo/login clientSetGenInfo/login clientLimits/max_box clientLimits/max_db clientLimits/max_dom clientLimits/max_maillists clientLimits/max_mg clientLimits/max_redir clientLimits/max_resp clientLimits/max_subdom clientLimits/max_traffic clientLimits/max_webapps clientLimits/max_wu clientLimits/mbox_quota buttonDataType/name buttonDataType/name_id clientSetGenInfo/passwd clientAddGenInfo/passwd clientAddGenInfo/pcode clientGetGenInfo/pcode clientSetGenInfo/pcode clientAddGenInfo/phone clientGetGenInfo/phone clientSetGenInfo/phone clientSetGenInfo/pname clientGetGenInfo/pname clientAddGenInfo/pname clientAddGenInfo/state clientGetGenInfo/state clientSetGenInfo/state buttonDataType/type
simpleTypes emailType expandIPUsageStatus forwardingURL garbageOutput ipType netInterface passwdType pleskOS 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 statType/active_domains statType/data_bases resultType/errcode statType/mail_groups statType/mail_lists statType/mail_resps statType/postboxs statType/redirects statType/subdomains statType/web_users statType/webapps
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
facets
maxLength 10
whiteSpace collapse


Schema client_output.xsd


schema location:  client_output.xsd
 
Elements  Complex types 
packet  operationResult 


schema location:  plesk_client.xsd
 
Complex types 
clientAddGenInfo 
clientData 
clientGetGenInfo 
clientLimits 
clientPerms 
clientSetGenInfo 
datasetType 
ipPoolOperateType 
ipPoolType 
poolOperationResult 
statType 


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 client system output
attributes
Name  Type  Use  Default  Fixed  Annotation
version  stringrequired      
annotation
documentation 
Root node for any input

element packet/client
diagram
properties
isRef 0
content complex
children add get del set ippool_add_ip ippool_del_ip cform_buttons_list
annotation
documentation 
Client operator request

element packet/client/add
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
Add a new client account

element packet/client/add/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext id

element packet/client/add/result/id
diagram
type id_type
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
New client ID upon success

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

element packet/client/get/result
diagram
type extension of operationResult
properties
isRef 0
content complex
children status errcode errtext id data

element packet/client/get/result/data
diagram
type clientData
properties
isRef 0
content complex
children gen_info stat permissions limits ippool
annotation
documentation 
Client data. Will not be returned if status isn't "ok"

element packet/client/del
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
"Delete" operation result

element packet/client/del/result
diagram
type operationResult
properties
isRef 0
content complex
children status errcode errtext id

element packet/client/set
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
Modify client

element packet/client/set/result
diagram
type operationResult
properties
isRef 0
content complex
children status errcode errtext id

element packet/client/ippool_add_ip
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
The result of adding the IP address(es) to the client's IP pool

element packet/client/ippool_add_ip/result
diagram
type poolOperationResult
properties
isRef 0
content complex
children status errcode errtext ip_address client_id

element packet/client/ippool_del_ip
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
The result of deleting the IP address(es) from the client's IP pool

element packet/client/ippool_del_ip/result
diagram
type poolOperationResult
properties
isRef 0
content complex
children status errcode errtext ip_address client_id

element packet/client/cform_buttons_list
diagram
properties
isRef 0
content complex
children result
annotation
documentation 
The result of showing the list of the Client page buttons

element packet/client/cform_buttons_list/result
diagram
type extension of resultType
properties
isRef 0
content complex
children status errcode errtext id button

element packet/client/cform_buttons_list/result/id
diagram
type id_type
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Client ID

element packet/client/cform_buttons_list/result/button
diagram
type buttonDataType
properties
isRef 0
content complex
children code type name name_id group_name group_name_id href js_onclick enabled new_window tabindex
annotation
documentation 
The list of buttons if no error occured

element packet/system
diagram
type resultType
properties
isRef 0
content complex
children status errcode errtext
annotation
documentation 
The result from PA system level

element packet/output
diagram
type garbageOutput
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Debug garbage

complexType operationResult
diagram
type extension of resultType
properties
base resultType
children status errcode errtext id
used by
elements packet/client/get/result packet/client/del/result packet/client/set/result
annotation
documentation 
Typical operation result type

element operationResult/id
diagram
type id_type
properties
isRef 0
content simple
facets
whiteSpace collapse
annotation
documentation 
Client ID

complexType clientAddGenInfo
diagram
children cname pname login passwd status phone fax email address city state pcode country locale
annotation
documentation 
General info required for adding a Client

element clientAddGenInfo/cname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 60
whiteSpace collapse

element clientAddGenInfo/pname
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 60
whiteSpace collapse

element clientAddGenInfo/login
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 1
maxLength 20
whiteSpace collapse

element clientAddGenInfo/passwd
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 5
maxLength 14
whiteSpace collapse

element clientAddGenInfo/status
diagram
type objectStatus
properties
isRef 0
content simple
default 0
facets
whiteSpace collapse
annotation
documentation 
0:ACTIVE, 16:DISABLED_BY ADMIN, 4:UNDER BACKUP/RESTORE, 256: EXPIRED

element clientAddGenInfo/phone
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientAddGenInfo/fax
diagram
type restriction of string
properties
isRef 0
content simple
facets
minLength 0
maxLength 30
whiteSpace collapse

element clientAddGenInfo/email