The serverStoreLicense Web API Method

Validate and store a Zend Server license key.

Version: 1.3

Required Permissions: Read-only

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter

 Type

Required

Description

licenseName

String

Yes

The license name

licenseValue

String

Yes

The license value

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

Response Type: licenseValidated.

Possible Action Specific Error Codes:

HTTP Code

 Error Code

Description

400

invalidParameter

License validation failed (various causes).

500

clusterNotAllowed

This license cannot be used on a Zend Server which is connected to a cluster.

Example

Usage Example

Request (headers removed for clarity)

POST /ZendServer/Api/serverStoreLicense

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>serverStoreLicense</method>
	</requestData>
	<responseData>	
		<licenseValidated>true</licenseValidated>
		<licenseChange>
			<currentLicense>
				<edition>Enterprise</edition>
				<evaluation>true</evaluation>
			</currentLicense>
			<newLicense>
				<edition>Enterprise</edition>
				<evaluation>false</evaluation>
			</newLicense>
		</licenseChange>
	</responseData>
</zendServerAPIResponse>