Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Wowza

Wowza Virtual Hosts API

The Virtual Hosts API from Wowza — 42 operation(s) for virtual hosts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Wowza Virtual Hosts API is one of 48 APIs that Wowza publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Hosts. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and a changelog.

This API exposes 84 operations across 42 paths, and defines 45 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, http://localhost:8087.

84 operations 42 paths 45 schemas 10 DELETE35 GET14 POST25 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.video.wowza.com/api/v2.0
Authentication
HTTP Basic, HTTP Digest
Contact
Wowza Media Systems
License
Wowza Media Systems
Resource Areas
1

Authentication & Security 2

Wowza Virtual Hosts API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It uses HTTP digest authentication (digestAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Wowza Streaming Engine admin credentials
  • digestAuth — HTTP Digest Authentication

Paths & Operations 84

Across 42 paths, the API surfaces 84 operations — 10 DELETE, 35 GET, 14 POST, 25 PUT. Each is listed below with its method, path, parameters, and response codes.

Virtual Hosts 84
GET
/v2/servers/{serverName}/vhosts
Get vhost list
getVHostsConfig 1 param → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}
Get vhost config
getVHostConfig 2 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}
Update vhost config
putVHostConfig 2 params body → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/actions/{action}
Vhost actions
putVHostAction 3 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/adv
Get vhost config (adv)
getVHostConfigAdv 2 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/adv
Update vhost config (adv)
putVHostConfigAdv 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/hostports
Get host ports list
getHostPortsConfig 2 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}
Get host port
getHostPortConfig 3 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/adv
Get host port config (adv)
getHostPortConfigAdv 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/adv
Update host port config (adv)
putHostPortConfigAdv 3 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/httpproviders/{baseClass}
Get HTTP providers
getHTTPProviderConfig 4 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/ssl
Get SSL config
getSSLConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/ssl
Update SSL config
putSSLConfig 3 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/mediacache/stores
Get media cache store list
getMediaCacheStoreList 2 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/mediacache/stores/actions/{action}
Media cache store actions
putMediaCacheStoreAction 4 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/monitoring/current
Get current vhost stats
getCurrentVHostStatistics 2 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/monitoring/historic
Get historic vhost stats
getHistoricVHostStatistics 2 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/publishers
Get publisher list
getPublishersVhostConfig 2 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/publishers
Update publisher list
postPublishersVhostConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/publishers/{publisherName}
Get publisher config
getPublisherVhostConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/publishers/{publisherName}
Update publisher config
putPublisherVhostConfig 3 params body → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/publishers/{publisherName}
Create publisher config
postPublisherVhostConfig 3 params body → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/publishers/{publisherName}
Delete publisher config
deletePublisherVhostConfig 3 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles
Get SDP file list
getSDPFilesConfig 2 params → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles/{sdpfileName}
Delete SDP file
deleteSDPFileConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles/{sdpfileName}/actions/{action}
SDP file actions
putSDPFileAction 7 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles
Get SMIL files list
getSMILFilesConfig 2 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles
Update SMIL file list
postSMILFilesConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}
Get SMIL file
getSMILFileConfig 3 params → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}
Delete SMIL file
deleteSMILFileConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}
Update SMIL file
putSMILFileConfig 3 params body → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}
Create SMIL file
postSMILFileConfig 3 params body → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}/actions/{action}
SMIL file actions
putSMILFileAction 8 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams
Get startup stream list
getStartupStreamsConfig 2 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams
Update startup stream list
postStartupStreamsConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}
Get startup stream config
getStartupStreamConfig 5 params → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}
Delete startup stream config
deleteStartupStreamConfig 5 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}
Create startup stream config
postStartupStreamConfig 5 params body → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}
Update startup stream config
putStartupStreamConfig 5 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles
Get stream file list
getStreamFilesConfig 2 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles
Update stream file list
postStreamFilesConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}
Get stream file config
getStreamFileConfig 3 params → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}
Delete stream file config
deleteStreamFileConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}
Update stream file config
putStreamFileConfig 3 params body → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}
Create stream file config
postStreamFileConfig 3 params body → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/actions/{action}
Update stream file action
putStreamFileAction 8 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/adv
Get stream file config (adv)
getStreamFileConfigAdv 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/adv
Update stream file config (adv)
putStreamFileConfigAdv 3 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/testPlaybackInfo
Get playback info
getTestPlaybackInfoConfig 2 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder
Get transcoder config
getVHostTranscoderConfig 2 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder
Update transcoder config
putTranscoderConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates
Get transcoder template list
getTranscoderTemplatesConfig 2 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates
Update transcoder template list
postTranscoderTemplatesConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}
Get transcoder template config
getTranscoderTemplateConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}
Update transcoder template config
putTranscoderTemplateConfig 3 params body → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}
Create transcoder template config
postTranscoderTemplateConfig 3 params body → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}
Delete transcoder template config
deleteTranscoderTemplateConfig 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/actions/{action}
Transcoder template actions
putTranscoderTemplateAction 5 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/adv
Get transcoder template config (adv)
getTranscoderTemplateConfigAdv 3 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/adv
Update transcoder template config (adv)
putTranscoderTemplateConfigAdv 3 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/decode/overlays/{overlayName}
Get transcoder overlay decoder config
getTranscoderOverlayDecodeConfig 4 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/decode/overlays/{overlayName}
Update transcoder overlay decoder config
putTranscoderOverlayDecodeConfig 4 params body → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/decode/overlays/{overlayName}
Delete transcoder overlay decoder config
deleteTranscoderOverlayDecodeConfig 4 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes
Get transcoder encoder list
getTranscoderEncodesConfig 3 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes
Update transcoder encoder list
postTranscoderEncodesConfig 3 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}
Get transcoder encoder config
getTranscoderEncodeConfig 4 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}
Create transcoder encoder config
postTranscoderEncodeConfig 4 params body → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}
Update transcoder encoder config
putTranscoderEncodeConfig 4 params body → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}
Delete transcoder encoder config
deleteTranscoderEncodeConfig 4 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/adv
Get transcoder encoder config (adv)
getTranscoderEncodeConfigAdv 4 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/adv
Update transcoder encoder config (adv)
putTranscoderEncodeConfigAdv 4 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}
Get transcoder overlay encoder config
getTranscoderOverlayEncodeConfig 5 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}
Update transcoder overlay encoder config
putTranscoderOverlayEncodeConfig 5 params body → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}
Delete transcoder overlay encoder config
deleteTranscoderOverlayEncodeConfig 5 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups
Get transcoder stream name group list
getTranscoderStreamNameGroupsConfig 3 params → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups
Update transcoder stream name group list
postTranscoderStreamNameGroupsConfig 3 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups/{groupName}
Get transcoder stream name group config
getTranscoderStreamNameGroupConfig 4 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups/{groupName}
Update transcoder stream name group config
putTranscoderStreamNameGroupConfig 4 params body → 200400401404500
POST
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups/{groupName}
Create transcoder stream name group config
postTranscoderStreamNameGroupConfig 4 params body → 200400401404500
DELETE
/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups/{groupName}
Delete transcoder stream name group config
deleteTranscoderStreamNameGroupConfig 4 params → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/tune
Get tuning config
getVHostTuneConfig 2 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/tune
Update tuning config
putVHostTuneConfig 2 params body → 200400401404500
GET
/v2/servers/{serverName}/vhosts/{vhostName}/tunehostports
Get host port config
getHostportsTuneConfig 2 params → 200400401404500
PUT
/v2/servers/{serverName}/vhosts/{vhostName}/tunehostports
Update host port config
putHostportsTuneConfig 2 params body → 200400401404500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are TranscoderEncodeConfig (23 properties), SMILFileStreamConfig (22 properties), VHostTuneConfig (22 properties), HostPortConfig (19 properties). Each schema is shown below with its type and property counts.

