The applicationUpdate Web API Method
This method allows you to update an existing application. The package you provide must contain the same application. Additionally, any new parameters or new values for existing parameters must be provided. This process is asynchronous, meaning the initial request will wait until the package is uploaded and verified, and the initial response will show information about the new version being deployed. However, the staging and activation process will proceed after the response is returned. You must continue checking the application status using the applicationGetStatus method until the deployment process is complete.
Version: 1.2
Required Permissions: Full
HTTP method: POST
Supported by Editions:Zend Server
Request Parameters:
Because this method contains a file upload, parameters must be encoded using the ‘multipart/form-data’ content type.
Parameter |
Type |
Required |
Description |
appId |
Integer |
Yes |
The application ID you would like to update. |
appPackage |
File |
Yes |
The application package file. The content type for the file must be ‘application/vnd.zend.applicationpackage’. |
ignoreFailures |
Boolean |
No |
Ignore failures
during staging if only some servers report failures. If all servers
report failures the operation will fail in any case. |
userParams |
Hashmap |
No |
Set values for
user parameters that are defined in the package. |
Expected Response Code: 202 Accepted - For more information see Response Format.
Response Type: applicationInfo
Possible Action Specific Error Codes:
HTTP Code |
Error Code |
Description |
404 |
noSuchApplication |
The provided application ID does not exist. |
409 |
applicationConflict |
The provided application package includes a different application, instead of a different version of the existing application. |
400 |
missingParamater |
A required parameter is missing. |
400 |
invalidParameter |
A value provided for a parameter is invalid. |
Example
|
Request
Response
|
Important Note:
For Zend Server on Linux, this action is also available via the command line using CLI tools. For more information, see ZendServerSDK.