Event Parameters Passed by Event Handlers¶
This section describes the parameters that can be used with handlers that you set up for specific Plesk events.
Additional administrator account created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | NEW_LOGIN_NAME |
Required |
| Contact name | NEW_CONTACT_NAME |
Required |
NEW_EMAIL |
||
| Status | NEW_STATUS |
Additional administrator account deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | OLD_LOGIN_NAME |
Required |
| Contact name | OLD_CONTACT_NAME |
Required |
Additional administrator account updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
OLD_EMAIL |
NEW_EMAIL |
||
| Status | OLD_STATUS |
NEW_STATUS |
Additional FTP account created¶
Note
This event is relevant only for additional FTP accounts - the ones that are created after the subscription creation in addition to the main FTP account. If you want to track the creation of the main FTP account - the one that is created simultaneously with a subscription, you should use the Hosting settings created event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| Home directory | NEW_HOME_DIRECTORY |
Required |
| System user name | NEW_SYSTEM_USER |
|
| System user password | NEW_SYSTEM_USER_PASSWORD |
Additional FTP account deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Home directory | OLD_HOME_DIRECTORY |
Required |
| System user name | OLD_SYSTEM_USER |
|
| System user password | OLD_SYSTEM_USER_PASSWORD |
Additional FTP account updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Home directory | OLD_HOME_DIRECTORY |
NEW_HOME_DIRECTORY |
Required |
| System user name | OLD_SYSTEM_USER |
NEW_SYSTEM_USER |
Required |
| System user password | OLD_SYSTEM_USER_PASSWORD |
NEW_SYSTEM_USER_PASSWORD |
Additional license expired¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| License key number | OLD_LICENSE |
Required |
| License name | OLD_LICENSE_NAME |
Required |
Administrator information updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
| Company name | OLD_COMPANY_NAME |
NEW_COMPANY_NAME |
|
| Phone number | OLD_PHONE |
NEW_PHONE |
|
| Fax | OLD_FAX |
NEW_FAX |
|
OLD_EMAIL |
NEW_EMAIL |
||
| Address | OLD_ADDRESS |
NEW_ADDRESS |
|
| City | OLD_CITY |
NEW_CITY |
|
| State/Province | OLD_STATE_PROVINCE |
NEW_STATE_PROVINCE |
|
| Postal/Zip code | OLD_POSTAL_ZIP_CODE |
NEW_POSTAL_ZIP_CODE |
|
| Country | OLD_COUNTRY |
NEW_COUNTRY |
Administrator’s interface preferences updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Ability to log in to the account from multiple computers (or browsers) at once. | OLD_MULTIPLE_SESSIONS |
NEW_MULTIPLE_SESSIONS |
|
| Interface language | OLD_LOCALE |
NEW_LOCALE |
Customer account created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | NEW_LOGIN_NAME |
Required |
| Password | NEW_PASSWORD |
|
| Contact name | NEW_CONTACT_NAME |
Required |
| Company name | NEW_COMPANY_NAME |
|
| Phone | NEW_PHONE |
|
| Fax | NEW_FAX |
|
NEW_EMAIL |
||
| Address | NEW_ADDRESS |
|
| City | NEW_CITY |
|
| State/province | NEW_STATE_PROVINCE |
|
| Postal/zip code | NEW_POSTAL_ZIP_CODE |
|
| Country | NEW_COUNTRY |
Customer account deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | OLD_LOGIN_NAME |
Required |
Customer account updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Password | OLD_PASSWORD |
NEW_PASSWORD |
|
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
| Company name | OLD_COMPANY_NAME |
NEW_COMPANY_NAME |
|
| Phone | OLD_PHONE |
NEW_PHONE |
|
| Fax | OLD_FAX |
NEW_FAX |
|
OLD_EMAIL |
NEW_EMAIL |
||
| Address | OLD_ADDRESS |
NEW_ADDRESS |
|
| City | OLD_CITY |
NEW_CITY |
|
| State/province | OLD_STATE_PROVINCE |
NEW_STATE_PROVINCE |
|
| Postal/zip code | OLD_POSTAL_ZIP_CODE |
NEW_POSTAL_ZIP_CODE |
|
| Country | OLD_COUNTRY |
NEW_COUNTRY |
Customer account status updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Status | OLD_STATUS |
NEW_STATUS |
Customer GUID updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| User account type | OLD_CLIENT_TYPE |
NEW_CLIENT_TYPE |
|
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| GUID | OLD_GUID |
NEW_GUID |
Customer’s interface preferences updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Page size | OLD_LINES_PER_PAGE |
NEW_LINES_PER_PAGE |
|
| Interface skin | OLD_INTERFACE_SKIN |
NEW_INTERFACE_SKIN |
Database created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Database server’s ID | NEW_DATABASE_SERVER |
Required |
| Database name | NEW_DATABASE_NAME |
Required |
| Database server’s host name | NEW_DATABASE_SERVER_HOST |
Required |
| Database server’s port | NEW_DATABASE_SERVER_PORT |
Required |
| Database server’s type (mysql, mssql, postgresql) | NEW_DATABASE_SERVER_TYPE |
Required |
| Domain ID | NEW_DOMAIN_ID |
Required |
| Database ID | NEW_DATABASE_ID |
Required |
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
Database deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Database server’s ID | OLD_DATABASE_SERVER |
Required |
| Database name | OLD_DATABASE_NAME |
Required |
| Database server’s host name | OLD_DATABASE_SERVER_HOST |
Required |
| Database server’s port | OLD_DATABASE_SERVER_PORT |
Required |
| Domain ID | OLD_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Database disk quota events (Windows only)¶
Events:
- MySQL database quota reached
- MySQL database soft quota reached
- Microsoft SQL Server database quota reached
- Microsoft SQL Server database soft quota reached
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Subscription’s domain name | OLD_DOMAIN_NAME |
|
| Subscription’s GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
|
| The total amount of disk space that can be used by MySQL databases on a subscription | OLD_MYSQL_DATABASE_QUOTA |
Only for MySQL events |
| Disk space currently used by MySQL databases on a subscription | OLD_MYSQL_DATABASE_USAGE |
Only for MySQL events |
| The total amount of disk space that can be used by Microsoft SQL Server databases on a subscription | OLD_MICROSOFT_SQL_DATABASE_QUOTA |
Only for MS SQL Server events |
| Disk space currently used by Microsoft SQL Server databases on a subscription | OLD_MICROSOFT_SQL_DATABASE_USAGE |
Only for MS SQL Server events |
The soft limit can be changed in the panel.ini file by specifying the option databaseManagement.diskSpaceSoftQuota. The value is percentage of the limit (default is 85%). For example:
[databaseManagement]
diskSpaceSoftQuota=50
Example of event handler:
C:\temp\mssql_soft.bat <NEW_DOMAIN_NAME> <NEW_DOMAIN_GUID> <NEW_CLIENT_GUID> <NEW_MICROSOFT_SQL_DATABASE_QUOTA> <NEW_MICROSOFT_SQL_DATABASE_USAGE> <OLD_DOMAIN_NAME> <OLD_DOMAIN_GUID> <OLD_CLIENT_GUID>
echo "--------------" >> c:\temp\mssql_soft_handler.log
date /T >> c:\temp\mssql_soft_handler.log
echo "NEW_DOMAIN_NAME: %1" >> c:\temp\mssql_soft_handler.log
echo "NEW_DOMAIN_GUID: %2" >> c:\temp\mssql_soft_handler.log
echo "NEW_CLIENT_GUID: %3" >> c:\temp\mssql_soft_handler.log
echo "NEW_MICROSOFT_SQL_DATABASE_QUOTA: %4" >> c:\temp\mssql_soft_handler.log
echo "NEW_MICROSOFT_SQL_DATABASE_USAGE: %5" >> c:\temp\mssql_soft_handler.log
echo "OLD_DOMAIN_NAME: %6" >> c:\temp\mssql_soft_handler.log
echo "OLD_DOMAIN_GUID: %7" >> c:\temp\mssql_soft_handler.log
echo "OLD_CLIENT_GUID: %8" >> c:\temp\mssql_soft_handler.log
echo "--------------" >> c:\temp\mssql_soft_handler.log
Database server created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Database server’s ID | NEW_DATABASE_SERVER |
Required |
| Database server’s host name | NEW_DATABASE_SERVER_HOST |
Required |
| Database server’s port | NEW_DATABASE_SERVER_PORT |
Required |
Database server deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Database server’s ID | OLD_DATABASE_SERVER |
Required |
| Database server’s host name | OLD_DATABASE_SERVER_HOST |
Required |
| Database server’s port | OLD_DATABASE_SERVER_PORT |
Required |
Database server updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Database server’s ID | OLD_DATABASE_SERVER |
NEW_DATABASE_SERVER |
Required |
| Database server’s host name | OLD_DATABASE_SERVER_HOST |
NEW_DATABASE_SERVER_HOST |
Required |
| Database server’s port | OLD_DATABASE_SERVER_PORT |
NEW_DATABASE_SERVER_PORT |
Required |
Database user account created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Database server’s ID | NEW_DATABASE_SERVER |
Required |
| Database server’s host name | NEW_DATABASE_SERVER_HOST |
Required |
| Database server’s port | NEW_DATABASE_SERVER_PORT |
Required |
| Database identification number | NEW_DATABASE_ID |
Required |
| Database user name | NEW_DATABASE_USER_NAME |
Required |
| Database user password | NEW_DATABASE_USER_PASSWORD |
|
| Domain ID | NEW_DOMAIN_ID |
|
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
Database user account removed¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Database server’s ID | OLD_DATABASE_SERVER |
Required |
| Database server’s host name | OLD_DATABASE_SERVER_HOST |
Required |
| Database server’s port | OLD_DATABASE_SERVER_PORT |
Required |
| Database identification number | OLD_DATABASE_ID |
Required |
| Database user name | OLD_DATABASE_USER_NAME |
Required |
| Domain name | OLD_DOMAIN_NAME |
|
| Domain ID | OLD_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Database user account settings updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Database server’s ID | OLD_DATABASE_SERVER |
NEW_DATABASE_SERVER |
Required |
| Database server’s host name | OLD_DATABASE_SERVER_HOST |
NEW_DATABASE_SERVER_HOST |
Required |
| Database server’s port | OLD_DATABASE_SERVER_PORT |
NEW_DATABASE_SERVER_PORT |
Required |
| Database identification number | OLD_DATABASE_ID |
NEW_DATABASE_ID |
Required |
| Database user name | OLD_DATABASE_USER_NAME |
NEW_DATABASE_USER_NAME |
Required |
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
Default domain (the first domain added to a subscription) created¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain created” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
|
| IPv4 address | NEW_IP_ADDRESS |
|
| IPv6 address | NEW_IPV6_ADDRESS |
Default domain (the first domain added to a subscription) deleted¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain deleted” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Default domain (the first domain added to a subscription) updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
Default domain, DNS zone of a domain alias updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “DNS zone of a domain alias updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain alias name | OLD_DOMAIN_ALIAS_NAME |
NEW_DOMAIN_ALIAS_NAME |
Required |
Default domain, DNS zone updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain DNS zone updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
Default domain, GUID updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain GUID updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Globally unique identifier (GUID) | OLD_GUID |
NEW_GUID |
Required |
Default domain, alias created¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain alias created” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain alias name | NEW_DOMAIN_ALIAS_NAME |
Required |
| Domain name | NEW_DOMAIN_NAME |
|
| Domain ID | NEW_DOMAIN_ID |
|
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
|
| Synchronization of DNS zone with a primary domain | NEW_DOMAIN_ALIAS_DNS |
|
| Domain alias switched on or off | NEW_STATUS |
|
| Web service for domain alias is on or off | NEW_DOMAIN_ALIAS_WEB |
|
| Mail service for domain alias is on or off | NEW_DOMAIN_ALIAS_MAIL |
Default domain, alias deleted¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain alias deleted” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain alias name | OLD_DOMAIN_ALIAS_NAME |
Required |
| Domain ID | OLD_DOMAIN_ID |
|
| Domain name | OLD_DOMAIN_NAME |
|
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Default domain, alias updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to “Domain alias updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain alias name | OLD_DOMAIN_ALIAS_NAME |
NEW_DOMAIN_ALIAS_NAME |
Required |
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
|
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
|
| Synchronization of DNS zone with a primary domain | OLD_DNS |
NEW_DNS |
|
| Domain alias switched on or off | OLD_STATUS |
NEW_STATUS |
|
| Web service for domain alias is on or off | OLD_DOMAIN_ALIAS_WEB |
NEW_DOMAIN_ALIAS_WEB |
|
| Mail service for domain alias is on or off | OLD_DOMAIN_ALIAS_MAIL |
NEW_DOMAIN_ALIAS_MAIL |
Default domain, status updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Domain status updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Website’s domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Website status | OLD_STATUS |
NEW_STATUS |
|
| Detailed website status | OLD_DOMAIN_EXTENDED_STATUS |
NEW_DOMAIN_EXTENDED_STATUS |
Disk space limit for reseller account reached¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Contact name | OLD_CONTACT_NAME |
Required |
| Disk space limit | OLD_MAXIMUM_DISK_SPACE |
Disk space limit for subscription reached¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Subscription’s domain name | OLD_DOMAIN_NAME |
Required |
| Disk space limit | OLD_MAXIMUM_DISK_SPACE |
Disk space usage for subscription updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Subscription’s domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Disk space limit | OLD_USAGE_DISK_SPACE |
NEW_USAGE_DISK_SPACE |
Required |
DNS zone of a domain alias updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, DNS zone of a domain alias updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain alias name | OLD_DOMAIN_ALIAS_NAME |
NEW_DOMAIN_ALIAS_NAME |
Required |
DNS zone of a subdomain under the default domain was updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “DNS zone of a subdomain updated” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| Subdomain name | NEW_SUBDOMAIN_NAME |
DNS zone of a subdomain updated¶
Subdomain means subdomain of any add-on domain created under the subscription. For subdomain of the first (default) domain created under the subscription, refer to the “DNS zone of a subdomain under the default domain was updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Subdomain name | NEW_SUBDOMAIN_NAME |
Domain alias created¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, alias created” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain alias name | NEW_DOMAIN_ALIAS_NAME |
Required |
| Domain name | NEW_DOMAIN_NAME |
|
| Domain ID | NEW_DOMAIN_ID |
|
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
|
| Synchronization of DNS zone with a primary domain | NEW_DOMAIN_ALIAS_DNS |
|
| Domain alias switched on or off | NEW_STATUS |
|
| Web service for domain alias is on or off | NEW_DOMAIN_ALIAS_WEB |
|
| Mail service for domain alias is on or off | NEW_DOMAIN_ALIAS_MAIL |
Domain alias deleted¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, alias deleted” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain alias name | OLD_DOMAIN_ALIAS_NAME |
Required |
| Domain ID | OLD_DOMAIN_ID |
|
| Domain name | OLD_DOMAIN_NAME |
|
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
|
| Customer’s username | OLD_LOGIN_NAME |
Domain alias updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, alias updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain alias name | OLD_DOMAIN_ALIAS_NAME |
NEW_DOMAIN_ALIAS_NAME |
Required |
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
|
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
|
| Synchronization of DNS zone with a primary domain | OLD_DOMAIN_ALIAS_DNS |
NEW_DOMAIN_ALIAS_DNS |
|
| Domain alias switched on or off | OLD_STATUS |
NEW_STATUS |
|
| Web service for domain alias is on or off | OLD_DOMAIN_ALIAS_WEB |
NEW_DOMAIN_ALIAS_WEB |
|
| Mail service for domain alias is on or off | OLD_DOMAIN_ALIAS_MAIL |
NEW_DOMAIN_ALIAS_MAIL |
Domain created¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain (the first domain added to a subscription) created” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
Domain deleted¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain (the first domain added to a subscription) deleted” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s username | OLD_LOGIN_NAME |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Domain updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain (the first domain added to a subscription) updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
Domain DNS zone updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, DNS zone updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
Domain GUID updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, GUID updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Globally unique identifier (GUID) | OLD_GUID |
NEW_GUID |
Required |
Domain status updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Default domain, status updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Website’s domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Website status | OLD_STATUS |
NEW_STATUS |
|
| Detailed website status | OLD_DOMAIN_EXTENDED_STATUS |
NEW_DOMAIN_EXTENDED_STATUS |
Extension installed¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Extension name | NEW_EXTENSION_NAME |
Required |
| Extension ID | NEW_EXTENSION_ID |
Required |
| Extension release | NEW_EXTENSION_RELEASE |
|
| Extension version | NEW_EXTENSION_VERSION |
Extension status updated¶
| Parameter name and description | Environment variable | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Extension name | OLD_EXTENSION_NAME |
NEW_EXTENSION_NAME |
Required |
| Extension ID | OLD_EXTENSION_ID |
NEW_EXTENSION_ID |
Required |
| Extension release | OLD_EXTENSION_RELEASE |
NEW_EXTENSION_RELEASE |
|
| Extension version | OLD_EXTENSION_VERSION |
NEW_EXTENSION_VERSION |
|
| Extension status | OLD_STATUS |
NEW_STATUS |
Required |
Extension uninstalled¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Extension name | OLD_EXTENSION_NAME |
Required |
| Extension ID | OLD_EXTENSION_ID |
Required |
| Extension release | OLD_EXTENSION_RELEASE |
|
| Extension version | OLD_EXTENSION_VERSION |
Extension upgraded¶
| Parameter name and description | Environment variable | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Extension name | OLD_EXTENSION_NAME |
NEW_EXTENSION_NAME |
Required |
| Extension ID | OLD_EXTENSION_ID |
NEW_EXTENSION_ID |
Required |
| Extension release | OLD_EXTENSION_RELEASE |
NEW_EXTENSION_RELEASE |
Required |
| Extension version | OLD_EXTENSION_VERSION |
NEW_EXTENSION_VERSION |
Required |
IP address created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| IP address | NEW_IP_ADDRESS |
Required |
| IP mask | NEW_IP_MASK |
|
| Interface | NEW_INTERFACE |
|
| IP type (shared or dedicated) | NEW_IP_TYPE |
IP address deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| IP address | OLD_IP_ADDRESS |
Required |
IP address updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| IP address | OLD_IP_ADDRESS |
NEW_IP_ADDRESS |
Required |
| IP mask | OLD_IP_MASK |
NEW_IP_MASK |
|
| Interface | OLD_INTERFACE |
NEW_INTERFACE |
|
| IP type (shared or dedicated) | OLD_IP_TYPE |
NEW_IP_TYPE |
License key expired¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| License key number | OLD_LICENSE |
Required |
License key updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| License key number | OLD_LICENSE |
NEW_LICENSE |
Required |
| License key type (Plesk, additional) | OLD_LICENSE_TYPE |
NEW_LICENSE_TYPE |
|
| License key name (for additional keys) | OLD_LICENSE_NAME |
NEW_LICENSE_NAME |
Mail account created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Email address | NEW_MAILNAME |
Required (in the format address@example.com) |
Mail account deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Email address | OLD_MAILNAME |
Required (in the format address@example.com) |
Mail account updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Email address | OLD_MAILNAME |
NEW_MAILNAME |
Required (in the format address@example.com) |
| Mailbox | OLD_MAILBOX |
NEW_MAILBOX |
|
| Password | OLD_PASSWORD |
NEW_PASSWORD |
|
| Mailbox quota | OLD_MAILBOX_QUOTA |
NEW_MAILBOX_QUOTA |
|
| Autoresponders | OLD_AUTORESPONDERS |
NEW_AUTORESPONDERS |
Mailing list created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| Mailing list email address | NEW_MAILLIST_NAME |
Required |
| The status of mailing list (on or off) | NEW_MAILLIST_STATUS |
Mailing list deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Mailing list email address | OLD_MAILLIST_NAME |
Required |
| The status of the mailing list (on or off) | OLD_MAILLIST_STATUS |
Mailing list updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Mailing list email address | OLD_MAILLIST_NAME |
NEW_MAILLIST_NAME |
Required |
Physical hosting created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| IPv4 address | NEW_IP_ADDRESS |
|
| IPv6 address | NEW_IPV6_ADDRESS |
|
| IP type | NEW_IP_TYPE |
|
| System user’s username | NEW_SYSTEM_USER |
|
| System user’s password | NEW_SYSTEM_USER_PASSWORD |
|
| Access to the server over SSH (on Linux systems) or Remote Desktop (on Windows systems) | NEW_SYSTEM_SHELL |
|
| SSI support | NEW_SSI_SUPPORT |
|
| PHP support | NEW_PHP_SUPPORT |
|
| CGI support | NEW_CGI_SUPPORT |
|
| ASP support | NEW_ASP_SUPPORT |
Only on Windows systems |
| SSL/TLS support | NEW_SSL_SUPPORT |
|
| Web statistics program | NEW_WEB_STATISTICS |
|
| Custom error documents | NEW_CUSTOM_ERROR_DOCUMENTS |
|
| Hard quota on disk space | NEW_HARD_DISK_QUOTA |
Physical hosting deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Domain ID | OLD_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Physical hosting updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
|
| IPv4 address | OLD_IP_ADDRESS |
NEW_IP_ADDRESS |
|
| IPv6 address | OLD_IPV6_ADDRESS |
NEW_IPV6_ADDRESS |
|
| IP type | OLD_IP_TYPE |
NEW_IP_TYPE |
|
| System user | OLD_SYSTEM_USER |
NEW_SYSTEM_USER |
|
| System user’s password | OLD_SYSTEM_USER_PASSWORD |
NEW_SYSTEM_USER_PASSWORD |
|
| Access to the server over SSH (on Linux systems) or Remote Desktop (on Windows systems) | OLD_SYSTEM_SHELL |
NEW_SYSTEM_SHELL |
|
| SSI support | OLD_SSI_SUPPORT |
NEW_SSI_SUPPORT |
|
| PHP support | OLD_PHP_SUPPORT |
NEW_PHP_SUPPORT |
|
| CGI support | OLD_CGI_SUPPORT |
NEW_CGI_SUPPORT |
|
| ASP support | OLD_ASP_SUPPORT |
NEW_ASP_SUPPORT |
Only on Windows systems |
| SSL/TLS support | OLD_SSL_SUPPORT |
NEW_SSL_SUPPORT |
|
| Web statistics | OLD_WEB_STATISTICS |
NEW_WEB_STATISTICS |
|
| Custom error documents | OLD_CUSTOM_ERROR_DOCUMENTS |
NEW_CUSTOM_ERROR_DOCUMENTS |
|
| Hard disk quota | OLD_HARD_DISK_QUOTA |
NEW_HARD_DISK_QUOTA |
Plesk component updated or added¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Plesk component name | OLD_PLESK_COMPONENT_NAME |
NEW_PLESK_COMPONENT_NAME |
Required |
Plesk user failed to log in¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | OLD_LOGIN_NAME |
Plesk user failed to log in through the API¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | OLD_LOGIN_NAME |
Plesk user logged in¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Contact name | NEW_CONTACT_NAME |
Plesk user logged out¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Contact name | OLD_CONTACT_NAME |
Reseller account created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | NEW_LOGIN_NAME |
Required |
| Contact name | NEW_CONTACT_NAME |
Required |
| Password | NEW_PASSWORD |
|
| Company name | NEW_COMPANY_NAME |
|
| Phone | NEW_PHONE |
|
| Fax | NEW_FAX |
|
NEW_EMAIL |
||
| Address | NEW_ADDRESS |
|
| City | NEW_CITY |
|
| State/province | NEW_STATE_PROVINCE |
|
| Postal/zip code | NEW_POSTAL_ZIP_CODE |
|
| Country | NEW_COUNTRY |
Reseller account deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Username | OLD_LOGIN_NAME |
Required |
Reseller account updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
|
| Password | OLD_PASSWORD |
NEW_PASSWORD |
|
| Company name | OLD_COMPANY_NAME |
NEW_COMPANY_NAME |
|
| Phone | OLD_PHONE |
NEW_PHONE |
|
| Fax | OLD_FAX |
NEW_FAX |
|
| E- mail | OLD_EMAIL |
NEW_EMAIL |
|
| Address | OLD_ADDRESS |
NEW_ADDRESS |
|
| City | OLD_CITY |
NEW_CITY |
|
| State/province | OLD_STATE_PROVINCE |
NEW_STATE_PROVINCE |
|
| Postal/zip code | OLD_POSTAL_ZIP_CODE |
NEW_POSTAL_ZIP_CODE |
|
| Country | OLD_COUNTRY |
NEW_COUNTRY |
Reseller account limits updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
|
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Maximum number of domains | OLD_MAXIMUM_DOMAINS |
NEW_MAXIMUM_DOMAINS |
|
| Maximum amount of disk space | OLD_MAXIMUM_DISK_SPACE |
NEW_MAXIMUM_DISK_SPACE |
|
| Maximum amount of traffic | OLD_MAXIMUM_TRAFFIC |
NEW_MAXIMUM_TRAFFIC |
|
| Maximum number of Web users | OLD_MAXIMUM_WEBUSERS |
NEW_MAXIMUM_WEBUSERS |
|
| Maximum number of databases | OLD_MAXIMUM_DATABASES |
NEW_MAXIMUM_DATABASES |
|
| Maximum number of mailboxes | OLD_MAXIMUM_MAILBOXES |
NEW_MAXIMUM_MAILBOXES |
|
| Mailbox quota | OLD_MAXIMUM_MAILBOX_QUOTA |
NEW_MAXIMUM_MAILBOX_QUOTA |
|
| Maximum number of mailing lists | OLD_MAXIMUM_MAIL_LISTS |
NEW_MAXIMUM_MAIL_LISTS |
|
| Account expiration date | OLD_EXPIRATION_DATE |
NEW_EXPIRATION_DATE |
Reseller account permissions updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Type of user account | OLD_CLIENT_TYPE |
NEW_CLIENT_TYPE |
|
| DNS zone management | OLD_PERM_MANAGE_DNS |
NEW_PERM_MANAGE_DNS |
|
| Hosting settings management | OLD_PERM_MANAGE_PHOSTING |
NEW_PERM_MANAGE_PHOSTING |
|
| Common PHP settings management | OLD_PERM_MANAGE_PHP_SETTINGS |
NEW_PERM_MANAGE_PHP_SETTINGS |
|
| Ability to set up potentially insecure hosting options | OLD_PERM_ALLOW_INSECURE_SITES |
NEW_PERM_ALLOW_INSECURE_SITES |
|
| Anonymous FTP management | OLD_PERM_MANAGE_ANONFTP |
NEW_PERM_MANAGE_ANONFTP |
|
| Scheduler management | OLD_PERM_MANAGE_CRONTAB |
NEW_PERM_MANAGE_CRONTAB |
|
| Spam filter management | OLD_PERM_MANAGE_SPAMFILTER |
NEW_PERM_MANAGE_SPAMFILTER |
|
| Antivirus management | OLD_PERM_MANAGE_VIRUSFILTER |
NEW_PERM_MANAGE_VIRUSFILTER |
|
| Data backup and restoration using the server storage | OLD_PERM_ALLOW_LOCAL_BACKUPS |
NEW_PERM_ALLOW_LOCAL_BACKUPS |
|
| Data backup and restoration using an FTP storage | OLD_PERM_ALLOW_FTP_BACKUPS |
NEW_PERM_ALLOW_FTP_BACKUPS |
|
| Web statistics management | OLD_PERM_MANAGE_WEBSTAT |
NEW_PERM_MANAGE_WEBSTAT |
|
| Log rotation management | OLD_PERM_MANAGE_LOG |
NEW_PERM_MANAGE_LOG |
|
| Ability to use remote API | OLD_PERM_REMOTE_ACCESS_INTERFACE |
NEW_PERM_REMOTE_ACCESS_INTERFACE |
|
| Access to Application Catalog | OLD_PERM_ACCESS_APPCATALOG |
NEW_PERM_ACCESS_APPCATALOG |
|
| Access to WP Toolkit | OLD_PERM_MANAGE_WORDPRESS_TOOLKIT |
NEW_PERM_MANAGE_WORDPRESS_TOOLKIT |
|
| WP Toolkit security management | OLD_PERM_MANAGE_SECURITY_WORDPRESS_TOOLKIT |
NEW_PERM_MANAGE_SECURITY_WORDPRESS_TOOLKIT |
|
| Management of access to the server over SSH | OLD_PERM_MANAGE_SH_ACCESS |
NEW_PERM_MANAGE_SH_ACCESS |
|
| Subscription creation in Server Administration Panel and domain creation in Customer Panel. | OLD_PERM_CREATE_DOMAINS |
NEW_PERM_CREATE_DOMAINS |
|
| Subdomains management | OLD_PERM_MANAGE_SUBDOMAINS |
NEW_PERM_MANAGE_SUBDOMAINS |
|
| Domain aliases management | OLD_PERM_DOMAIN_ALIASES |
NEW_PERM_DOMAIN_ALIASES |
|
| Additional FTP accounts management | OLD_PERM_MANAGE_SUBFTP |
NEW_PERM_MANAGE_SUBFTP |
|
| Java applications management | OLD_PERM_MANAGE_WEBAPPS |
NEW_PERM_MANAGE_WEBAPPS |
|
| Ability to change mail settings | OLD_PERM_MANAGE_MAIL_SETTINGS |
NEW_PERM_MANAGE_MAIL_SETTINGS |
|
| Mailing lists management | OLD_PERM_MANAGE_MAILLISTS |
NEW_PERM_MANAGE_MAILLISTS |
|
| Hosting performance settings management | OLD_PERM_MANAGE_PERFORMANCE |
NEW_PERM_MANAGE_PERFORMANCE |
|
| Hard disk quota assignment | OLD_PERM_MANAGE_QUOTA |
NEW_PERM_MANAGE_QUOTA |
|
| Database server selection | OLD_PERM_SELECT_DB_SERVER |
NEW_PERM_SELECT_DB_SERVER |
|
| Remote access for database users | OLD_PERM_REMOTE_DB_CONNECTION |
NEW_PERM_REMOTE_DB_CONNECTION |
|
| Customer account creation | OLD_PERM_CREATE_CLIENTS |
NEW_PERM_CREATE_CLIENTS |
|
| Allow overselling | OLD_PERM_OVERSELL_MANAGEMENT |
NEW_PERM_OVERSELL_MANAGEMENT |
|
| Access to advanced operations: website copying, maintenance, and staging | OLD_PERM_MANAGE_WEBSITE_MAINTENANCE |
NEW_PERM_MANAGE_WEBSITE_MAINTENANCE |
|
| Password-protected directories management | OLD_PERM_MANAGE_PROTECTED_DIRS |
NEW_PERM_MANAGE_PROTECTED_DIRS |
|
| Ability to manage additional user accounts | OLD_PERM_ACCESS_SERVICE_USERS |
NEW_PERM_ACCESS_SERVICE_USERS |
|
| Additional write/modify permissions management | OLD_PERM_MANAGE_ADDITIONAL_PERMISSIONS |
NEW_PERM_MANAGE_ADDITIONAL_PERMISSIONS |
Only on Windows |
| IIS application pool management | OLD_PERM_MANAGE_IIS_APP_POOL |
NEW_PERM_MANAGE_IIS_APP_POOL |
Only on Windows |
Reseller account status updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Status | OLD_STATUS |
NEW_STATUS |
Reseller GUID updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| User account type | OLD_CLIENT_TYPE |
NEW_CLIENT_TYPE |
|
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| GUID | OLD_GUID |
NEW_GUID |
Reseller plan created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Reseller plan ID | NEW_TEMPLATE_ID |
Required |
Reseller plan deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Reseller plan ID | OLD_TEMPLATE_ID |
Required |
Reseller plan updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Reseller plan ID | OLD_TEMPLATE_ID |
NEW_TEMPLATE_ID |
Required |
Reseller’s interface preferences updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Contact name | OLD_CONTACT_NAME |
NEW_CONTACT_NAME |
Required |
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| Ability to log in to the account from multiple computers (or browsers) at once. | OLD_ALLOW_MULTIPLE_SESSIONS |
NEW_ALLOW_MULTIPLE_SESSIONS |
|
| Interface language | OLD_INTERFACE_LANGUAGE |
NEW_INTERFACE_LANGUAGE |
|
| Interface skin | OLD_INTERFACE_SKIN |
NEW_INTERFACE_SKIN |
Reseller’s IP pool updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Required |
| IP address | OLD_IP_ADDRESS |
NEW_IP_ADDRESS |
Required |
| Status | OLD_STATUS |
NEW_STATUS |
SSL/TLS certificate on Plesk assigned/unassigned¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| SSL binding type | OLD_SSL_BINDING_TYPE |
NEW_SSL_BINDING_TYPE |
Required |
| SSL/TLS certificate ID | OLD_CERTIFICATE_ID |
NEW_CERTIFICATE_ID |
Required |
| SSL/TLS certificate name | OLD_CERTIFICATE_NAME |
NEW_CERTIFICATE_NAME |
Required |
| SSL/TLS certificate file | OLD_CERTIFICATE_FILE |
NEW_SSL_CERTIFICATE_FILE |
Required |
SSL/TLS certificate on domain assigned/unassigned¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| SSL binding type | OLD_SSL_CERTIFICATE_BINDING_TYPE |
NEW_SSL_CERTIFICATE_BINDING_TYPE |
Required |
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
Required |
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
Required |
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| SSL/TLS certificate ID | OLD_SSL_CERTIFICATE_ID |
NEW_SSL_CERTIFICATE_ID |
Required |
| SSL/TLS certificate name | OLD_SSL_CERTIFICATE_NAME |
NEW_SSL_CERTIFICATE_NAME |
Required |
| SSL/TLS certificate file | OLD_SSL_CERTIFICATE_FILE |
NEW_SSL_CERTIFICATE_FILE |
Required |
| Domain owner GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
Required |
SSL/TLS certificate on mail server assigned/unassigned¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| SSL binding type | OLD_SSL_BINDING_TYPE |
NEW_SSL_BINDING_TYPE |
Required |
| SSL/TLS certificate ID | OLD_CERTIFICATE_ID |
NEW_CERTIFICATE_ID |
Required |
| SSL/TLS certificate name | OLD_CERTIFICATE_NAME |
NEW_CERTIFICATE_NAME |
Required |
| SSL/TLS certificate file | OLD_CERTIFICATE_FILE |
NEW_SSL_CERTIFICATE_FILE |
Required |
SSL/TLS certificate on webmail assigned/unassigned¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| SSL binding type | OLD_SSL_BINDING_TYPE |
NEW_SSL_BINDING_TYPE |
Required |
| Domain GUID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
Required |
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| SSL/TLS certificate ID | OLD_CERTIFICATE_ID |
NEW_CERTIFICATE_ID |
Required |
| SSL/TLS certificate name | OLD_CERTIFICATE_NAME |
NEW_CERTIFICATE_NAME |
Required |
| SSL/TLS certificate file | OLD_CERTIFICATE_FILE |
NEW_SSL_CERTIFICATE_FILE |
Required |
Server health status changed¶
| Parameter name and description | Environment variable | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Health monitor parameter (the same value for new and old) | OLD_HEALTH_PARAMETER |
NEW_HEALTH_PARAMETER |
Required |
| Parameter status | OLD_STATUS |
NEW_STATUS |
Required |
Service plan of administrator created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Plan ID | NEW_ADMIN_TEMPLATE |
Required |
Service plan of administrator deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Plan ID | OLD_ADMIN_TEMPLATE |
Required |
Service plan of administrator updated¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Plan ID | OLD_ADMIN_TEMPLATE |
Required |
Service plan of reseller created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Plan ID | NEW_DOMAIN_TEMPLATE |
Required |
Service plan of reseller deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Plan ID | OLD_DOMAIN_TEMPLATE |
Required |
Service plan of reseller updated¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Plan ID | OLD_DOMAIN_TEMPLATE |
Required |
Service plan of subscription changed¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Plan ID | OLD_DOMAIN_TEMPLATE |
NEW_DOMAIN_TEMPLATE |
Required |
Service restarted¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Service name | OLD_SERVICE |
NEW_SERVICE |
Required |
Service started¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Service name | OLD_SERVICE |
NEW_SERVICE |
Required |
Service stopped¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Service name | OLD_SERVICE |
NEW_SERVICE |
Required |
Session settings updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Allowed period of inactivity for all Plesk users | OLD_SESSION_IDLE_TIME |
NEW_SESSION_IDLE_TIME |
Standard or frame forwarding hosting created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| IPv4 address | NEW_IP_ADDRESS |
|
| IPv6 address | NEW_IPV6_ADDRESS |
|
| Forwarding type | NEW_FORWARDING_TYPE |
|
| URL | NEW_URL |
Standard or frame forwarding hosting deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Forwarding type | OLD_FORWARDING_TYPE |
Standard or frame forwarding hosting updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| IPv4 address | OLD_IP_ADDRESS |
NEW_IP_ADDRESS |
|
| IPv6 address | OLD_IPV6_ADDRESS |
NEW_IPV6_ADDRESS |
|
| Forwarding type | OLD_FORWARDING_TYPE |
NEW_FORWARDING_TYPE |
|
| URL | OLD_URL |
NEW_URL |
Subdomain created¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Subdomain of a default domain created” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Subdomain name | NEW_SUBDOMAIN_NAME |
Required |
| Parent domain name | NEW_DOMAIN_NAME |
Required |
| Parent domain ID | NEW_DOMAIN_ID |
|
| Parent domain GUID | NEW_DOMAIN_GUID |
Subdomain deleted¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Subdomain of a default domain deleted” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Subdomain name | OLD_SUBDOMAIN_NAME |
Required |
| Subdomain owner’s GUID | OLD_CLIENT_GUID |
|
| Subdomain owner’s username | OLD_LOGIN_NAME |
Subdomain updated¶
Domain means any add-on domain created under the subscription. For the first (default) domain created under the subscription, refer to the “Subdomain of a default domain updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Subdomain name | OLD_SUBDOMAIN_NAME |
NEW_SUBDOMAIN_NAME |
Required |
| Parent domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Parent domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Parent domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
Subdomain of a default domain created¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Subdomain created” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Subdomain name | NEW_SUBDOMAIN_NAME |
Required |
| Parent domain name | NEW_DOMAIN_NAME |
Required |
| Parent domain ID | NEW_DOMAIN_ID |
|
| Parent domain GUID | NEW_DOMAIN_GUID |
|
| FTP account login | NEW_SYSTEM_USER_TYPE |
|
| Subdomain owner’s login name | NEW_SYSTEM_USER |
|
| Subdomain owner’s GUID | NEW_CLIENT_GUID |
|
| Hard disk quota | NEW_HARD_DISK_QUOTA |
|
| SSI support | NEW_SSI_SUPPORT |
|
| PHP support | NEW_PHP_SUPPORT |
|
| CGI support | NEW_CGI_SUPPORT |
|
| ASP support | NEW_ASP_SUPPORT |
Only on Windows platforms. |
| Hard quota on disk space | NEW_HARD_DISK_QUOTA |
|
| FastCGI support | NEW_MOD_FASTCGI_SUPPORT |
|
| SSL/TLS support | NEW_SSL_SUPPORT |
Subdomain of a default domain deleted¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Subdomain deleted” event.
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Parent domain name | OLD_DOMAIN_NAME |
Required |
| Parent domain ID | OLD_DOMAIN_ID |
|
| Parent domain GUID | OLD_DOMAIN_GUID |
|
| Subdomain owner’s GUID | OLD_CLIENT_GUID |
|
| Subdomain name | OLD_SUBDOMAIN_NAME |
Required |
Subdomain of a default domain updated¶
Default domain means the first domain created under the subscription. For other (add-on) domains created under the subscription, refer to the “Subdomain updated” event.
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Subdomain name | OLD_SUBDOMAIN_NAME |
NEW_SUBDOMAIN_NAME |
Required |
| Parent domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Parent domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Parent domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| FTP account login | OLD_SYSTEM_USER_TYPE |
NEW_SYSTEM_USER_TYPE |
|
| Subdomain owner’s username | OLD_SYSTEM_USER |
NEW_SYSTEM_USER |
|
| Subdomain owner’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
|
| Hard disk quota | OLD_HARD_DISK_QUOTA |
NEW_HARD_DISK_QUOTA |
|
| SSI support | OLD_SSI_SUPPORT |
NEW_SSI_SUPPORT |
|
| PHP support | OLD_PHP_SUPPORT |
NEW_PHP_SUPPORT |
|
| CGI support | OLD_CGI_SUPPORT |
NEW_CGI_SUPPORT |
|
| ASP support | OLD_ASP_SUPPORT |
NEW_ASP_SUPPORT |
Only on Windows platforms. |
| Hard quota on disk space | OLD_HARD_DISK_QUOTA |
NEW_HARD_DISK_QUOTA |
|
| FastCGI support | OLD_MOD_FASTCGI_SUPPORT |
NEW_MOD_FASTCGI_SUPPORT |
|
| SSL/TLS support | OLD_SSL_SUPPORT |
NEW_SSL_SUPPORT |
Subscription limits updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Maximum amount of disk space | OLD_MAXIMUM_DISK_SPACE |
NEW_MAXIMUM_DISK_SPACE |
|
| Maximum amount of traffic | OLD_MAXIMUM_TRAFFIC |
NEW_MAXIMUM_TRAFFIC |
|
| Maximum number of web users | OLD_MAXIMUM_WEBUSERS |
NEW_MAXIMUM_WEBUSERS |
|
| Maximum number of databases | OLD_MAXIMUM_DATABASES |
NEW_MAXIMUM_DATABASES |
|
| Maximum number of mailboxes | OLD_MAXIMUM_MAILBOXES |
NEW_MAXIMUM_MAILBOXES |
|
| Mailbox quota | OLD_MAXIMUM_MAILBOX_QUOTA |
NEW_MAXIMUM_MAILBOX_QUOTA |
|
| Maximum number of mailing lists | OLD_MAXIMUM_MAIL_LISTS |
NEW_MAXIMUM_MAIL_LISTS |
|
| Expiration date | OLD_EXPIRATION_DATE |
NEW_EXPIRATION_DATE |
Subscription owner changed¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Subscription’s domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
|
| Owner’s username | OLD_LOGIN_NAME |
NEW_LOGIN_NAME |
Traffic limit for reseller account reached¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Contact name | OLD_CONTACT_NAME |
Required |
| Traffic usage limit | OLD_MAXIMUM_TRAFFIC |
Traffic limit for subscription reached¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Subscription’s domain name | OLD_DOMAIN_NAME |
Required |
| Traffic usage limit | OLD_MAXIMUM_TRAFFIC |
Update available¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Update version | NEW_PATCH_VERSION |
Update installed¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Update version | NEW_PATCH_VERSION |
Web application installed¶
| Parameter name and description | Environment variable | Notes |
|---|---|---|
| Application name | NEW_PACKAGE_NAME |
Required |
| Domain or subdomain | NEW_DOMAIN_TYPE |
Required |
| URL relative to the domain/subdomain, by which the application is accessible on the Web | NEW_INSTALLATION_PREFIX |
Required |
| Domain name | NEW_DOMAIN_NAME |
|
| Domain ID | NEW_DOMAIN_ID |
|
| Domain GUID | NEW_DOMAIN_GUID |
|
| Customer’s GUID | NEW_CLIENT_GUID |
Web application reconfigured¶
| Parameter name and description | Environment variable | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Application name | OLD_PACKAGE_NAME |
NEW_PACKAGE_NAME |
Required |
| Domain or subdomain | OLD_DOMAIN_TYPE |
NEW_DOMAIN_TYPE |
Required |
| URL relative to the domain/subdomain, by which the application is accessible on the Web | OLD_INSTALLATION_PREFIX |
NEW_INSTALLATION_PREFIX |
Required |
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
|
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
Web application uninstalled¶
| Parameter name and description | Environment variable | Notes |
|---|---|---|
| Application name | OLD_PACKAGE_NAME |
Required |
| Domain or subdomain | OLD_DOMAIN_TYPE |
Required |
| URL relative to the domain/subdomain, by which the application is accessible on the Web | OLD_INSTALLATION_PREFIX |
Required |
| Domain name | OLD_DOMAIN_NAME |
|
| Domain ID | OLD_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
Web application upgraded¶
| Parameter name and description | Environment variable | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Application name | OLD_PACKAGE_NAME |
NEW_PACKAGE_NAME |
Required |
| Domain or subdomain | OLD_DOMAIN_TYPE |
NEW_DOMAIN_TYPE |
Required |
| URL relative to the domain/subdomain, by which the application is accessible on the Web | OLD_INSTALLATION_PREFIXE |
NEW_INSTALLATION_PREFIX |
Required |
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
|
| Domain ID | OLD_DOMAIN_ID |
NEW_DOMAIN_ID |
|
| Domain GUID | OLD_DOMAIN_GUID |
NEW_DOMAIN_GUID |
|
| Customer’s GUID | OLD_CLIENT_GUID |
NEW_CLIENT_GUID |
Web user account created¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | NEW_DOMAIN_NAME |
Required |
| Web user name | NEW_WEBUSER_NAME |
Required |
| SSI support | NEW_SSI_SUPPORT |
|
| PHP support | NEW_PHP_SUPPORT |
|
| CGI support | NEW_CGI_SUPPORT |
|
| ASP support | NEW_ASP_SUPPORT |
Only on Windows systems |
| Hard disk quota | NEW_HARD_DISK_QUOTA |
Web user account deleted¶
| Parameter name and description | Environment variable name | Notes |
|---|---|---|
| Domain name | OLD_DOMAIN_NAME |
Required |
| Web user name | OLD_WEBUSER_NAME |
Required |
Web user account updated¶
| Parameter name and description | Environment variable name | Notes | |
|---|---|---|---|
| Previously used value | New value | ||
| Domain name | OLD_DOMAIN_NAME |
NEW_DOMAIN_NAME |
Required |
| Web user name | OLD_WEBUSER_NAME |
NEW_WEBUSER_NAME |
Required |
| SSI support | OLD_SSI_SUPPORT |
NEW_SSI_SUPPORT |
|
| PHP support | OLD_PHP_SUPPORT |
NEW_PHP_SUPPORT |
|
| CGI support | OLD_CGI_SUPPORT |
NEW_CGI_SUPPORT |
|
| ASP support | OLD_ASP_SUPPORT |
NEW_ASP_SUPPORT |
Only on Windows systems |
| Hard disk quota | OLD_HARD_DISK_QUOTA |
NEW_HARD_DISK_QUOTA |
WordPress installed¶
| Parameter name and description | Environment variable | Notes |
|---|---|---|
| Client GUID | NEW_CLIENT_GUID |
Required |
| Domain GUID | NEW_DOMAIN_GUID |
Required |
| Domain Name | NEW_DOMAIN_NAME |
Required |
| Site Name | NEW_SITE_NAME |
Required |
| Installation Path | NEW_INSTALLATION_PATH |
Required |
| Version | NEW_VERSION |
Required |
| Main Domain ID | NEW_MAIN_DOMAIN_ID |
Required |
WordPress registered¶
| Parameter name and description | Environment variable | Notes |
|---|---|---|
| Client GUID | NEW_CLIENT_GUID |
Required |
| Domain GUID | NEW_DOMAIN_GUID |
Required |
| Domain Name | NEW_DOMAIN_NAME |
Required |
| Site Name | NEW_SITE_NAME |
Required |
| Installation Path | NEW_INSTALLATION_PATH |
Required |
| APS Instance ID | NEW_APS_INSTANCE_ID |
Required |
| Main Domain ID | NEW_MAIN_DOMAIN_ID |
Required |
WordPress uninstalled¶
| Parameter name and description | Environment variable | Notes |
|---|---|---|
| Client GUID | OLD_CLIENT_GUID |
Required |
| Domain GUID | OLD_DOMAIN_GUID |
Required |
| Domain Name | OLD_DOMAIN_NAME |
Required |
| Site Name | OLD_SITE_NAME |
Required |
| Installation Path | OLD_INSTALLATION_PATH |
Required |
| Version | OLD_VERSION |
Required |
| Main Domain ID | OLD_MAIN_DOMAIN_ID |
Required |