The webSiteGetDetails Web API Method

Get the details of web site. Same as vhostgetdetails for 1.16.

Version: 1.15

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

site

Integer

Yes

The ID of a single web site.

Expected Response Code: 200 OK  - For more information see Response Format.

Response Type: vhostDetails

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

404

noSuchVhost

One or more of the requested virtual hosts does not exist.

Example

Usage Example

Request

GET /ZendServer/Api/webSiteGetDetails?site=1

Response

<?xml version="1.0" encoding="UTF-8"?>

<responseData>

<vhostDetails>

<vhostInfo>

<id>2</id>

<name><![CDATA[Default Web Site]]></name>

<port>80</port>

<status><![CDATA[Modified]]></status>

<default>1</default>

<zendDefined><![CDATA[true]]></zendDefined>

<zendManaged><![CDATA[true]]></zendManaged>

<ssl><![CDATA[false]]></ssl>

<created><![CDATA[2017-09-19T10:34:58+03:00]]></created>

<lastUpdated><![CDATA[2017-09-19T10:34:58+03:00]]></lastUpdated>

<createdTimestamp>1505806498</createdTimestamp>

<lastUpdatedTimestamp>1505806498</lastUpdatedTimestamp>

<applicationPool><![CDATA[DefaultAppPool]]></applicationPool>

<servers>

<server>

<id>0</id>

<status><![CDATA[Modified]]></status>

<name><![CDATA[PC-anyas]]></name>

<lastMessage><![CDATA[["+<?xml version=\"1.0\" encoding=\"UTF-8\"?><br>+<configuration><br>+<system.webServer><br>+<directoryBrowse enabled=\"true\" /><br>+</system.webServer><br>+</configuration><br> <br>"]]]></lastMessage>

</server>

</servers>

</vhostInfo>

<vhostExtended>

<text><![CDATA[null]]></text>

<template><![CDATA[null]]></template>

<docRoot><![CDATA[C:\inetpub\wwwroot]]></docRoot>

<applicationPool><![CDATA[DefaultAppPool]]></applicationPool>

<sslCertificatePath><![CDATA[null]]></sslCertificatePath>

<sslCertificateKeyPath><![CDATA[null]]></sslCertificateKeyPath>

<sslCertificateChainPath><![CDATA[null]]></sslCertificateChainPath>

<sslAppName><![CDATA[null]]></sslAppName>

<vhostApplications>

<vhostApplication>

<applicationId>3</applicationId>

<baseUrl><![CDATA[http://localhost/client]]></baseUrl>

<applicationName><![CDATA[zend-web-api-client]]></applicationName>

<userApplicationName><![CDATA[zend-web-api-client]]></userApplicationName>

<installedLocation><![CDATA[C:\Program Files (x86)\Zend\ZendServer\data\apps\http\__default__\0\client\1.6.9_3]]></installedLocation>

</vhostApplication>

</vhostApplications>

<bindings>

<binding>

<ID>8</ID>

<VHOST_ID>2</VHOST_ID>

<IS_SSL>0</IS_SSL>

<HOSTNAME><![CDATA[]]></HOSTNAME>

<PORT>0</PORT>

<ADDRESS><![CDATA[*]]></ADDRESS>

</binding>

</bindings>

</vhostExtended>

</vhostDetails>

</responseData>