Zend Server Web API

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.

How does it work?

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.

Contents

This reference guide includes the following sections:

Web API Message Formats	Request Format Response Format
Web API Versioning
Web API Key Signing	Generating API Keys Signing API Requests
Web API Data Types	Request Data Types Response Data Types
Web API Methods	Administration Methods Audit Methods Cache Methods Codetracing Methods Configuration Management Methods Deployment Methods Filter Methods Job Queue Methods Library Methods Monitor Methods Event Rules Methods Notification Center Methods Server and Cluster Management Methods Statistics Methods Studio-Integration Methods Page Cache Methods Plugin Management Methods URL Insight Methods Virtual Hosts Methods Z-Ray Methods

Versions

The following table lists the various versions of the Zend Server Web API and their corresponding product version.

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
1.10	8.5.0
1.11	8.5.2
1.12	9.0
1.14	9.1
1.15	2018.0
1.16	2019.0
1.16	2019.1
1.16	2021.0
1.16	2021.1
1.16	2021.2
1.16	2021.3*

*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.