Web API Reference Guide > Available API Methods > Virtual Hosts Methods > The vhostValidateSsl Method

The vhostValidateSsl Method

Validate the existence of the supplied SSL certificate, key and chain provided during creation or edit of a virtual host.

Version: 1.6

Required Permissions: Read-only

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

sslCertificatePath

String

Yes

Full filepath to the ssl certificate file

sslCertificateKeyPath

String

Yes

Full filepath to the ssl key file

sslChainPath

String

No

Full filepath to the chain file

Expected Response Code: 200 OK  - For more information see Response Format.

Response Type: Validation

Success Codes (literal):

Failure: indicates syntax validation was executed and the template failed. A detailed message will be provided in the message field.

Success: syntax validation passed successfully.

Warning: syntax validation could not be executed.

Example

Usage Example

Request

POST /ZendServerManager/Api/vhostValidateSsl

sslCertificatePath=....

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.6">

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>vhostValidateSsl</method>

</requestData>

<responseData>

<validation>

<success>failure</success>

<message><![CDATA[File not found <filename>...]]></message>

<data><![CDATA[filename]]></data>

</validation>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Virtual Hosts Methods