HostPortsConfig
object
4 properties 3 required
ShortObject
object
2 properties 2 required
HostPortConfig
object
19 properties 18 required
TranscoderOverlayDecodeConfig
object
15 properties 14 required
ApplicationsConfig
object
4 properties 3 required
Boolean
object
SMILFileStreamConfig
object
22 properties 21 required
VHostShortObject
object
5 properties 5 required
StartupStreamConfig
object
7 properties 6 required
TranscoderStreamNameGroupsConfig
object
4 properties 3 required
TranscoderTemplatesConfig
object
5 properties 4 required
TranscoderEncodesConfig
object
4 properties 3 required
StreamFilesConfig
object
4 properties 3 required
StartupStreamsConfig
object
4 properties 3 required
VHostsConfig
object
4 properties 3 required
SMILFilesConfig
object
5 properties 4 required
SSLConfig
object
12 properties 11 required
StreamFileConfigAdv
object
6 properties 4 required
Long
object
StreamFileConfig
object
8 properties 7 required
VHostConfigAdv
object
4 properties 3 required
MpegTSFilter
object
4 properties 4 required
PublisherVhostConfig
object
6 properties 5 required
TranscoderConfig
object
7 properties 6 required
HostportsTuneConfig
object
5 properties 4 required
MediaCacheStoreList
object
4 properties 3 required
TranscoderTemplateConfigAdv
object
5 properties 4 required
SMILFileConfig
object
6 properties 5 required
TranscoderEncodeConfigAdv
object
5 properties 4 required
TranscoderOverlayEncodeConfig
object
16 properties 15 required
HTTPProviderConfig
object
6 properties 5 required
AdvancedSetting
object
10 properties 10 required
TranscoderTemplateConfig
object
12 properties 11 required
HistoricVHostStatistics
object
3 properties 3 required
TranscoderMemberConfig
object
7 properties 6 required
PublishersVhostConfig
object
4 properties 3 required
AppShortObject
object
7 properties 7 required
VHostTuneConfig
object
22 properties 21 required
TranscoderEncodeConfig
object
23 properties 22 required
HostPortConfigAdv
object
10 properties 9 required
TranscoderStreamNameGroupConfig
object
7 properties 6 required
SDPFilesConfig
object
4 properties 3 required
VHostConfig
object
17 properties 16 required
CurrentVHostStatistics
object
7 properties 7 required
TestPlaybackInfoConfig
object
4 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wowza-virtual-hosts-api-openapi.yml Raw ↑

Other APIs Wowza publishes across the network.

Wowza Streaming Engine Java API
AE Profile APIs.io
Wowza Flowplayer
AE Profile APIs.io
Wowza GoCoder SDK
AE Profile APIs.io
Wowza Real-Time Streaming SDK
AE Profile APIs.io
Wowza advanced_token_authentication API
AE Profile APIs.io
Wowza analytics_engagement API
AE Profile APIs.io
Wowza analytics_ingest API
AE Profile APIs.io
Wowza analytics_popularity API
AE Profile APIs.io
Wowza analytics_viewers API
AE Profile APIs.io
Wowza Applications API
AE Profile APIs.io
Wowza assets API
AE Profile APIs.io
Wowza categories API
AE Profile APIs.io
#Virtual Hosts
← Back to W APIs
API Details
ID
wowza:wowza-virtual-hosts-api
Base URL
https://api.video.wowza.com/api/v2.0
Docs
https://developer.wowza.com/docs/wowza-video/api/video/openapi
Provider
Wowza
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network