The following section describes the specific actions that can be performed using the Zend Server Web API. Each method carries a different operation or is designed to retrieve specific information from Zend Server or Zend Server Cluster Manager. You can use the information described for each method together with the structure defined in Generic Request/Response Format to execute the available API methods.
The following information is described for each method:
Note:
The table does not display information regarding changes made to existing methods. This information is displayed on the specific method page.
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
userAuthenticationSettings |
|
|
|
|
|
|
|
userSetPassword |
|
|
|
|
|
|
|
setPassword |
|
|
|
|
|
|
|
apiKeysGetList |
|
|
|
|
|
|
|
apiKeysAddKey |
|
|
|
|
|
|
|
apiKeysRemoveKey |
|
|
|
|
|
|
|
serverValidateLicense |
|
|
|
|
|
|
|
aclSetGroups |
|
|
|
|
|
|
|
bootstrapSingleServer |
|
|
|
|
|
|
|
serverStoreLicense |
|
|
|
|
|
|
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
auditGetList |
|
|
|
|
|
|
|
auditGetDetails |
|
|
|
|
|
|
|
auditSetSettings |
|
|
|
|
|
|
|
auditExport |
|
|
|
![]() |
|
|
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
|
|
|
|
datacacheClear |
![]() |
![]() |
![]() |
![]() |
|
|
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
|
![]() |
|
|
|
|
|
![]() |
|
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
|
![]() |
|
|
|
|
|
![]() |
|
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
1.9/8.0* | |
configurationReset |
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
deploymentDownloadFile |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
jobqueueDeleteJobsByPredefinedFilter |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
jobqueueAddJob |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.6/6.3 | 1.8/7.0 | 1.9/8.0* |
libraryGetStatus |
|
|
|
![]() |
![]() |
![]() |
|
libraryVersionCheckDependents |
|
|
|
![]() |
![]() |
![]() |
|
libraryCheckDependents |
|
|
|
![]() |
![]() |
![]() |
|
libraryVersionRemove |
|
|
|
![]() |
![]() |
![]() |
|
libraryVersionDeploy |
|
|
|
![]() |
![]() |
![]() |
|
libraryRemove |
|
|
|
![]() |
![]() |
![]() |
|
librarySynchronize |
|
|
|
![]() |
![]() |
![]() |
|
downloadLibraryVersionFile |
|
|
|
![]() |
![]() |
![]() |
|
libraryVersionGetStatus |
|
|
|
![]() |
![]() |
![]() |
|
librarySetDefault |
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
monitorCountIssuesByPredefinedFilter |
|
|
|
![]() |
![]() |
![]() |
|
monitorGetIssueEventGroups |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
getServerInfo |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
daemonsProbe |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
pagecacheExportRules |
|
|
|
![]() |
![]() |
![]() |
|
pagecacheImportRules |
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
![]() |
![]() |
![]() |
|
|
|
|
|
![]() |
![]() |
![]() |
|
|
pagecacheClearCacheByRuleName |
|
|
|
![]() |
![]() |
![]() |
|
pagecacheClearRulesCache |
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
urlinsightGetUrls |
|
|
|
|
|
|
|
urlinsightGetUrlInfo |
|
|
|
|
|
|
|
urlinsightGetZraySnapshots |
|
|
|
|
|
|
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
vhostGetStatus |
|
|
|
![]() |
![]() |
![]() |
|
vhostRemove |
|
|
|
![]() |
![]() |
![]() |
|
vhostAdd |
|
|
|
![]() |
![]() |
![]() |
|
vhostAddSecure |
|
|
|
![]() |
![]() |
![]() |
|
vhostAddSecureIbmi |
|
|
|
![]() |
![]() |
![]() |
|
vhostEdit |
|
|
|
![]() |
![]() |
![]() |
|
vhostGetDetails |
|
|
|
![]() |
![]() |
![]() |
|
vhostValidateSsl |
|
|
|
![]() |
![]() |
![]() |
|
vhostValidateTemplate |
|
|
|
![]() |
![]() |
![]() |
|
vhostRedeploy |
|
|
|
![]() |
![]() |
![]() |
|
vhostEnableDeployment |
|
|
|
![]() |
![]() |
![]() |
![]() |
vhostDisableDeployment |
|
|
|
![]() |
![]() |
![]() |
|
Method |
1.3/6.0 |
1.4/6.0.1 | 1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* |
zrayGetRequestsInfo |
|
|
|
|
|
![]() |
|
zrayGetAllRequestsInfo |
|
|
|
|
|
|
![]() |
zrayListAccessTokens |
|
|
|
|
|
![]() |
|
zrayCreateAccessToken |
|
|
|
|
|
![]() |
|
zrayRemoveAccessToken |
|
|
|
|
|
![]() |
|
zrayGetRequestFunctions |
|
|
|
|
|
![]() |
|
zrayGetRequestEnvironment |
|
|
|
|
|
![]() |
|
zrayGetCustomData |
|
|
|
|
|
|
![]() |
zrayGetDebuggerConfigurations |
|
|
|
|
|
![]() |
|
zrayGetBacktrace |
|
|
|
|
|
![]() |
|
zrayExpireAccessToken |
|
|
|
|
|
![]() |
|
*Current version