Section 4.2 Performing
Operations on
Domains
The structures, described here allow for building packets
that
contain info necessary for performing operations on domains, such as
creating new domains, removing them, editing domain properties, and
| diagram |
 |
| properties |
|
| children |
domain |
| attributes |
| Name | Type | Use | Default | Fixed | Annotation | | version | string | required | | | |
|
| annotation |
| documentation | Root node for any input |
|
| diagram |
 |
| type |
domainName |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 255 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
id_type |
| properties |
|
| facets |
|
| diagram |
 |
| type |
domainHType |
| properties |
|
| facets |
| whiteSpace | collapse | | enumeration | vrt_hst | | enumeration | std_fwd | | enumeration | frm_fwd | | enumeration | none |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
string |
| properties |
|
| facets |
|
| diagram |
 |
| properties |
|
| children |
filter dataset |
| annotation |
| documentation | Get domain(s) data from server |
|
| diagram |
 |
| type |
filterType |
| properties |
|
| children |
id client_id |
| annotation |
| documentation | Filter domains to be refreshed |
|
| diagram |
 |
| properties |
|
| children |
filter values |
| annotation |
| documentation | Set domain(s) data from server |
|
| diagram |
 |
| type |
filterType |
| properties |
|
| children |
id client_id |
| annotation |
| documentation | Filter domains to be refreshed |
|
| diagram |
 |
| properties |
|
| children |
filter |
| annotation |
| documentation | Delete domain(s) from the server |
|
| diagram |
 |
| type |
filterType |
| properties |
|
| children |
id client_id |
| annotation |
| documentation | Filter domains to be deleted |
|
| diagram |
 |
| properties |
|
| children |
filter |
| annotation |
| documentation | Show the list of buttons from the Domain page |
|
| diagram |
 |
| type |
filterType |
| properties |
|
| children |
id client_id |
| annotation |
| documentation | Filter domains to be listed |
|
| diagram |
 |
| children |
id client_id |
| used by |
|
| annotation |
| documentation | Filter the list of domains |
|
| diagram |
 |
| type |
id_type |
| properties |
|
| facets |
|
| annotation |
| documentation | Domain ID (ID in Plesk DB) |
|
| diagram |
 |
| properties |
|
| annotation |
| documentation | The ID of the client the domain owner belongs to |
|
| diagram |
 |
| properties |
|
| diagram |
 |
| properties |
|
| diagram |
 |
| properties |
|
| diagram |
 |
| properties |
|
| diagram |
 |
| properties |
|
| diagram |
 |
| properties |
|
| diagram |
 |
| children |
vrt_hst std_fwd frm_fwd |
| annotation |
| documentation | Domain Hosting based on Template (Expand/Plesk Operator specific) |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| type |
domainLogin |
| properties |
|
| facets |
| whiteSpace | collapse | | pattern | [a-z]{1}[\-a-z0-9_.]{0,16} |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 255 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 20 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Login |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 16 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Password |
|
| diagram |
 |
| type |
string |
| properties |
|
| facets |
|
| annotation |
| documentation | Must be specified if the template presets creation of a domain with shell access enabled |
|
| diagram |
 |
| children |
dest_url |
| used by |
|
| annotation |
| documentation | Domain Frame Forwarding Hosting |
|
| diagram |
 |
| type |
forwardingURL |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 255 | | whiteSpace | collapse |
|
| annotation |
| documentation | Destination URL |
|
| diagram |
 |
| type |
date |
| properties |
|
| facets |
|
| diagram |
 |
| type |
domainName |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 255 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
string |
| properties |
|
| facets |
|
| annotation |
| documentation | Domain name to be displayed in UI |
|
| diagram |
 |
| type |
size |
| properties |
| isRef | 0 | | content | simple | | default | 0 |
|
| facets |
|
| diagram |
 |
| type |
id_type |
| properties |
|
| facets |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Domain IP address in DNS A record. Use it in case of a non-existent domain hosting. |
|
| diagram |
 |
| type |
domainHType |
| properties |
|
| facets |
| whiteSpace | collapse | | enumeration | vrt_hst | | enumeration | std_fwd | | enumeration | frm_fwd | | enumeration | none |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| properties |
|
| annotation |
|
| diagram |
 |
| children |
vrt_hst std_fwd frm_fwd none |
| annotation |
| documentation | Domain Hosting (Plesk RPC API specific) for 'get' operation |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| properties |
|
| annotation |
|
| diagram |
 |
| children |
vrt_hst std_fwd frm_fwd none |
| annotation |
| documentation | Domain Hosting (Plesk RPC API specific) for 'set' operation |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| diagram |
 |
| properties |
|
| annotation |
|
| diagram |
 |
| children |
vrt_hst std_fwd frm_fwd none |
| annotation |
| documentation | Domain Hosting (Expand/Plesk Operator specific) for 'get' operation. |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| properties |
|
| annotation |
|
| diagram |
 |
