The install operation is used to install an SSL certificate to the server certificate repository or to a specified webspace repository. Please note that this operation only installs a certificate to a repository, it does not enable SSL support for sites, therefore, it does not make sites available via the HTTPS protocol.
Request Packet Structure
A request XML packet installing an SSL certificate includes the install operation node:
The install node does not have a separate data type, it is nested within type CertificateActionRequest (
certificate_input.xsd). The install node has the following graphical representation:
Specifies the name under which the certificate will be known in the repository and in Plesk. Data type: string.
Either the webspace or admin elements are required.
Specifies the webspace to which the certificate is installed. Data type: string.
Specifies that the certificate is installed to the server repository. Data type: none.
Contains all data constituting the certificate. Data type: none.
Specifies the certificate CSR (certificate signing request). Data type: string.
Specifies the certificate private key. Data type: string.
Contains the certificate body. Data type: string.
Contains the certificate authority body. Data type: string.
Specifies IP address to which the certificate will be assigned when it is installed to server repository. This assignment means that sites hosted on this IP address, in case SSL support is enabled for them, will display this certificate when accessing the sites. Data type: ip_type (
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
Response Packet Structure
The install node of the output XML packet is structured as follows:
Wraps the response retrieved from the server.
Specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
errcode, required if the operation fails
Returns the error code. Data type: unsignedInt.
errtext, required if the operation fails
Returns the error message . Data type: string.
This packet installs to the server repository a CA certificate that will be known in Plesk under the name common and will be assigned to IP address 192.0.2.14 upon the installation.
Installing several certificates
This packet installs two certificates to repositories of webspaces example.com and sample.net.