The Zend Server Web API allows external systems to connect to a programmatic, restful API that allows access to all of Zend Server’s management features. Using the Web API, a 3rd party system can automate cluster management, application deployment, and other development and integration tasks.
The Zend Server UI is both an example and a test case for the use of the Zend Server Web API. Almost every functionality in the UI is executed via the Web API.
The Web API is a restful gateway that relies on a signature-based authentication solution for identity control. Seated behind the authentication mechanism is also a detailed permissions system that handles access control and allows you to limit access to your Zend Server.
After a response is generated by the Web API it will be parsed into either in XML or JSON, and returned to the requesting entity.
To better understand how to use Web API, watch this video:
This reference guide includes the following sections:
Web API |
Zend Server |
1.0 |
5.1 |
1.1 |
5.5 |
1.2 |
5.6 |
1.3 |
6.0 |
1.4 |
6.0.1 |
1.5 |
6.1.0 |
1.6 |
6.2.0 |
1.7 |
6.3.0 |
1.8 |
7.0.0 |
1.9 |
8.0.0* |
*Current version
Note:
For a versioning of available Web API methods, see Available API Methods. Please note that support of methods depends on the Zend Server edition you are using.