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.
Administrator information updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Username |
|
|
Required |
Contact name |
|
|
Required |
Company name |
|
|
|
Phone number |
|
|
|
Fax |
|
|
|
|
|
|
|
Address |
|
|
|
CIty |
|
|
|
State/Province |
|
|
|
Postal/Zip code |
|
|
|
Country |
|
|
|
Service stopped
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Service name |
|
|
Required |
Service started
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Service name |
|
|
Required |
Service restarted
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Service name |
|
|
Required |
IP address created
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
IP address |
|
|
Required |
IP mask |
|
|
|
Interface |
|
|
|
IP type (shared or dedicated) |
|
|
|
IP address updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
IP address |
|
|
Required |
IP mask |
|
|
|
Interface |
|
|
|
IP type (shared or dedicated) |
|
|
|
IP address deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
IP address |
|
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 |
|
|
|
Customer account created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Username |
|
Required |
Password |
|
|
Contact name |
|
Required |
Company name |
|
|
Phone |
|
|
Fax |
|
|
|
|
|
Address |
|
|
City |
|
|
State/province |
|
|
Postal/zip code |
|
|
Country |
|
|
Customer account updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Username |
|
|
Required |
Password |
|
|
|
Contact name |
|
|
Required |
Company name |
|
|
|
Phone |
|
|
|
Fax |
|
|
|
|
|
|
|
Address |
|
|
|
City |
|
|
|
State/province |
|
|
|
Postal/zip code |
|
|
|
Country |
|
|
|
Customer account deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Username |
|
Required |
Customer account status updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Contact name |
|
|
Required |
Username |
|
|
Required |
Status |
|
|
|
Customer GUID updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
User account type |
|
|
|
Username |
|
|
Required |
GUID |
|
|
|
Customer's interface preferences updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Contact name |
|
|
Required |
Username |
|
|
Required |
Page size |
|
|
|
Interface skin |
|
|
|
Reseller account created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Username |
|
Required |
Contact name |
|
Required |
Password |
|
|
Company name |
|
|
Phone |
|
|
Fax |
|
|
|
|
|
Address |
|
|
City |
|
|
State/province |
|
|
Postal/zip code |
|
|
Country |
|
|
Reseller account updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Username |
|
|
Required |
Contact name |
|
|
|
Password |
|
|
|
Company name |
|
|
|
Phone |
|
|
|
Fax |
|
|
|
E- mail |
|
|
|
Address |
|
|
|
City |
|
|
|
State/province |
|
|
|
Postal/zip code |
|
|
|
Country |
|
|
|
Reseller account deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Username |
|
Required |
Reseller account status updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Contact name |
|
|
Required |
Username |
|
|
Required |
Status |
|
|
|
Reseller's interface preferences updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Contact name |
|
|
Required |
Username |
|
|
Required |
Ability to log in to the account from multiple computers (or browsers) at once. |
|
|
|
Interface language |
|
|
|
Interface skin |
|
|
|
Reseller's IP pool updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Username |
|
|
Required |
IP address |
|
|
Required |
Status |
|
|
|
Disk space limit for reseller account reached
Parameter name and description | Environment variable name | Notes |
---|---|---|
Contact name |
|
Required |
Disk space limit |
|
|
Traffic limit for reseller account reached
Parameter name and description | Environment variable name | Notes |
---|---|---|
Contact name |
|
Required |
Traffic usage limit |
|
|
Reseller GUID updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
User account type |
|
|
|
Username |
|
|
Required |
GUID |
|
|
|
Disk space limit for subscription reached
Parameter name and description | Environment variable name | Notes |
---|---|---|
Subscription's domain name |
|
Required |
Disk space limit |
|
|
Traffic limit for subscription reached
Parameter name and description | Environment variable name | Notes |
---|---|---|
Subscription's domain name |
|
Required |
Traffic usage limit |
|
|
Default domain (the first domain added to a subscription or webspace) created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Domain GUID |
|
|
Customer's GUID |
|
|
IPv4 address |
|
|
IPv6 address |
|
|
Default domain (the first domain added to a subscription or webspace) updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Domain GUID |
|
|
|
Customer's GUID |
|
|
|
Default domain (the first domain added to a subscription or webspace) deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Domain GUID |
|
|
Customer's GUID |
|
|
Subscription owner changed
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Subscription's domain name |
|
|
|
Owner's username |
|
|
|
Default domain, status updated
This event cannot be tracked for the main site of a subscription. It can only be tracked for additional websites.
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Website's domain name |
|
|
Required |
Website status |
|
|
|
Detailed website status |
|
|
|
Default domain, GUID updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Globally unique identifier (GUID) |
|
|
Required |
Default domain, DNS zone updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Subdomain of a default domain created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Subdomain name |
|
Required |
Parent domain name |
|
Required |
Parent domain ID |
|
|
Parent domain GUID |
|
|
FTP account login |
|
|
Subdomain owner's login name |
|
|
Subdomain owner's GUID |
|
|
Hard disk quota |
|
|
SSI support |
|
|
PHP support |
|
|
CGI support |
|
|
Perl support |
|
|
Python support |
|
|
Apache ASP support |
|
Only on Linux platforms. |
ASP support |
|
Only on Windows platforms. |
Hard quota on disk space |
|
|
Miva scripting support |
|
|
FastCGI support |
|
|
SSL support |
|
|
Subdomain of a default domain updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Subdomain name |
|
|
Required |
Parent domain name |
|
|
Required |
Parent domain ID |
|
|
|
Parent domain GUID |
|
|
|
FTP account login |
|
|
|
Subdomain owner's username |
|
|
|
Subdomain owner's GUID |
|
|
|
Hard disk quota |
|
|
|
SSI support |
|
|
|
PHP support |
|
|
|
CGI support |
|
|
|
Perl support |
|
|
|
Python support |
|
|
|
Apache ASP support |
|
|
Only on Linux platforms. |
ASP support |
|
|
Only on Windows platforms. |
Hard quota on disk space |
|
|
|
Miva scripting support |
|
|
|
FastCGI support |
|
|
|
SSL support |
|
|
|
Subdomain of a default domain deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Parent domain name |
|
Required |
Parent domain ID |
|
|
Parent domain GUID |
|
|
Subdomain owner's GUID |
|
|
Subdomain name |
|
Required |
Default domain, alias created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain alias name |
|
Required |
Domain name |
|
|
Domain ID |
|
|
Domain GUID |
|
|
Customer's GUID |
|
|
Synchronization of DNS zone with a primary domain |
|
|
Domain alias switched on or off |
|
|
Web service for domain alias is on or off |
|
|
Mail service for domain alias is on or off |
|
|
Support for accessing web applications in Java for domain alias visitors (on or off) |
|
|
Default domain, alias updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain alias name |
|
|
Required |
Domain name |
|
|
|
Domain ID |
|
|
|
Domain GUID |
|
|
|
Customer's GUID |
|
|
|
Synchronization of DNS zone with a primary domain |
|
|
|
Domain alias switched on or off |
|
|
|
Web service for domain alias is on or off |
|
|
|
Mail service for domain alias is on or off |
|
|
|
Support for accessing web applications in Java for domain alias visitors (on or off) |
|
|
|
Default domain, alias deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain alias name |
|
Required |
Domain ID |
|
|
Domain name |
|
|
Domain GUID |
|
|
Customer's GUID |
|
|
Default domain, DNS zone of a domain alias updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain alias name |
|
|
Required |
Reseller account limits updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Contact name |
|
|
|
Username |
|
|
Required |
Maximum number of domains |
|
|
|
Maximum amount of disk space |
|
|
|
Maximum amount of traffic |
|
|
|
Maximum number of Web users |
|
|
|
Maximum number of databases |
|
|
|
Maximum number of mailboxes |
|
|
|
Mailbox quota |
|
|
|
Maximum number of mailing lists |
|
|
|
Maximum number of Java applications |
|
|
|
Account expiration date |
|
|
|
Reseller account permissions updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Username |
|
|
Required |
Type of user account |
|
|
|
DNS zone management |
|
|
|
Hosting settings management |
|
|
|
Common PHP settings management |
|
|
|
Ability to set up potentially insecure hosting options |
|
|
|
Anonymous FTP management |
|
|
|
Scheduler management |
|
|
|
Spam filter management |
|
|
|
Antivirus management |
|
|
|
Data backup and restoration using the server storage |
|
|
|
Data backup and restoration using an FTP storage |
|
|
|
Web statistics management |
|
|
|
Log rotation management
|
|
|
|
Ability to use remote API |
|
|
|
Access to Application Catalog |
|
|
|
Access to WordPress Toolkit
|
|
|
|
WordPress Toolkit security management |
|
|
|
Management of access to the server over SSH |
|
|
|
Subscription creation in Server Administration Panel and domain creation in Customer Panel. |
|
|
|
Subdomains management
|
|
|
|
Domain aliases management |
|
|
|
Additional FTP accounts management |
|
|
|
Java applications management |
|
|
|
Ability to change mail settings
|
|
|
|
Mailing lists management |
|
|
|
Hosting performance settings management |
|
|
|
Hard disk quota assignment
|
|
|
|
Database server selection |
|
|
|
Remote access for database users |
|
|
|
Customer account creation |
|
|
|
Allow overselling |
|
|
|
Access to advanced operations: website copying, maintenance, and staging |
|
|
|
Password-protected directories management |
|
|
|
Ability to manage additional user accounts |
|
|
|
Additional write/modify permissions management |
|
|
Only on Windows |
IIS application pool management |
|
|
Only on Windows |
Shared SSL management |
|
|
Only on Windows |
Subscription limits updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Maximum amount of disk space |
|
|
|
Maximum amount of traffic |
|
|
|
Maximum number of web users |
|
|
|
Maximum number of databases |
|
|
|
Maximum number of mailboxes |
|
|
|
Mailbox quota |
|
|
|
Maximum number of mailing lists |
|
|
|
Maximum number of java applications |
|
|
|
Expiration date |
|
|
|
Plesk user logged in
Parameter name and description | Environment variable name | Notes |
---|---|---|
|
||
Contact name |
|
Plesk user logged out
Parameter name and description | Environment variable name | Notes |
---|---|---|
|
||
Contact name |
|
|
Plesk user failed to log in
Parameter name and description | Environment variable name | Notes |
---|---|---|
Username |
|
|
Plesk user failed to log in through the API
Parameter name and description | Environment variable name | Notes |
---|---|---|
Username |
|
|
Mail account created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Email address |
|
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 |
|
|
Required (in the format address@example.com) |
Mailbox |
|
|
|
Password |
|
|
|
Mailbox quota |
|
|
|
Autoresponders |
|
|
|
Mail account deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Email address |
|
Required (in the format address@example.com) |
Mailing list created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Mailing list email address |
|
Required |
The status of mailing list (on or off) |
|
|
Mailing list updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Mailing list email address |
|
|
Required |
Mailing list deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Mailing list email address |
|
Required |
The status of the mailing list (on or off) |
|
|
Physical hosting created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
IPv4 address |
|
|
IPv6 address |
|
|
IP type |
|
|
System user's username |
|
|
System user's password |
|
|
Access to the server over SSH (on Linux systems) or Remote Desktop (on Windows systems) |
|
|
SSI support |
|
|
PHP support |
|
|
CGI support |
|
|
Perl support |
|
|
Apache ASP support |
|
Only on Linux systems |
ASP support |
|
Only on Windows systems |
SSL support |
|
|
Web statistics program |
|
|
Custom error documents |
|
|
Hard quota on disk space |
|
|
Physical hosting updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Domain ID |
|
|
|
Domain GUID |
|
|
|
Customer's GUID |
|
|
|
IPv4 address |
|
|
|
IPv6 address |
|
|
|
IP type |
|
|
|
System user |
|
|
|
System user's password |
|
|
|
Access to the server over SSH (on Linux systems) or Remote Desktop (on Windows systems) |
|
|
|
FP support |
|
|
|
FP- SSL support |
|
|
|
FP authoring |
|
|
|
FP admin login |
|
|
|
FP admin password |
|
|
|
SSI support |
|
|
|
PHP support |
|
|
|
CGI support |
|
|
|
Perl support |
|
|
|
Apache ASP support |
|
|
Only on Linux systems |
ASP support |
|
|
Only on Windows systems |
SSL support |
|
|
|
Web statistics |
|
|
|
Custom error documents |
|
|
|
Hard disk quota |
|
|
|
Physical hosting deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Domain ID |
|
|
Domain GUID |
|
|
Customer's GUID |
|
|
Standard or frame forwarding hosting created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
IPv4 address |
|
|
IPv6 address |
|
|
Forwarding type |
|
|
URL |
|
|
Standard or frame forwarding hosting updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
IPv4 address |
|
|
|
IPv6 address |
|
|
|
Forwarding type |
|
|
|
URL |
|
|
|
Standard or frame forwarding hosting deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Forwarding type |
|
|
Web user account created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Web user name |
|
Required |
SSI support |
|
|
PHP support |
|
|
CGI support |
|
|
Perl support |
|
|
Python support |
|
|
Apache ASP support |
|
Only on Linux systems |
ASP support |
|
Only on Windows systems |
Hard disk quota |
|
|
Web user account updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Domain name |
|
|
Required |
Web user name |
|
|
Required |
SSI support |
|
|
|
PHP support |
|
|
|
CGI support |
|
|
|
Perl support |
|
|
|
Python support |
|
|
|
Apache ASP support |
|
|
Only on Linux systems |
ASP support |
|
|
Only on Windows systems |
Hard disk quota |
|
|
|
Web user account deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Domain name |
|
Required |
Web user name |
|
Required |
Web application installed
Parameter name and description | Environment variable | Notes |
---|---|---|
Application name |
|
Required |
Domain or subdomain |
|
Required |
URL relative to the domain/subdomain, by which the application is accessible on the Web |
|
Required |
Domain name |
|
|
Domain ID |
|
|
Domain GUID |
|
|
Customer's GUID |
|
|
Web application reconfigured
Parameter name and description | Environment variable | Notes | |
---|---|---|---|
Previously used value | New value | ||
Application name |
|
|
Required |
Domain or subdomain |
|
|
Required |
URL relative to the domain/subdomain, by which the application is accessible on the Web |
|
|
Required |
Domain name |
|
|
|
Domain ID |
|
|
|
Domain GUID |
|
|
|
Customer's GUID |
|
|
|
Web application uninstalled
Parameter name and description | Environment variable | Notes |
---|---|---|
Application name |
|
Required |
Domain or subdomain |
|
Required |
URL relative to the domain/subdomain, by which the application is accessible on the Web |
|
Required |
Domain name |
|
|
Domain ID |
|
|
Domain GUID |
|
|
Customer's GUID |
|
|
Web application upgraded
Parameter name and description | Environment variable | Notes | |
---|---|---|---|
Previously used value | New value | ||
Application name |
|
|
Required |
Domain or subdomain |
|
|
Required |
URL relative to the domain/subdomain, by which the application is accessible on the Web |
|
|
Required |
Domain name |
|
|
|
Domain ID |
|
|
|
Domain GUID |
|
|
|
Customer's GUID |
|
|
|
License key updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
License key number |
|
|
Required |
License key type (Plesk, additional) |
|
|
|
License key name (for additional keys) |
|
|
|
License key expired
Parameter name and description | Environment variable name | Notes |
---|---|---|
License key number |
|
Required |
Database server created
Parameter name and description | Environment variable name | Notes |
---|---|---|
Database server's ID |
|
Required |
Database server's host name |
|
Required |
Database server's port |
|
Required |
Database server updated
Parameter name and description | Environment variable name | Notes | |
---|---|---|---|
Previously used value | New value | ||
Database server's ID |
|
|
Required |
Database server's host name |
|
|
Required |
Database server's port |
|
|
Required |
Database server deleted
Parameter name and description | Environment variable name | Notes |
---|---|---|
Database server's ID |
|
Required |
Database server's host name |
|
Required |
Database server's port |
|
Required |