2. $VAR->domain->

2. $VAR->domain->

The content of $VAR->domain is defined by the value of the domainId key in $metainfo.

  • $VAR->domain->id

    Domain ID; string

  • $VAR->domain->www

    Defines if the website is accessible with the www prefix; boolean

  • $VAR->domain->enabled

    Defines the website status; boolean

  • $VAR->domain->idnName

    International domain name; string

  • $VAR->domain->asciiName

    Domain name in ASCII format; string

  • $VAR->domain->isIpDefault

    Defines if the website is set as default for the IP address; boolean

  • $VAR->domain->hasPhysicalHosting

    Defines if the website is set up for web hosting; boolean

  • $VAR->domain->hasStandardForwarding

    Defines if the website is set up as standard forwarding; boolean

  • $VAR->domain->hasFrameForwarding

    Defines if the website is set up as frame forwarding; boolean

  • $VAR->domain->webAliases

    Web aliases of the website; array where elements are objects $object->asciiName

  • $VAR->domain->mailAliases

    Mail aliases of the website; array where elements are objects $object->asciiName

  • $VAR->domain->client->email

    Email address of the website owner; string

  • $VAR->domain->email

    Email address of the Domain Administrator of the website; string

2.1. $VAR->domain->physicalHosting->
  • $VAR->domain->physicalHosting->login

    Username of FTP account used to access the website content; string

  • $VAR->domain->physicalHosting->ipAddress

    IP address on which the website is hosted; see $VAR->ipAddress

  • $VAR->domain->physicalHosting->vhostDir

    The absolute path to the website's vhost directory; string

  • $VAR->domain->physicalHosting->logsDir

    The absolute path to the website's logs directory; string

  • $VAR->domain->physicalHosting->webUsersDir

    The absolute path to the website's directory designated for web users' content; string

  • $VAR->domain->physicalHosting->httpDir

    The absolute path to the website's httpdocs directory; string

  • $VAR->domain->physicalHosting->httpsDir

    The absolute path to the website's httpsdocs directory; string

  • $VAR->domain->physicalHosting->cgiBinDir

    The absolute path to the website's cgi-bin directory; string

  • $VAR->domain->physicalHosting->statisticsDir

    The absolute path to the website's statistics directory;string

  • $VAR->domain->physicalHosting->siteAppsConfigDir

    The absolute path to the website's directory where configuration files of the installed non-SSL/TLS site applications are stored; string

  • $VAR->domain->physicalHosting->customConfigFile

    The absolute path to the directory <vhostdir>/conf/vhost.conf for a non-SSL/TLS website; string

  • $VAR->domain->physicalHosting->siteAppsSslConfigDir

    The absolute path to the website's directory where configuration files of the installed SSL/TLS site applications are stored; string

  • $VAR->domain->physicalHosting->customSslConfigFile

    The absolute path to the directory <vhostdir>/conf/vhost.conf for a non-SSL/TLS website; string

  • $VAR->domain->physicalHosting->ssl

    Defines if the SSL/TLS support is enabled on the website; boolean

  • $VAR->domain->physicalHosting->trafficBandwidth

    Defines a limit imposed on the traffic bandwidth usage by the domain; string

  • $VAR->domain->physicalHosting->maximumConnection

    Defines a limit imposed on the maximum allowed number of connections to the domain; string

  • $VAR->domain->physicalHosting->php

    Defines if the PHP support is enabled on the website; boolean

  • $VAR->domain->physicalHosting->phpHandlerType

    Defines PHP handler type; string

  • $VAR->domain->physicalHosting->phpSafeMode

    Defines if PHP operates in safe mode; boolean

  • $VAR->domain->physicalHosting->ssi

    Defines if SSI is supported on the website; boolean

  • $VAR->domain->physicalHosting->cgi

    Defines if CGI is supported on the website; boolean

  • $VAR->domain->physicalHosting->perl

    Defines if Perl is supported on the website; boolean

  • $VAR->domain->physicalHosting->asp

    Defines if ASP is supported on the website; boolean

  • $VAR->domain->physicalHosting->python

    Defines if python is supported on the website; boolean

  • $VAR->domain->physicalHosting->fastcgi

    Defines if FastCGI is supported on the website; boolean

  • $VAR->domain->physicalHosting->errordocs

    Defines if custom error pages are supported on the website; boolean

  • $VAR->domain->physicalHosting->hasWebstat

    Defines if a web statistics service is supported on the website; boolean

  • $VAR->domain->physicalHosting->webuserScriptingEnabled

    Defines if using scripts is allowed to web users on the website; boolean

  • $VAR->domain->physicalHosting->subdomains

    List of the website subdomains; array with elements $VAR->subdomain

  • $VAR->domain->physicalHosting->phpSettings

    List of PHP settings for the website (including additional directives); string

  • $VAR->domain->physicalHosting->webusers

    Accesses web user specific data; array where elements are objects of type $object-><webuser-parameter> where <webuser-parameter> is one of the following:

    • dir

      The absolute path to the directory with the web user's content; string

    • ssi

      Defines if SSI support is enabled for the web user; boolean

    • cgi

      Defines if CGI support is enabled for the web user; boolean

    • perl

      Defines if perl support is enabled for the web user; boolean

    • asp

      Defines if ASP support is enabled for the web user; boolean

    • php

      Defines if PHP support is enabled for the web user; boolean

    • phpSettings

      List of PHP settings for the web user. All setting values are the same as for the website except open_basedir (it contains the path to the web user's home directory); string

    • python

      Defines if python support is enabled for the web user; boolean

    • fastcgi

      Defines if fastCGI support is enabled for the web user; boolean

2.2. $VAR->domain->forwarding->
  • $VAR->domain->forwarding->ipAddress

    IP address on which the website forwarding is set up; $VAR->ipAddress

  • $VAR->domain->forwarding->redirectUrl

    URL to which requests for the website are redirected; string

2.3. $VAR->domain->tomcat->
  • $VAR->domain->tomcat->enabled

    Defines if Tomcat is enabled on the website; boolean

  • $VAR->domain->tomcat->all

    Gets data on all Tomcat applications running on the domain; array where elements are objects $object->name where 'name' is an application name

2.4. $VAR->domain->protectedDirectories->
  • $VAR->domain->protectedDirectories->sslDirectories

    Password-protected directories of the website available via SSL/TLS; array with elements array('directory' => '', 'realm' => '', 'authFile' => '',) where

    • directory is a path (relative to the virtual host root) to a directory being protected
    • realm is a text displayed when requesting password from a user
    • authFile is the absolute path to a file listing users who are authorized to access the directory
  • $VAR->domain->protectedDirectories->nonSslDirectories

    Password-protected non-SSL/TLS directories of the website; array with elements array('directory' => '', 'realm' => '', 'authFile' => '',) where

    • directory is a path (relative to the virtual host root) to a directory being protected
    • realm is a text displayed when requesting password from a user
    • authFile is the absolute path to a file listing users who are authorized to access the directory