{ "opencollection": "1.0.0", "info": { "name": "Wowza Streaming Engine REST advanced_token_authentication Applications API", "version": "2.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Get app list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of applications for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Update app list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an application to the list of applications for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Get app config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create app config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update app config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete app config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Application actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "dstEntryName", "value": "", "type": "query", "description": "The destination application name when copying " }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" } ] }, "docs": "Start, copy, restart, or shutdown an application. This API is available in builds 15089 or later." }, { "info": { "name": "Get app config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified advanced application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create app config (adv)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified advanced application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update app config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified advanced application configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get DRM config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update DRM config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get DRM config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update DRM config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get BuyDRM mapfile", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm/buydrmmapfile", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the BuyDRM stream mapfile for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update BuyDRM mapfile", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm/buydrmmapfile", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the BuyDRM stream mapfile for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get Verimatrix mapfile", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm/verimatrixmapfile", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the Verimatrix stream mapfile for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update Verimatrix mapfile", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/drm/verimatrixmapfile", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Verimatrix stream mapfile for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get DVR config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/dvr", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the DVR configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update DVR config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/dvr", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the DVR configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get DVR config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/dvr/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced DVR configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update DVR config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/dvr/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced DVR configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get instance list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of instances for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get instance config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified application instance information. This API is available in builds 15089 or later." }, { "info": { "name": "Instance actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" } ] }, "docs": "This API is available in builds 15089 or later." }, { "info": { "name": "Get DVR store list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/dvrstores", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of DVR stores associated with this application instance. This API is available in builds 15942 or later." }, { "info": { "name": "DVR stores actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/dvrstores/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "dvrConverterDefaultFileDestination", "value": "", "type": "query", "description": "The file location to use when converting a nDVR store, the default is configured as the StorageDir in the application in use" }, { "name": "dvrConverterDebugConversions", "value": "", "type": "query", "description": "Indicates if the conversion should have debugging enabled, can be true or false, default is false" }, { "name": "dvrConverterContinueOnSourceErrors", "value": "", "type": "query", "description": "Indicates if the conversion should continue even if errors are detected, can be true or false, default is true" }, { "name": "dvrConverterAudioVideoSyncEnable", "value": "", "type": "query", "description": "Indicates if the audio/video offset should be detected and conversion only started after the sync in no longer detected or over default allowable time. Can be true or false, default is false" }, { "name": "dvrConverterAudioVideoMaxOffset", "value": "", "type": "query", "description": "Indicates the maximum audio/video timecodes can be out of sync" }, { "name": "dvrConverterAudioVideoMaxBuffer", "value": "", "type": "query", "description": "Indicates the maximum time a correct audio/video sync will be searched for before giving up" }, { "name": "dvrConverterStartTime", "value": "", "type": "query", "description": "A start time in UTC from where the conversion should start in the store, default is the first entry in the store" }, { "name": "dvrConverterEndTime", "value": "", "type": "query", "description": "A end time in UTC where the conversion should end in the store, default is to the end of the store" }, { "name": "dvrConverterDuration", "value": "", "type": "query", "description": "A duration for the conversion either added to the start or subtracted from the end time, if you use duration you can not use start and end" }, { "name": "dvrConverterOutputFilename", "value": "", "type": "query", "description": "Indicates the output filename if not using the default, which is the name of the store being converted" }, { "name": "dvrConverterStoreList", "value": "", "type": "query", "description": "The comma-separated list of stores to convert" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" } ] }, "docs": "DVR REST converter store actions. This API is available in builds 15942 or later." }, { "info": { "name": "Get DVR store info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/dvrstores/:dvrStoreName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" }, { "name": "dvrStoreName", "value": "", "type": "path" } ] }, "docs": "Retrieves the information about a store/converter associated with the application instance. This API is available in builds 15942 or later." }, { "info": { "name": "DVR actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/dvrstores/:dvrStoreName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" }, { "name": "dvrStoreName", "value": "", "type": "path", "description": "The nDVR store name needed for this REST call" } ] }, "docs": "DVR REST converter store action. This API is available in builds 15942 or later." }, { "info": { "name": "Get incoming stream info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" } ] }, "docs": "Retrieves the incoming stream information for the specified Incoming Stream. This API is available in builds 15089 or later." }, { "info": { "name": "Incoming stream actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" }, { "name": "streamName", "value": "", "type": "path", "description": "The stream name needed for this REST call" } ] }, "docs": "Disconnect or reset an incoming stream. This API is available in builds 15089 or later." }, { "info": { "name": "Get live encoder config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName/encoder/live", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" }, { "name": "publishUser", "value": "", "type": "query", "description": "The publish username to use in the encoder configuration" }, { "name": "publishHost", "value": "", "type": "query", "description": "The IP address then encoder will publish to" }, { "name": "publishPort", "value": "", "type": "query", "description": "The Port number the encoder will publish to" } ] }, "docs": "Retrieves the live encoder configuration for the specified incoming stream. This API is available in builds 15089 or later." }, { "info": { "name": "Get live encoder short URL", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName/encoder/shorturl", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" } ] }, "docs": "Retrieves the short URL for the live encoder configuration for the specified incoming stream. This API is available in builds 15089 or later." }, { "info": { "name": "Get current incoming stream stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName/monitoring/current", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" } ] }, "docs": "Retrieves the current incoming stream statistics for the specified incoming stream. This API is available in builds 15089 or later." }, { "info": { "name": "Get source control info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName/sourcecontrol", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" } ] }, "docs": "Gets information about the source control and its supported features. This API is available in builds 15089 or later." }, { "info": { "name": "Source control actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/incomingstreams/:streamName/sourcecontrol/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The VHost name" }, { "name": "appName", "value": "", "type": "path", "description": "The application name" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name" }, { "name": "streamName", "value": "", "type": "path", "description": "The Stream name" }, { "name": "direction", "value": "", "type": "query", "description": "No query params available for captureImage. Optional query params for zoom and panTilt: ZoomIn, ZoomOut, PanTiltUp, PanTiltRight, PanTiltDown, PanTiltLeft, PanTiltHome, PanTiltUpRight, PanTiltDownRight, PanTiltDownLeft, PanTiltUpLeft" } ] }, "docs": "Source control action. This API is available in builds 15089 or later." }, { "info": { "name": "Media cache store actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/mediacache/stores/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "filename", "value": "", "type": "query", "description": "The file or stream name item to be used in all rest action requests" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" } ] }, "docs": "Media cache application store action. This API is available in builds 15942 or later." }, { "info": { "name": "Get stream group list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamgroups", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of stream groups for the specified application instance. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream group config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamgroups/:groupName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "groupName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified StreamGroup configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Stream group actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamgroups/:groupName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" }, { "name": "groupName", "value": "", "type": "path", "description": "The group name needed for this REST call" } ] }, "docs": "Stream Group Action. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream recorders list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamrecorders", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of stream recorders for the specified application instance. This API is available in builds 15089 or later." }, { "info": { "name": "Create stream recorder", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamrecorders", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new stream recorder in the specified application instance and starts recording. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream recorder", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamrecorders/:recorderName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "recorderName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified stream recorder. This API is available in builds 15089 or later." }, { "info": { "name": "Create stream recorder", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamrecorders/:recorderName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "recorderName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new stream recorder and starts recording. This API is available in builds 15089 or later." }, { "info": { "name": "Stream recorder actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamrecorders/:recorderName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "instanceName", "value": "", "type": "path", "description": "The application instance name needed for this REST call" }, { "name": "recorderName", "value": "", "type": "path", "description": "The recorder name (stream name) needed for this REST call" } ] }, "docs": "Stream recorder action. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream recorder", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/instances/:instanceName/streamrecorders/:recorderName/default", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "recorderName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves a stream recorder of the requested name, populated with the default values. This API is available in builds 15089 or later." }, { "info": { "name": "Get module list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/modules", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of modules for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update module list", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/modules", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of modules for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get current app stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/monitoring/current", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the current application statistics. This API is available in builds 15089 or later." }, { "info": { "name": "Get historic app stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/monitoring/historic", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the historic application statistics. This API is available in builds 15089 or later." }, { "info": { "name": "Get publisher list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of publishers for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update publisher list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a publisher to list of publishers for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get publisher config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/publishers/:publisherName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" }, { "name": "publisherName", "value": "", "type": "path", "description": "The publisher name" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified publisher configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create publisher config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/publishers/:publisherName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" }, { "name": "publisherName", "value": "", "type": "path", "description": "The publisher name" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified publisherconfiguration. This API is available in builds 15089 or later." }, { "info": { "name": "Update publisher config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/publishers/:publisherName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" }, { "name": "publisherName", "value": "", "type": "path", "description": "The publisher name" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified publisherconfiguration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete publisher config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/publishers/:publisherName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" }, { "name": "publisherName", "value": "", "type": "path", "description": "The publisher name" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified publisher configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get push publish map", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of PushPublish map entries for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Add entry to push publish map", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a push publish map entry to list of push publish map entries for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update push publish map", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Push publish streams app config. This API is available in builds 15089 or later." }, { "info": { "name": "Get push publish map entry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries/:entryName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "entryName", "value": "", "type": "path", "description": "The entry name needed for this REST call" } ] }, "docs": "Retrieves the specified push publish map entry's configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Create push publish map entry", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries/:entryName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "entryName", "value": "", "type": "path", "description": "The entry name needed for this REST call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified push publish map entry for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update push publish map entry", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries/:entryName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "entryName", "value": "", "type": "path", "description": "The entry name needed for this REST call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified push publish map entry's configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Delete push publish map entry", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries/:entryName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "entryName", "value": "", "type": "path", "description": "The entry name needed for this REST call" } ] }, "docs": "Deletes the specified push publish map entry for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Push publish actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/mapentries/:entryName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "dstEntryName", "value": "", "type": "query", "description": "The destination entryName when copying " }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "entryName", "value": "", "type": "path", "description": "The map entry name needed for this REST call" } ] }, "docs": "Push publish stream app action. This API is available in builds 15089 or later." }, { "info": { "name": "Get push publish cloud storage provider list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/pushpublish/providers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves a list of push publish cloud storage providers. This API is under development, do not use." }, { "info": { "name": "Get SDP files", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/sdpfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of SDP Files for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Delete SDP file", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/sdpfiles/:sdpfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "sdpfileName", "value": "", "type": "path", "description": "The SDP file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified SDP file. This API is available in builds 15089 or later." }, { "info": { "name": "SDP file actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/sdpfiles/:sdpfileName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "connectAppName", "value": "", "type": "query", "description": "The name of the application to connect to" }, { "name": "appInstance", "value": "", "type": "query", "description": "The name of the application instance to connect to" }, { "name": "mediaCasterType", "value": "", "type": "query", "description": "The MediaCasterType to use for the connection " }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "sdpfileName", "value": "", "type": "path", "description": "The sdp file name needed for this REST call" } ] }, "docs": "SDP file app action. This API is available in builds 15089 or later." }, { "info": { "name": "Get security config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/security", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the security configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update security config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/security", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the security configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get SMIL file list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" } ] }, "docs": "Retrieves the list of SMIL Files for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update SMIL file list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an SMIL file to the list of SMIL files for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get SMIL file", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles/:smilfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "smilfileName", "value": "", "type": "path", "description": "The SMIL file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified SMIL file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create SMIL file", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles/:smilfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "smilfileName", "value": "", "type": "path", "description": "The SMIL file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified SMIL file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update SMIL file", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles/:smilfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "smilfileName", "value": "", "type": "path", "description": "The SMIL file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified SMIL file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete SMIL file", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles/:smilfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "smilfileName", "value": "", "type": "path", "description": "The SMIL file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified SMIL file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "SMIL file actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/smilfiles/:smilfileName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "connectAppName", "value": "", "type": "query", "description": "The name of the application to connect to" }, { "name": "appInstance", "value": "", "type": "query", "description": "The name of the application instance to connect to" }, { "name": "mediaCasterType", "value": "", "type": "query", "description": "The MediaCasterType to use for the connection " }, { "name": "dstEntryName", "value": "", "type": "query", "description": "The destination SMIL file name when copying " }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "smilfileName", "value": "", "type": "path", "description": "The SMIL file name needed for this REST call" } ] }, "docs": "SMIL file app action. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamconfiguration", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the stream configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update stream config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamconfiguration", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Stream configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream file list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of stream files for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update stream file list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a stream file to the list of stream files for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream file config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create stream file config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update stream file config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete stream file config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file name without the extension" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Stream file actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "connectAppName", "value": "", "type": "query", "description": "The name of the application to connect to" }, { "name": "appInstance", "value": "", "type": "query", "description": "The name of the application instance to connect to" }, { "name": "mediaCasterType", "value": "", "type": "query", "description": "The MediaCasterType to use for the connection " }, { "name": "dstEntryName", "value": "", "type": "query", "description": "The destination stream file name when copying " }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file, file name needed for this REST call" } ] }, "docs": "Stream file app action. This API is available in builds 15089 or later." }, { "info": { "name": "Get stream file config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file name without the .stream extension" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update stream file config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/streamfiles/:streamfileName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamfileName", "value": "", "type": "path", "description": "The stream file name without the .stream extension" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the transcoder configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the transcoder configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced transcoder configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced transcoder configuration for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder template list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of transcoder template configurations for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder template list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a transcoder templates configuration to the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder template", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create transcoder template", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder template", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete transcoder template", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Transcoder template actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/actions/:action", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "action", "value": "", "type": "path", "description": "The action which should be performed by the server" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "appName", "value": "", "type": "path", "description": "The application name needed for this REST call" }, { "name": "templateName", "value": "", "type": "path", "description": "The template name needed for this REST call" }, { "name": "dstEntryName", "value": "", "type": "query", "description": "The destination transcode template file name when copying " } ] }, "docs": "Transcoder template app action. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder template (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder template (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder overlay decode config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/decode/overlays/:overlayName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "overlayName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified transcoder overlay decode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder overlay decode config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/decode/overlays/:overlayName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "overlayName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified transcoder overlay decode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete transcoder overlay decode config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/decode/overlays/:overlayName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "overlayName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified transcoder overlay decode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder encoder list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of transcoder encode configurations for the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder encoder list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a transcoder encode configuration to the specified application. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder encoder config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified transcoder encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create transcoder encoder config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified transcoder encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder encoder config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified transcoder encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete transcoder encoder config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified transcoder encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder encoder config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced transcoder encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder encoder config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced transcoder encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder overlay encoder", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName/overlays/:overlayName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "overlayName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified transcoder overlay encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder overlay encoder", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName/overlays/:overlayName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "overlayName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified transcoder overlay encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete transcoder overlay encoder", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/encodes/:encodeName/overlays/:overlayName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "overlayName", "value": "", "type": "path" }, { "name": "encodeName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified transcoder overlay encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder stream name group list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/streamnamegroups", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of transcoder stream name groups for the specified template. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder stream name group list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/streamnamegroups", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a transcoder stream name groups configuration to the specified template. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder stream name group config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/streamnamegroups/:groupName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "groupName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified transcoder stream name group configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create transcoder stream name group config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/streamnamegroups/:groupName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "groupName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified transcoder stream name group configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder stream name group config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/streamnamegroups/:groupName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "groupName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified transcoder stream name group configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete transcoder stream name group config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/transcoder/templates/:templateName/streamnamegroups/:groupName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" }, { "name": "groupName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified transcoder stream name group configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get WEBRTC config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/webrtc", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later." }, { "info": { "name": "Update WebRTC config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/webrtc", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later." }, { "info": { "name": "Get WebRTC config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/webrtc/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Retrieves the advanced WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later." }, { "info": { "name": "Update WebRTC config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/webrtc/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later." }, { "info": { "name": "Create WSC proxy request", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/applications/:appName/wscrestproxy", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Proxies a WSC REST API request. This API is available in builds 19950 or later." } ] } ], "bundled": true }