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.

Video

To better understand how to use Web API, watch this video:

Contents

This reference guide includes the following sections:

• Generic Request/Response Format
• Request Format | Response Format
• API Versioning Negotiation
• Authentication and Message Verification
• Generating API Keys | Signing API Requests
• Data Types
• Request Data Types | Response Data Types
• Available API Methods
• Administration Methods | Audit Methods | Cache Methods | Codetracing Methods | Configuration Management Methods | Deployment Methods | Filter Methods | Job Queue Methods | Library Methods | Monitor Methods | Monitoring Rules Methods | Notification Center Methods | Server and Cluster Management Methods | Statistics Methods | Studio-Integration Methods | Page Cache Methods | Virtual Hosts Methods

Versions

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

*Current version

Note:

For a versioning of available Web API methods, see Available API Methods.

Support

	Zend.com
	Knowledge Base
	Support Center
	Zend Forums
	DevZone
	PHP Manual

Previous Versions

	Zend Server 6.2
	Zend Server 6.1
	Zend Server 6.0
	Zend Server 5.6

Version

Zend Server 6.3

Zend Server Online Help 6.3v02

© 1999-2014 Zend Technologies, Ltd. All rights reserved.

Feedback

Got an idea for improving the Online Help? Click here to let us know.

Or - send an email to documentation@zend.com

Open this topic with navigation