Subdomain Properties

Subdomain Properties

Subdomain hosting properties are specified by complex type SubdomainPropertyType (subdomain.xsd). It is structured as follows:

SubdomainPropertyType

  • The name node is required. It specifies a subdomain property name. Data type: string.
  • The value node is required. It specifies a subdomain property value. Data type: anySimple.

The List of Subdomain Properties

The list below contains subdomain properties you can set with the property parameter. Note that allowed values for properties may vary depending on the server's operating system and the list of installed components. For example, you can assign to the php_version property only those PHP versions that are installed on your server.

To get the exact list of parameters and their possible values available on your system for a particular subdomain, retrieve a hosting settings descriptor using the site/get-physical-hosting-descriptor operation with a filter by the subdomain's id. To learn more, see Getting Descriptors of Hosting Settings.

Property name Possible Values Description

ssl

true | false

Turns on the SSL support for a subdomain.

php_handler_id

module|cgi|fastcgi (Linux)

 

cgi-5|cgi-5.3|cgi-5.4|fastcgi-5|fastcgi-5.3|fastcgi-5.4|isapi-5 (Windows)

Specifies PHP handler type for a subdomain.

ssi_html

true | false

Turns on the support for SSI in *.htm and *.html files.

Works on Windows only.

managed_runtime_version

May vary depending on installed components.

Specifies the ASP.NET version for a subdomain.

Works on Windows only.

www_root

string

Specifies the root directory for a subdomain.

Note: When you change the root directory of an existing subdomain, Plesk creates a new directory based on the Plesk's virtual host template. The previous root directory is kept as it is.

asp

true | false

Turns on the ASP support for a subdomain.

asp_dot_net

true | false

Turns on the ASP.NET support for a subdomain.

Works on Windows only.

ssi

true | false

Turns on the SSI support for a subdomain.

php

true | false

Turns on the PHP support for a subdomain.

cgi

true | false

Turns on the CGI support for a subdomain.

perl

true | false

Turns on the Perl support for a subdomain.

python

true | false

Turns on the Python support for a subdomain.

fastcgi

true | false

Turns on the FastCGI support for a subdomain (required for Ruby on Rails).

Works on Linux only.

miva

true | false

Turns on the Miva support for a subdomain.

webstat

none | webalizer | awstats

Specifies a statistics engine that will create reports on how a subdomain is visited.

errdocs

true | false

Allows subscribers to design and use their own error pages that the web server returns with HTTP error codes.

write_modify

true | false

This option is required if subscriber's web apps use a file-based database (like Jet) located in the root directory of a subdomain. Note that selecting this option might seriously compromise site security.

Works on Windows only.

web_deploy

true | false

Allows subscribers to publish the content of a website on subdomain through Web Deploy.

webstat_protected

true | false

Specifies whether web statistics reports should be accessible through a specific password-protected directory.

To get current property values for a particular subdomain, retrieve information about the subdomain using the get operator. For details, see Retrieving Information on a Subdomain.