The bootstrapSingleServer Method
Bootstrap a server for standalone usage in production or development environment. This action is designed to give an automated process the option to bootstrap a server with particular settings.
Note that once a server has been bootstrapped, it may not be added passively into a cluster using clusterAddServer. It may still join a cluster using a direct WebAPI -serverAddToCluster, or a UI call. This WebAPI action is explicitly accessible without a WebAPI Key, but only during the bootstrap stage.
Unlike the UI bootstrap/launching process, this bootstrap action does not restart Zend Server nor perform any authentication. A WebAPI key with administrative permissions is created as part of the bootstrap process so that you may immediately continue working. It is up to the user to decide what to do with this key once the bootstrap is completed.
Read a certain number of log lines from the end of the file log. If serverId is passed, then the request will be performed against that cluster member, otherwise it is performed locally.
Note:
The bootstrap process may not complete in time for the response’s creation, in this case “success” will be false.
Version: 1.3
Required Permissions: Bootstrap
HTTP method: POST
Supported by Editions: All
Request Parameters:
|
Parameter
|
Type
|
Required
|
Description
|
|
production
|
Boolean
|
No
|
Bootstrap this server using the factory “production” usage profile. Default value: true. If joining a cluster, a special “cluster” value will be stored.
|
|
adminPassword
|
String
|
Yes
|
The new administrator password to store for authentication
|
|
applicationUrl
|
String
|
No
|
The default application URL to use when displaying and handling deployed application URLs in the UI. Default: empty
|
|
adminEmail
|
String
|
No
|
The default Email to use when sending notifications about events, audit entries and other features
|
|
developerPassword
|
String
|
No
|
The new developer user password to be stored for authentication. If no password is supplied, the developer user will not be created
|
|
orderNumber
|
String
|
No
|
License order number to store in the server’s configuration. This license can be obtained from zend.com
|
|
licenseKey
|
String
|
No
|
License key to store in the server’s configuration. This license can be obtained from zend.com
|
|
acceptEula
|
Boolean
|
Yes
|
Must be set to true to accept ZS6’s EULA
|
Expected Response Code: 200 OK.
Response Type: Bootstrap
Possible Action Specific Error Codes:
|
HTTP Code
|
Error Code
|
Description
|
|
406
|
alreadyBootstrapped
|
Returned if the server is already bootstrapped and bootstrap operation may not be executed.
|
Example
|
|
Request POST /ZendServer/Api/bootstrapSingleServer adminPassword=1234&orderNumber=Zend&licenseKey=MU126G100....21A8453915
Response <?xml version="1.0" encoding="UTF-8"?> <zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3"> <requestData> <apiKeyName>angel.eyes</apiKeyName> <method>bootstrapSingleServer</method> </requestData> <responseData> <bootstrap> <success>true</success> <apiKey> <id>5</id> <username>admin</username> <name><![CDATA[MyKey]]></name> <hash><![CDATA[f2a1854a0641...e9b84f38ae49ef]]></hash> <creationTime>...</creationTime> </apiKey> </bootstrap> </responseData> </zendServerAPIResponse>
|
Support