Virtual Hosts

Retrieves the specified vhost configuration. This API is available in builds 15089 or later.

get/v2/servers/{serverName}/vhosts/{vhostName}

Request

  • Base URL
    http://localhost:8087
  • URL
    http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}
  • Auth
    HTTP basic

Path parameters

serverNamestring required

Reserved for future use

vhostNamestring required

The vhost name

Response

Successful response

testPlayerSSLEnablestring required
securityPublishValidEncodersstring required
serverNamestring required
descriptionstring required
maximumConcurrentTranscodesinteger required
srtListenerLocalPortinteger required
versionstring required
configurationDirstring required
testPlayerPortstring required
runningboolean required
connectionLimitinteger required
testPlayerIPAddressstring required
namestring required
srtListenerLocalIPAddressstring required
saveFieldListstring[]
srtPassPhrasestring required
webrtcSelectedVersionstring required

Changes

    • info

      added the required property // to the response with the status

    • info

      added the required property to the response with the status