You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.

You are here: Web API Reference Guide > Available API Methods > Server and Cluster Management Methods > The getSystemInfo Method

The getSystemInfo Method

Use this method to get information about the system, including the Zend Server edition and version, PHP version, licensing information, etc. This method produces similar output on all Zend Server systems, and is future compatible.

Note:

deploymentVersion will only show the current deployment version for Zend Server versions which support the feature. If your Zend Server version does not support deployment, 0 (zero) will be displayed.

Required Permissions: read

HTTP method: GET

Supported by Editions: All

Request Parameters: This method has no request parameters.

Expected Response Code: 200 OK

Response Type: systemInfo

Possible Action Specific Error Codes: This method has no action-specific error codes.

Usage Example

Example:

Request:

GET /ZendServerManager/Api/getSystemInfo

Response:

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.0">
  <requestData>
    <apiKeyName>angel.eyes</apiKeyName>
    <method>getSystemInfo</method>
  </requestData>

  <responseData>
    <systemInfo>
      <status>OK</status>
      <edition>
        ZendServerClusterManager
      </edition>
      <zendServerVersion>6.0.1</zendServerVersion>
      <supportedApiVersions>
        application/vnd.zend.serverapi+xml;version=1.0,
        application/vnd.zend.serverapi+xml;version=1.1,
        application/vnd.zend.serverapi+xml;version=2.0
      </supportedApiVersions>
      <phpVersion>5.4.1</phpVersion>
      <operatingSystem>Linux</operatingSystem>
      <deploymentVersion>1.0</deploymentVersion>
      <serverLicenseInfo>
        <status>OK</status>
        <orderNumber>ZEND-ORDER-66</orderNumber>
        <validUntil>Sat, 31 Mar 2012 00:00:00 GMT</validUntil>
        <serverLimit>0</serverLimit>
      </serverLicenseInfo>
      <managerLicenseInfo>
        <status>serverLimitExceeded</status>
        <orderNumber>ZEND-ORDER-66</orderNumber>
        <validUntil>Sat, 31 Mar 2012 00:00:00 GMT</validUntil>
        <serverLimit>10</serverLimit>
      </managerLicenseInfo>
    </systemInfo>
  </responseData>

</zendServerAPIResponse>

An example response for the same request sent to a Zend Server Community Edition Machine would be:

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.0">

  <requestData>
    <apiKeyName>angel.eyes</apiKeyName>
    <method>getSystemInfo</method>
  </requestData>

  <responseData>
    <systemInfo>
      <status>OK</status>
      <edition>
        ZendServerClusterCommunityEdition
      </edition>
      <zendServerVersion>6.0.1</zendServerVersion>
      <supportedApiVersions>
        application/vnd.zend.serverapi+xml;version=1.0,
        application/vnd.zend.serverapi+xml;version=1.1,
        application/vnd.zend.serverapi+xml;version=2.0
      </supportedApiVersions>
      <phpVersion>5.4.1</phpVersion>
      <operatingSystem>Linux</operatingSystem>
      <serverLicenseInfo>
        <status>notRequired</status>
        <orderNumber />
        <validUntil />
        <serverLimit>0</serverLimit>
      </serverLicenseInfo>
      <managerLicenseInfo>
        <status>notRequired</status>
        <orderNumber />
        <validUntil />
        <serverLimit>0</serverLimit>
      </managerLicenseInfo>
    </systemInfo>
  </responseData>

</zendServerAPIResponse>

Important Note:

For Zend Server or Zend Server Cluster Manager on Mac or Linux, this action is also available via the command line using CLI Tools. For more information see CLI Tools.


	Related Links: Server and Cluster Management Methods