What's New in This Version

This chapter contains summaries of changes made to the XML API protocol (version 1.6.8.0).

Each feature-dependant table consists of the following columns:

  • Option - defines whether an operator/operation/parameter is added ("+"), modified ("*"), or deprecated ("-").
  • Operator - contains the name of the operator affected by the feature.
  • Operations - contains the names of the operations affected by the feature.
  • Parameter - contains the affected parameter.
  • Comment - contains a short description of a change.
Added Features

Nginx-only website hosting (Plesk for Linux).

  Operator Operations Parameters Comments

+

service-plan

set, get

web-server-settings -> nginx-proxy-mode

Turns on/off the proxy mode for the nginx reverse proxy server.

+

site

set, get

values -> hosting -> vrt_hst -> property -> nginx-proxy-mode

Turns on/off the proxy mode for the nginx reverse proxy server.

System resource usage limits (Plesk for Linux).

  Operator Operations Parameters Comments

+

service-plan

get-limit-descriptor

property -> name

New limits were added:

  • cgroups_cpu_usage (In percent)
  • cgroups_cpu_usage_soft (In percent)
  • cgroups_cpu_period (In seconds. Allowed values: 300, 3600, 86400)
  • cgroups_disk_read_usage (In bytes per second. Cannot be less that 1MB)
  • cgroups_disk_read_usage_soft (In bytes per seconds. Cannot be less that 1MB)
  • cgroups_disk_read_period (In seconds. Allowed values: 300, 3600, 86400)
  • cgroups_disk_write_usage (In bytes per second. Cannot be less that 1MB)
  • cgroups_disk_write_usage_soft (In bytes per seconds. Cannot be less that 1MB)
  • cgroups_disk_write_period (In seconds. Allowed values: 300, 3600, 86400)
  • cgroups_ram_usage (In bytes. Cannot be less that 1MB)
  • cgroups_ram_usage_soft (In bytes. Cannot be less that 1MB)
  • cgroups_ram_period (In seconds. Allowed values: 300, 3600, 86400)

 

+

webspace

get-limit-descriptor

property -> name

Securing Plesk and mail server

  Operator Operations Parameters Comments

+

server

set, get

certificate -> panel

certificate ->mail-server

Specifies the SSL/TLS certificate for securing Plesk or mail-server

Securing webmail

  Operator Operations Parameters Comments

+

mail

set_prefs, get_prefs

webmail-certificate

Specifies the SSL/TLS certificate for securing webmail on a domain

Managing Plesk extensions

  Operator Operations Parameters Comments

+

 

extension

 

install

url

Installs an extension from the specified URL

call

XML API operator of a particular extension

Calls XML API operator for an extension

Note: This operator is used instead of the former install-module operation of the server operator.

Managing Git repositories

  Operator Operations Parameters Comments

+

git

 

get

domain

Retrieves the list of repositories on a specified domain or on all domains

create

domain, name, optional parameters

Creates a Git repository

update

domain, name, optional parameters

Updates settings of a Git repository

remove

domain, name

Removes a repository

deploy

domain, name

Deploys changes to a Git repository

fetch

domain, name

Fetches the changes from a remote repository to a Git repository

Managing Node.js versions

  Operator Operations Parameters Comments

+

nodejs

 

versions

 

Retrieves the list of Node.js versions available on the server

enable

version, domain

Enables Node.js

disable

version, domain

Disables Node.js

set-version

version, domain

Sets a particular Node.js version on a domain.

get-version

 

domain

 

Retrieves the Node.js version on a domain

 

 

Setting empty document root for a domain, subdomain, or subscription.

  Operator Operations Parameters Comments

+

webspace

add, set

 

hosting/vrt_hosting/property

(name=empty-document-root)

 

Set an empty document root (if the value=true)

 

+

site

+

subdomain

 

property

(name=empty-document-root)

Setting redirect to HTTPS for a domain, service plan, or addon service plan.

  Operator Operations Parameters Comments

+

site

add, set

 

hosting/vrt_hst/property

(name=ssl-redirect)

 

Setting redirect to HTTPS (if the value=true)

 

+

service-plan

+

service-plan-addon

Getting information about the administrator's locale and sessions.

  Operator Operations Parameters Comments

+

server

get

admin/admin_locale

Getting the administrator's locale.

+

server

get

admin/admin_multiple_sessions

Getting information if the administrator has multiple sessions in Plesk.

Getting information about application filter and available applications for a subscription.

  Operator Operations Parameters Comments

+

webspace

get

aps-filter

Getting the information if the application filter is switched on.

+

webspace

get

packages

Getting the list of available applications if the application filter is switched on.

Modified features
  Operator Operations Parameters Comments

*

server

get

site-isolation-config

Now it is possible to get multiple PHP handlers types in this parameter.

Removed features

Coldfusion support

  Operator Operations Parameters Comments

-

service-plan

add

hosting/property (name=coldfusion)

The hosting parameter does not contain coldfusion property any more.

Integration with Parallels Operations Automation (POA)

  Operator Operations Parameters Comments

-

server

set-poa-connection

 

Setting connection with POA. This operation is not supported any more.

 

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.