| children |
vrt_hst std_fwd frm_fwd none |
| annotation |
| documentation | Domain Hosting (Expand/Plesk Operator specific) for 'set' operation |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| type |
ip_address |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 15 | | whiteSpace | collapse |
|
| annotation |
| documentation | Additionally specify a different IP address from domain general setup |
|
| diagram |
 |
| properties |
|
| annotation |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
| documentation | Bytes per month |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
| documentation | Unix timestamp |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Plesk >= 7.1 |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Plesk >= 7.1 |
|
| diagram |
 |
| type |
domainLogin |
| properties |
|
| facets |
| whiteSpace | collapse | | pattern | [a-z]{1}[\-a-z0-9_.]{0,16} |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 64 | | whiteSpace | collapse |
|
| annotation |
| documentation | Password should not be equal to Login |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
| documentation | Hard Disk Quota, MB |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | FrontPage support enabled |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | FrontPage over SSL support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Authorization enabled? |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 16 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Login |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 20 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Password |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
restriction of string |
| properties |
| isRef | 0 | | content | simple | | default | /bin/false |
|
| facets |
| maxLength | 255 | | whiteSpace | collapse |
|
| annotation |
| documentation | system shell |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | PHP support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | SSI support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | CGI support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | mod_perl support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | mod_python support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Apache ASP support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | ASP dot net support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Coldfusion support |
|
| diagram |
 |
| type |
webstatType |
| properties |
|
| facets |
| whiteSpace | collapse | | enumeration | none | | enumeration | webalizer | | enumeration | awstats |
|
| annotation |
| documentation | Webserver statistics processor |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Custom Error Documents |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | @-domains support |
|
| diagram |
 |
| type |
domainLogin |
| properties |
|
| facets |
| whiteSpace | collapse | | pattern | [a-z]{1}[\-a-z0-9_.]{0,16} |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
| documentation | Hard Disk Quota, MB |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | FrontPage support enabled |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | FrontPage over SSL support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Authorization enabled? |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 16 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Login |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
restriction of string |
| properties |
| isRef | 0 | | content | simple | | default | /bin/false |
|
| facets |
| maxLength | 255 | | whiteSpace | collapse |
|
| annotation |
| documentation | system shell |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | PHP support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | SSI support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | CGI support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | mod_perl support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | mod_python support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Apache ASP support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | ASP dot net support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Coldfusion support |
|
| diagram |
 |
| type |
webstatType |
| properties |
|
| facets |
| whiteSpace | collapse | | enumeration | none | | enumeration | webalizer | | enumeration | awstats |
|
| annotation |
| documentation | Webserver statistics processor |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Custom Error Documents |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | @-domains support |
|
| diagram |
 |
| type |
domainLogin |
| properties |
|
| facets |
| whiteSpace | collapse | | pattern | [a-z]{1}[\-a-z0-9_.]{0,16} |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 64 | | whiteSpace | collapse |
|
| annotation |
| documentation | Password should not be equal to Login. Can be used only for 'set'/'add' operations since v.1.3.2 protocol |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
| documentation | Hard Disk Quota, MB |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | FrontPage support enabled |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | FrontPage over SSL support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Authorization enabled? |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 16 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Login |
|
| diagram |
 |
| type |
restriction of string |
| properties |
|
| facets |
| maxLength | 20 | | whiteSpace | collapse |
|
| annotation |
| documentation | FrontPage Admin Password |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| diagram |
 |
| type |
restriction of string |
| properties |
| isRef | 0 | | content | simple | | default | /bin/false |
|
| facets |
| maxLength | 255 | | whiteSpace | collapse |
|
| annotation |
| documentation | system shell |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | PHP support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | SSI support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | CGI support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | mod_perl support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | mod_python support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Apache ASP support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | ASP dot net support |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Coldfusion support |
|
| diagram |
 |
| type |
webstatType |
| properties |
|
| facets |
| whiteSpace | collapse | | enumeration | none | | enumeration | webalizer | | enumeration | awstats |
|
| annotation |
| documentation | Webserver statistics processor |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | Custom Error Documents |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | @-domains support |
|
| diagram |
 |
| children |
www stat_ttl |
| used by |
|
| annotation |
| documentation | Domain Preferences |
|
| diagram |
 |
| type |
boolean |
| properties |
|
| facets |
|
| annotation |
| documentation | WWW-prefix for a domain |
|
| diagram |
 |
| type |
int |
| properties |
|
| facets |
|
| annotation |
| documentation | Delete traffic statistics older than,(the amount of time), max 999999 |
|
| diagram |
 |
| children |
dest_url |
| used by |
|
| annotation |
| documentation | Domain Frame Forwarding Hosting |
|
| diagram |
 |
| type |
forwardingURL |
| properties |
|
| facets |
| minLength | 1 | | maxLength | 255 | | whiteSpace | collapse |
|
| annotation |
| documentation | Destination URL |
|
| diagram |
 |
| type |
size |
| properties |
|
| facets |
|