{ "opencollection": "1.0.0", "info": { "name": "Wowza Streaming Engine REST 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." } ] }, { "info": { "name": "Machine Stats", "type": "folder" }, "items": [ { "info": { "name": "Get current stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/machine/monitoring/current" }, "docs": "Retrieves current statistics for the machine. This API is available in builds 15089 or later." }, { "info": { "name": "Get historic stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/machine/monitoring/historic" }, "docs": "Retrieves historic statistics for the machine. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Licenses", "type": "folder" }, "items": [ { "info": { "name": "Get license list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/licenses", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of server licenses. This API is available in builds 15089 or later." }, { "info": { "name": "Update license list", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/licenses", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server license list. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Listeners", "type": "folder" }, "items": [ { "info": { "name": "Get listener list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/listeners", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of server listeners. This API is available in builds 15089 or later." }, { "info": { "name": "Update listener list", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/listeners", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server listeners list. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server log4j system", "type": "folder" }, "items": [ { "info": { "name": "Get log4j config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/log4j", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server log4j configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Log4j actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/log4j/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" } ] }, "docs": "Tells the log4j system to perform an action. This API is available in builds 15089 or later." }, { "info": { "name": "Log4j logger actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/log4j/:loggerName/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": "loggerName", "value": "", "type": "path", "description": "The logger name needed for this REST call" } ] }, "docs": "Tells the specified log4j logger to perform an action. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server MediaCache", "type": "folder" }, "items": [ { "info": { "name": "Get media cache config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/mediacache", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the advanced MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache config (adv)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an advanced MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache source list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of MediaCache Sources. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache source list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Source to the list. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache source config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache source config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache source config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete media cache source config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Deletes the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache source config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache source config (adv)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache source config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/sources/:sourceName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache store list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of MediaCache Stores. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache store list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Store to the list. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache store config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache store config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache store config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete media cache store config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Deletes the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache store config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified advanced MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache store config (adv)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified advanced MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache store config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/mediacache/stores/:storeName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified advanced MediaCache Store configuration. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server MediaCache Version 3", "type": "folder" }, "items": [ { "info": { "name": "Get media cache server config V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/mediacache", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache server config V3", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v3/servers/:serverName/mediacache", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server MediaCache configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache source list V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of MediaCache Sources. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache source list V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Source to the list. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache source config V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache source config V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache source config V3", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete media cache source config V3", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache source config (adv) V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache source config (adv) V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache source config (adv) V3", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/sources/:sourceName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "sourceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache store list V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/stores", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of MediaCache Stores. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache store list V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/stores", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Store to the list. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache store config V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create media cache store config V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update media cache store config V3", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified MediaCache Store configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete media cache store config V3", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v3/servers/:serverName/mediacache/stores/:storeName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "storeName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified MediaCache Store configuration. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server MediaCasters", "type": "folder" }, "items": [ { "info": { "name": "Get media caster list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacasters", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of MediaCasters. This API is available in builds 15089 or later." }, { "info": { "name": "Get media caster config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/mediacasters/:mediacastername", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "mediacastername", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified MediaCaster configuration. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Monitoring", "type": "folder" }, "items": [ { "info": { "name": "Get monitoring config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/monitoring", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server monitoring configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update monitoring config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/monitoring", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server monitoring configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get historical stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/monitoring/historic", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server historical statistics. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Publishers", "type": "folder" }, "items": [ { "info": { "name": "Get publisher list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of server Publishers. 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/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new publisher to the list. 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/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "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/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified publisher configuration. 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/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Deletes the specified publisher configuration. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Publishers Version 3", "type": "folder" }, "items": [ { "info": { "name": "Get publisher list V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of server Publishers. This API is available in builds 15089 or later." }, { "info": { "name": "Update publisher list V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new publisher to the list. This API is available in builds 15089 or later." }, { "info": { "name": "Get publisher config V3", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v3/servers/:serverName/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "publisher", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified publisher configuration. This API is available in builds 20064 or later." }, { "info": { "name": "Create publisher config V3", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v3/servers/:serverName/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "publisher", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified publisher configuration. This API is available in builds 20064 or later." }, { "info": { "name": "Update publisher config V3", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v3/servers/:serverName/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "publisher", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publisher config v3. This API is available in builds 20064 or later." }, { "info": { "name": "Delete publisher config V3", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v3/servers/:serverName/publishers/:publisher", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "publisher", "value": "", "type": "path" } ] }, "docs": "Deletes the specified publisher configuration. This API is available in builds 20064 or later." } ] }, { "info": { "name": "REST information", "type": "folder" }, "items": [ { "info": { "name": "Get REST API info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/restinfo" }, "docs": "Retrieves the REST configuration information. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Servers Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get server list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers" }, "docs": "Retrieves the list of servers. This API is available in builds 15089 or later." }, { "info": { "name": "Get server config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update server config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Server actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/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 location to use when creating a heap dump or stack trace. By default the installation location and file are named appropriately for a heap dump or stack trace" } ] }, "docs": "Tells the server to perform an action. This API is available in builds 18647 or later." }, { "info": { "name": "Get server config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the advanced server configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update server config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced server configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get log files", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/logfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "order", "value": "", "type": "query", "description": "The order of files in serverLogs list" } ] }, "docs": "Retrieves the list of server log files. This API is available in builds 15089 or later." }, { "info": { "name": "Get log file", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/logfiles/:logName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "lineCount", "value": "", "type": "query", "description": "The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset" }, { "name": "startOffset", "value": "", "type": "query", "description": "The byte offset in the file at which to begin getting log lines" }, { "name": "filter", "value": "", "type": "query", "description": "A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings" }, { "name": "search", "value": "", "type": "query", "description": "A string containing a literal string on which to filter or a regex" }, { "name": "regexSearch", "value": "", "type": "query", "description": "Indicates if the 'search' parameter is a regex or a literal string " }, { "name": "head", "value": "", "type": "query", "description": "Returns the first x lines from the requested log file, the overrides the startoffset and linecount values" }, { "name": "tail", "value": "", "type": "query", "description": "Returns the last x lines from the requested log file, the overrides the startoffset and linecount values" }, { "name": "logName", "value": "", "type": "path", "description": "The name of the log" } ] }, "docs": "Retrieves the contents of a server log with the specified log name. This API is available in builds 15089 or later." }, { "info": { "name": "Get zipped log file", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/logfiles/:logName/download", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "logName", "value": "", "type": "path", "description": "The name of the log" } ] }, "docs": "Retrieves the server log file for the specified log name, zipped. This API is available in builds 15089 or later." }, { "info": { "name": "Get log file types", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/logs", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of available server log types. This API is available in builds 15089 or later." }, { "info": { "name": "Get logs by type", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/logs/:logType", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "lineCount", "value": "", "type": "query", "description": "The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset" }, { "name": "startOffset", "value": "", "type": "query", "description": "The byte offset in the file at which to begin getting log lines" }, { "name": "filter", "value": "", "type": "query", "description": "A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings" }, { "name": "search", "value": "", "type": "query", "description": "A string containing a literal string on which to filter or a regex" }, { "name": "regexSearch", "value": "", "type": "query", "description": "Indicates if the 'search' parameter is a regex or a literal string " }, { "name": "head", "value": "", "type": "query", "description": "Returns the first x lines from the requested log file, the overrides the startoffset and linecount values" }, { "name": "tail", "value": "", "type": "query", "description": "Returns the last x lines from the requested log file, the overrides the startoffset and linecount values" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date to filter on (UTC milliseconds)" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date to filter on (UTC milliseconds)" }, { "name": "logType", "value": "", "type": "path", "description": "The type of the log" } ] }, "docs": "Retrieves the contents of multiple server logs with the specified type in the log name. This API is available in builds 15089 or later." }, { "info": { "name": "Get source control driver list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/sourcecontrol/drivernames", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Get the list of source control drivers. This API is available in builds 15089 or later." }, { "info": { "name": "Get vhost listener list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhostlisteners", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of vhost listeners. This API is available in builds 15089 or later." }, { "info": { "name": "Update vhost listener list", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhostlisteners", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the full list of vhost listeners. This API is available in builds 15089 or later." }, { "info": { "name": "Delete vhost listener by base class", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhostlisteners/:baseclass", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "baseclass", "value": "", "type": "path" } ] }, "docs": "Deletes the vhost listener with the given base class. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Status", "type": "folder" }, "items": [ { "info": { "name": "Get server status", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/status", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server status. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Transcoder", "type": "folder" }, "items": [ { "info": { "name": "Get transcoder config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/transcoder", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the transcoder information. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Tuning", "type": "folder" }, "items": [ { "info": { "name": "Get tuning config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/tune", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the server tuning configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update tuning config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/tune", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the server tuning configuration. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Server Users", "type": "folder" }, "items": [ { "info": { "name": "Get user list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/users", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of server users. This API is available in builds 15089 or later." }, { "info": { "name": "Update user list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/users", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new server user to the list. This API is available in builds 15089 or later." }, { "info": { "name": "Get user", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/users/:userName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "userName", "value": "", "type": "path", "description": "The user name" } ] }, "docs": "Retrieves the specified user configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create user", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/users/:userName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "userName", "value": "", "type": "path", "description": "The user name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified user configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/users/:userName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "userName", "value": "", "type": "path", "description": "The user name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified user configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/users/:userName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "userName", "value": "", "type": "path", "description": "The user name" } ] }, "docs": "Deletes the specified user configuration. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Virtual Hosts", "type": "folder" }, "items": [ { "info": { "name": "Get vhost list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Retrieves the list of vhosts. This API is available in builds 15089 or later." }, { "info": { "name": "Get vhost config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ] }, "docs": "Retrieves the specified vhost configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update vhost config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified vhost configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Vhost actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "docs": "Vhost action. This API is available in builds 15089 or later." }, { "info": { "name": "Get vhost config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified advanced vhost configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update vhost config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified advanced vhost configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get host ports list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of server host ports for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Get host port", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports/:portname", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "portname", "value": "", "type": "path", "description": "The port name" } ] }, "docs": "Retrieves the host port for the specified vhost and port. This API is available in builds 15089 or later." }, { "info": { "name": "Get host port config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports/:portname/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "portname", "value": "", "type": "path", "description": "The port name" } ] }, "docs": "Retrieves the advanced host port configuration for the specified vhost and port. This API is available in builds 15089 or later." }, { "info": { "name": "Update host port config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports/:portname/adv", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "portname", "value": "", "type": "path", "description": "The port name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Host port config adv. This API is available in builds 15089 or later." }, { "info": { "name": "Get HTTP providers", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports/:portname/httpproviders/:baseClass", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "portname", "value": "", "type": "path" }, { "name": "baseClass", "value": "", "type": "path", "description": "Base class path" } ] }, "docs": "Retrieves the HTTP providers for the specified vhost, port and baseclass. This API is available in builds 15089 or later." }, { "info": { "name": "Get SSL config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports/:portname/ssl", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "portname", "value": "", "type": "path", "description": "The port name" } ] }, "docs": "Retrieves the SSL configuration for the specified vhost and port. This API is available in builds 15089 or later." }, { "info": { "name": "Update SSL config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/hostports/:portname/ssl", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "portname", "value": "", "type": "path", "description": "The port name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the SSL configuration for the specified vhost and port. This API is available in builds 15089 or later." }, { "info": { "name": "Get media cache store list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/mediacache/stores", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves all entries in the media cache system. This API is available in builds 15942 or later." }, { "info": { "name": "Media cache store actions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "docs": "Media cache store action. This API is available in builds 15942 or later." }, { "info": { "name": "Get current vhost stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/monitoring/current", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the current vhost statistics. This API is available in builds 15089 or later." }, { "info": { "name": "Get historic vhost stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/monitoring/historic", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the historic vhost 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/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ] }, "docs": "Retrieves the list of publishers for the specified vhost. 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/publishers", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a publisher to list of publishers for the specified vhost. 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/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" } ] }, "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/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified publisher configuration. 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/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified publisher configuration. 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/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" } ] }, "docs": "Deletes the specified publisher configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get SDP file list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/sdpfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of SDP Files for the specified vhost. 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/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" } ] }, "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/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": "sdpfileName", "value": "", "type": "path", "description": "The SDP file name needed for this REST call" } ] }, "docs": "SDPF file action. This API is available in builds 15089 or later." }, { "info": { "name": "Get SMIL files list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "docs": "Retrieves the list of SMIL files for the specified vhost. 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/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a SMIL file to the list of SMIL files for the specified vhost. 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/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" } ] }, "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/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" } ], "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/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" } ], "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/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" } ] }, "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/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": "smilfileName", "value": "", "type": "path", "description": "The SMIL file, file name needed for this REST call" } ] }, "docs": "SMIL file action. This API is available in builds 15089 or later." }, { "info": { "name": "Get startup stream list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/startupstreams", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of startup streams for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Update startup stream list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/startupstreams", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a startup stream to the list of startup streams for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Get startup stream config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/startupstreams/applications/:appName/instances/:instanceName/streams/:streamName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified startup stream configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create startup stream config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/startupstreams/applications/:appName/instances/:instanceName/streams/:streamName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified startup stream configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update startup stream config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/startupstreams/applications/:appName/instances/:instanceName/streams/:streamName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified startup stream configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Delete startup stream config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/startupstreams/applications/:appName/instances/:instanceName/streams/:streamName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "streamName", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "instanceName", "value": "", "type": "path" } ] }, "docs": "Deletes the specified startup stream configuration. 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/streamfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the list of stream files for the specified vhost. 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/streamfiles", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a stream file to the list of stream files for the specified vhost. 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/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" } ] }, "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/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" } ], "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/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" } ], "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/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" } ] }, "docs": "Deletes the specified stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update stream file action", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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": "streamfileName", "value": "", "type": "path", "description": "The stream file, file name needed for this REST call" } ] }, "docs": "Stream file 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/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" } ] }, "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/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the advanced stream file configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get playback info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/testPlaybackInfo", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the VHost" } ] }, "docs": "Retrieves the playback info for the specified vhost. 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/transcoder", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ] }, "docs": "Retrieves the transcoder configuration for the specified vhost. 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/transcoder", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the transcoder configuration for the specified vhost. 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/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" } ] }, "docs": "Retrieves the list of transcoder template configurations for the specified vhost. 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/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a transcoder templates configuration to the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder template config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" } ] }, "docs": "Retrieves the specified transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Create transcoder template config", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "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 config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "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 config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/transcoder/templates/:templateName", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path" }, { "name": "templateName", "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/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": "dstEntryName", "value": "", "type": "query", "description": "The destination transcoder template name when copying " }, { "name": "vhostName", "value": "", "type": "path", "description": "The name of the current VHost the action will be performed on" }, { "name": "templateName", "value": "", "type": "path", "description": "The template name needed for this REST call" } ] }, "docs": "Transcoder template action. This API is available in builds 15089 or later." }, { "info": { "name": "Get transcoder template config (adv)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "docs": "Retrieves the advanced transcoder template configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder template config (adv)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ], "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 decoder config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "docs": "Retrieves the specified transcoder overlay decode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder overlay decoder config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ], "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 decoder config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "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/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" } ] }, "docs": "Retrieves the list of transcoder encode configurations for the specified vhost. 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/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a transcoder encode configuration to the specified vhost. 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/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" } ] }, "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/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" } ], "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/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" } ], "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/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" } ] }, "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/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" } ] }, "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/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" } ], "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 config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "docs": "Retrieves the specified transcoder overlay encode configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update transcoder overlay encoder config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ], "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 config", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/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" } ] }, "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/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" } ] }, "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/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" } ], "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/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" } ] }, "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/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" } ], "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/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" } ], "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/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" } ] }, "docs": "Deletes the specified transcoder stream name group configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Get tuning config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/tune", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ] }, "docs": "Retrieves the tuning configuration for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Update tuning config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/tune", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the tuning configuration for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Get host port config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/tunehostports", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ] }, "docs": "Retrieves the host port configuration used for server tuning for the specified vhost. This API is available in builds 15089 or later." }, { "info": { "name": "Update host port config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/vhosts/:vhostName/tunehostports", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "vhostName", "value": "", "type": "path", "description": "The vhost name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the host port configuration used for server tuning for the specified vhost. This API is available in builds 15089 or later." } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Get webhook config", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/webhooks", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Get all webhooks configuration. This API is available in builds 15089 or later." }, { "info": { "name": "Update webhook config", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/webhooks", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace the full webhooks JSON. This API is available in builds 15089 or later." }, { "info": { "name": "Get filter list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/filters", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "List all filters. This API is available in builds 15089 or later." }, { "info": { "name": "Create filter list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/filters", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of filters. This API is available in builds 15089 or later." }, { "info": { "name": "Get filter", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/filters/:id", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "id", "value": "", "type": "path", "description": "Filter id" } ] }, "docs": "Get filter. This API is available in builds 15089 or later." }, { "info": { "name": "Update filter", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/filters/:id", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "id", "value": "", "type": "path", "description": "Filter id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create/replace filter. This API is available in builds 15089 or later." }, { "info": { "name": "Delete filter", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/filters/:id", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "id", "value": "", "type": "path", "description": "Filter id" } ] }, "docs": "Delete filter. This API is available in builds 15089 or later." }, { "info": { "name": "Get source", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/source", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "Get source. This API is available in builds 15089 or later." }, { "info": { "name": "Update source", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/source", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create/replace source. This API is available in builds 15089 or later." }, { "info": { "name": "Get target list", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/targets", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ] }, "docs": "List all targets. This API is available in builds 15089 or later." }, { "info": { "name": "Create target list", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/targets", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of targets. This API is available in builds 15089 or later." }, { "info": { "name": "Get target", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/targets/:id", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "id", "value": "", "type": "path", "description": "Target id" } ] }, "docs": "Get target. This API is available in builds 15089 or later." }, { "info": { "name": "Update target", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/targets/:id", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "id", "value": "", "type": "path", "description": "Target id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create/replace target. This API is available in builds 15089 or later." }, { "info": { "name": "Delete target", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8087/v2/servers/:serverName/webhooks/targets/:id", "params": [ { "name": "serverName", "value": "", "type": "path", "description": "Reserved for future use" }, { "name": "id", "value": "", "type": "path", "description": "Target id" } ] }, "docs": "Delete target. This API is available in builds 15089 or later." } ] } ], "bundled": true }