The vhostEdit Web API Method
Edit an existing vhost. Receives vhostId and template and returns a single virtual host element with the same information.
Version: 1.6
Required Permissions: Read-only
HTTP method: POST
Supported by Editions: Zend Server
Request Parameters:
Parameter |
Type |
Required |
Description |
vhostId |
Integer |
Yes |
virtual host ID. |
template |
String |
Yes |
New vhost template of virtual host settings. |
forceCreate |
Boolean |
No |
Force edit of the virtual host template even if any errors are detected. |
sslCertificatePath |
String |
No |
File path to locate the SSL certificate file |
sslCertificateKeyPath |
String |
No |
File path to locate the SSL key file |
sslCertificateChainPath |
String |
No |
File path to locate the SSL chain file |
sslAppName |
String |
No |
Application name for SSL (IBMI only) |
Expected Response Code: 200 OK - For more information see Response Format.
Response Type: vhost
Possible Action Specific Error Codes:
HTTP Code |
Error Code |
Description |
404 |
noSuchVhost |
Required virtual host ID was not found. |
406 |
serverConfigurationError |
The template provided as virtual host configuration has failed syntax or staging checks. A detailed message will appear to explain the failure. |
Example
|
Request
Response
|