Open topic with navigation

Zend Server WebAPI

The Zend Server WebAPI allows external systems to connect to a programmatic, restful API that allows access to all of Zend Server’s management features. Using the WebAPI, 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 WebAPI. Almost every functionality in the UI is executed via sthe WebAPI.

How does it work?

The WebAPI 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 WebAPI it will be parsed into either in XML or JSON, and returned to the requesting entity.

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 | Monitor Methods | Monitoring Rules Methods | Notification Center Methods | Server and Cluster Management Methods | Statistics Methods | Studio-Integration Methods

Versions

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

*Current version

Note:

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

DN: ZS-WAPI-030112-5.6-01

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