Reference Guide

Request Format
About
Web API Reference Guide
The request format defines the required format for each request sent to Zend Server. The request format
for all Zend Server Web API requests are formatted as described in this page, regardless of the specific
method used.
Request Method, URL, and Headers
Web API HTTP requests use HTTP GET for read-only API calls, and HTTP POST for all state changing
API calls.
The request URL is different for each action, and is in one of the following formats:
Zend Server - Where is the action to perform (e.g. “disableServer”):
http://example.com:10081/ZendServer/Api/
Zend Server Cluster Manager - Where is the action to perform (e.g. “disableServer”):
http://example.com:10081/ZendServerManager/Api/
All HTTP requests must include the following HTTP headers:
Date - Contains the current date and time in the GMT time zone, in the format specified by the
HTTP RFC for date fields (e.g. “Wed, 07 Jul 2010 17:10:55 GMT”). This value is used to verify
the authenticity of the request, and is expected to be in sync with the server time (within 30
seconds).
User-agent - The user agent string is logged by the server and used for message authenticity
verification. It cannot be empty.
Host - The HTTP host header is expected to be present and is used for message authenticity
verification.
X-Zend-Signature - The API key name and calculated request signature which is used to
authenticate and validate the request. See Authentication and Message Verification for additional
information on calculating the signature.
In addition, you should send the Accept HTTP request header to designate your supported API
version(s). If the Accept header is missing, the server will fall back to the default API version. This is
described in detail in API Versioning Negotiation.
For POST requests, including any parameters or payload, clients must set the Content-type header to
either "application/x-www-form-urlencoded" or "multipart/form-data", depending on the payload. You must
329