openapi: 3.0.3 info: title: Wowza Streaming Engine REST advanced_token_authentication Applications API description: Complete REST API for Wowza Streaming Engine. Auto-converted from Swagger 1.2 (http://localhost:8089/swagger.json) to OpenAPI 3.0.3 for public documentation. version: 2.0.0 contact: name: Wowza Media Systems url: https://www.wowza.com/docs/wowza-streaming-engine-rest-api license: name: Wowza Media Systems url: https://www.wowza.com servers: - url: http://localhost:8087 description: Wowza Streaming Engine Server security: - basicAuth: [] tags: - name: Applications description: '' paths: /v2/servers/{serverName}/vhosts/{vhostName}/applications: get: tags: - Applications operationId: getApplicationsConfig summary: Get app list description: Retrieves the list of applications for the specified vhost. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ApplicationsConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postApplicationsConfig summary: Update app list description: Adds an application to the list of applications for the specified vhost. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}: get: tags: - Applications operationId: getApplicationConfig summary: Get app config description: Retrieves the specified application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ApplicationConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postApplicationConfig summary: Create app config description: Adds the specified application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putApplicationConfig summary: Update app config description: Updates the specified application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteApplicationConfig summary: Delete app config description: Deletes the specified application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/actions/{action}: put: tags: - Applications operationId: putApplicationAction summary: Application actions description: Start, copy, restart, or shutdown an application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - copy - restart - shutdown - start - name: dstEntryName in: query required: false description: 'The destination application name when copying ' schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/adv: get: tags: - Applications operationId: getApplicationConfigAdv summary: Get app config (adv) description: Retrieves the specified advanced application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ApplicationConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putApplicationConfigAdv summary: Update app config (adv) description: Updates the specified advanced application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postApplicationConfigAdv summary: Create app config (adv) description: Adds the specified advanced application configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm: get: tags: - Applications operationId: getDRMConfig summary: Get DRM config description: Retrieves the Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DRMConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putDRMConfig summary: Update DRM config description: Updates the Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DRMConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/adv: get: tags: - Applications operationId: getDRMConfigAdv summary: Get DRM config (adv) description: Retrieves the advanced Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DRMConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putDRMConfigAdv summary: Update DRM config (adv) description: Updates the advanced Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DRMConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/buydrmmapfile: get: tags: - Applications operationId: getBuyDRMStreamMapsConfig summary: Get BuyDRM mapfile description: Retrieves the BuyDRM stream mapfile for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BuyDRMStreamMapsConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putBuyDRMStreamMapsConfig summary: Update BuyDRM mapfile description: Updates the BuyDRM stream mapfile for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BuyDRMStreamMapsConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/verimatrixmapfile: get: tags: - Applications operationId: getVerimatrixStreamMapsConfig summary: Get Verimatrix mapfile description: Retrieves the Verimatrix stream mapfile for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VerimatrixStreamMapsConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putVerimatrixStreamMapsConfig summary: Update Verimatrix mapfile description: Updates the Verimatrix stream mapfile for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VerimatrixStreamMapsConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/dvr: get: tags: - Applications operationId: getDVRConfig summary: Get DVR config description: Retrieves the DVR configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DVRConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putDVRConfig summary: Update DVR config description: Updates the DVR configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DVRConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/dvr/adv: get: tags: - Applications operationId: getDVRConfigAdv summary: Get DVR config (adv) description: Retrieves the advanced DVR configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DVRConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putDVRConfigAdv summary: Update DVR config (adv) description: Updates the advanced DVR configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DVRConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances: get: tags: - Applications operationId: getInstancesConfig summary: Get instance list description: Retrieves the list of instances for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InstancesConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}: get: tags: - Applications operationId: getInstanceConfig summary: Get instance config description: Retrieves the specified application instance information. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InstanceConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/actions/{action}: put: tags: - Applications operationId: putInstanceAction summary: Instance actions description: This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - start - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores: get: tags: - Applications operationId: getDvrRESTConverterStores summary: Get DVR store list description: Retrieves the list of DVR stores associated with this application instance. This API is available in builds 15942 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DvrRESTConverterStores' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores/actions/{action}: put: tags: - Applications operationId: putDvrRESTConverterStoresAction summary: DVR stores actions description: DVR REST converter store actions. This API is available in builds 15942 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string - name: dvrConverterDefaultFileDestination in: query required: false description: The file location to use when converting a nDVR store, the default is configured as the StorageDir in the application in use schema: type: string - name: dvrConverterDebugConversions in: query required: false description: Indicates if the conversion should have debugging enabled, can be true or false, default is false schema: type: string - name: dvrConverterContinueOnSourceErrors in: query required: false description: Indicates if the conversion should continue even if errors are detected, can be true or false, default is true schema: type: string - name: dvrConverterAudioVideoSyncEnable in: query required: false 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 schema: type: string - name: dvrConverterAudioVideoMaxOffset in: query required: false description: Indicates the maximum audio/video timecodes can be out of sync schema: type: string default: '200' - name: dvrConverterAudioVideoMaxBuffer in: query required: false description: Indicates the maximum time a correct audio/video sync will be searched for before giving up schema: type: string default: '8000' - name: dvrConverterStartTime in: query required: false description: A start time in UTC from where the conversion should start in the store, default is the first entry in the store schema: type: string - name: dvrConverterEndTime in: query required: false description: A end time in UTC where the conversion should end in the store, default is to the end of the store schema: type: string - name: dvrConverterDuration in: query required: false 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 schema: type: string - name: dvrConverterOutputFilename in: query required: false description: Indicates the output filename if not using the default, which is the name of the store being converted schema: type: string - name: dvrConverterStoreList in: query required: false description: The comma-separated list of stores to convert schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores/{dvrStoreName}: get: tags: - Applications operationId: getDvrRESTConverterStore summary: Get DVR store info description: Retrieves the information about a store/converter associated with the application instance. This API is available in builds 15942 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ - name: dvrStoreName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DvrRESTConverterStore' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores/{dvrStoreName}/actions/{action} : put: tags: - Applications operationId: putDvrRESTConverterStoreAction summary: DVR actions description: DVR REST converter store action. This API is available in builds 15942 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ - name: dvrStoreName in: path required: true description: The nDVR store name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}: get: tags: - Applications operationId: getIncomingStreamConfig summary: Get incoming stream info description: Retrieves the incoming stream information for the specified Incoming Stream. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ - name: streamName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/IncomingStreamConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/actions/{action} : put: tags: - Applications operationId: putIncomingStreamAction summary: Incoming stream actions description: Disconnect or reset an incoming stream. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - disconnectStream - resetStream - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ - name: streamName in: path required: true description: The stream name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/encoder/live : get: tags: - Applications operationId: getLiveEncoderConfig summary: Get live encoder config description: Retrieves the live encoder configuration for the specified incoming stream. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ - name: streamName in: path required: true schema: type: string - name: publishUser in: query required: true description: The publish username to use in the encoder configuration schema: type: string - name: publishHost in: query required: true description: The IP address then encoder will publish to schema: type: string - name: publishPort in: query required: true description: The Port number the encoder will publish to schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LiveEncoderConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/encoder/shorturl : get: tags: - Applications operationId: getShortUrlEncoderConfig summary: Get live encoder short URL description: Retrieves the short URL for the live encoder configuration for the specified incoming stream. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ - name: streamName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ShortUrlEncoderConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/monitoring/current : get: tags: - Applications operationId: getCurrentIncomingStreamStatistics summary: Get current incoming stream stats description: Retrieves the current incoming stream statistics for the specified incoming stream. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ - name: streamName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CurrentIncomingStreamStatistics' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/sourcecontrol : get: tags: - Applications operationId: getSourceControlConfig summary: Get source control info description: Gets information about the source control and its supported features. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ - name: streamName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SourceControlConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/sourcecontrol/actions/{action} : put: tags: - Applications operationId: putSourceControlAction summary: Source control actions description: Source control action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - captureImage - panTilt - zoom - name: vhostName in: path required: true description: The VHost name schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name schema: type: string - name: instanceName in: path required: true description: The application instance name schema: type: string default: _definst_ - name: streamName in: path required: true description: The Stream name schema: type: string - name: direction in: query required: false 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' schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/mediacache/stores/actions/{action} : put: tags: - Applications operationId: putMediaCacheApplicationStoreAction summary: Media cache store actions description: Media cache application store action. This API is available in builds 15942 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string - name: filename in: query required: false description: The file or stream name item to be used in all rest action requests schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamgroups: get: tags: - Applications operationId: getStreamGroupsConfig summary: Get stream group list description: Retrieves the list of stream groups for the specified application instance. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamGroupsConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamgroups/{groupName}: get: tags: - Applications operationId: getStreamGroupConfig summary: Get stream group config description: Retrieves the specified StreamGroup configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: groupName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamGroupConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamgroups/{groupName}/actions/{action} : put: tags: - Applications operationId: putStreamGroupAction summary: Stream group actions description: Stream Group Action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - disconnectGroup - removeGroup - resetGroup - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ - name: groupName in: path required: true description: The group name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders: get: tags: - Applications operationId: getStreamRecordersConfig summary: Get stream recorders list description: Retrieves the list of stream recorders for the specified application instance. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamRecordersConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postStreamRecordersConfig summary: Create stream recorder description: Creates a new stream recorder in the specified application instance and starts recording. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRecorderConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders/{recorderName}: get: tags: - Applications operationId: getStreamRecorderConfig summary: Get stream recorder description: Retrieves the specified stream recorder. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: recorderName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamRecorderConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postStreamRecorderConfig summary: Create stream recorder description: Creates a new stream recorder and starts recording. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: recorderName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRecorderConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders/{recorderName}/actions/{action} : put: tags: - Applications operationId: putStreamRecorderAction summary: Stream recorder actions description: Stream recorder action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - splitRecording - stopRecording - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: instanceName in: path required: true description: The application instance name needed for this REST call schema: type: string default: _definst_ - name: recorderName in: path required: true description: The recorder name (stream name) needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders/{recorderName}/default : get: tags: - Applications operationId: getDefaultStreamRecorderConfig summary: Get stream recorder description: Retrieves a stream recorder of the requested name, populated with the default values. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: recorderName in: path required: true schema: type: string - name: instanceName in: path required: true schema: type: string default: _definst_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DefaultStreamRecorderConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/modules: get: tags: - Applications operationId: getModulesConfig summary: Get module list description: Retrieves the list of modules for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ModulesConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putModulesConfig summary: Update module list description: Updates the list of modules for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ModulesConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/monitoring/current: get: tags: - Applications operationId: getCurrentApplicationStatistics summary: Get current app stats description: Retrieves the current application statistics. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CurrentApplicationStatistics' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/monitoring/historic: get: tags: - Applications operationId: getHistoricApplicationStatistics summary: Get historic app stats description: Retrieves the historic application statistics. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/HistoricApplicationStatistics' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/publishers: get: tags: - Applications operationId: getPublishersAppConfig summary: Get publisher list description: Retrieves the list of publishers for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The vhost name schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PublishersAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postPublishersAppConfig summary: Update publisher list description: Add a publisher to list of publishers for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The vhost name schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublisherAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/publishers/{publisherName}: get: tags: - Applications operationId: getPublisherAppConfig summary: Get publisher config description: Retrieves the specified publisher configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The vhost name schema: type: string default: _defaultVHost_ - name: publisherName in: path required: true description: The publisher name schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PublisherAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putPublisherAppConfig summary: Update publisher config description: Updates the specified publisherconfiguration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The vhost name schema: type: string default: _defaultVHost_ - name: publisherName in: path required: true description: The publisher name schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublisherAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postPublisherAppConfig summary: Create publisher config description: Adds the specified publisherconfiguration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The vhost name schema: type: string default: _defaultVHost_ - name: publisherName in: path required: true description: The publisher name schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublisherAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deletePublisherAppConfig summary: Delete publisher config description: Deletes the specified publisher configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The vhost name schema: type: string default: _defaultVHost_ - name: publisherName in: path required: true description: The publisher name schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/pushpublish/mapentries: get: tags: - Applications operationId: getPushPublishStreamsAppConfig summary: Get push publish map description: Retrieves the list of PushPublish map entries for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PushPublishStreamsAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putPushPublishStreamsAppConfig summary: Update push publish map description: Push publish streams app config. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PushPublishStreamAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postPushPublishStreamsAppConfig summary: Add entry to push publish map description: 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. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PushPublishStreamAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/pushpublish/mapentries/{entryName}: get: tags: - Applications operationId: getPushPublishStreamAppConfig summary: Get push publish map entry description: Retrieves the specified push publish map entry's configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: entryName in: path required: true description: The entry name needed for this REST call schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PushPublishStreamAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putPushPublishStreamAppConfig summary: Update push publish map entry description: Updates the specified push publish map entry's configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: entryName in: path required: true description: The entry name needed for this REST call schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PushPublishStreamAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postPushPublishStreamAppConfig summary: Create push publish map entry description: Adds the specified push publish map entry for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: entryName in: path required: true description: The entry name needed for this REST call schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PushPublishStreamAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deletePushPublishStreamAppConfig summary: Delete push publish map entry description: Deletes the specified push publish map entry for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string - name: entryName in: path required: true description: The entry name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/pushpublish/mapentries/{entryName}/actions/{action}: put: tags: - Applications operationId: putPushPublishStreamAppAction summary: Push publish actions description: Push publish stream app action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - copy - disable - enable - restart - name: dstEntryName in: query required: false description: 'The destination entryName when copying ' schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: entryName in: path required: true description: The map entry name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/pushpublish/providers: get: tags: - Applications operationId: getPushPublishCloudStorageProvidersConfig summary: Get push publish cloud storage provider list description: Retrieves a list of push publish cloud storage providers. This API is under development, do not use. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PushPublishCloudStorageProvidersConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/sdpfiles: get: tags: - Applications operationId: getSDPFilesAppConfig summary: Get SDP files description: Retrieves the list of SDP Files for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SDPFilesAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/sdpfiles/{sdpfileName}: delete: tags: - Applications operationId: deleteSDPFileAppConfig summary: Delete SDP file description: Deletes the specified SDP file. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: sdpfileName in: path required: true description: The SDP file name without the extension schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/sdpfiles/{sdpfileName}/actions/{action}: put: tags: - Applications operationId: putSDPFileAppAction summary: SDP file actions description: SDP file app action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - connect - name: connectAppName in: query required: false description: The name of the application to connect to schema: type: string - name: appInstance in: query required: false description: The name of the application instance to connect to schema: type: string - name: mediaCasterType in: query required: true description: 'The MediaCasterType to use for the connection ' schema: type: string enum: - rtp - ' rtp-record' - shoutcast - shoutcast-record - liverepeater default: rtp - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: sdpfileName in: path required: true description: The sdp file name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/security: get: tags: - Applications operationId: getSecurityConfig summary: Get security config description: Retrieves the security configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SecurityConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putSecurityConfig summary: Update security config description: Updates the security configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SecurityConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles: get: tags: - Applications operationId: getSMILFilesAppConfig summary: Get SMIL file list description: Retrieves the list of SMIL Files for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SMILFilesAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postSMILFilesAppConfig summary: Update SMIL file list description: Adds an SMIL file to the list of SMIL files for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SMILFileAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles/{smilfileName}: get: tags: - Applications operationId: getSMILFileAppConfig summary: Get SMIL file description: Retrieves the specified SMIL file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: smilfileName in: path required: true description: The SMIL file name without the extension schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SMILFileAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteSMILFileAppConfig summary: Delete SMIL file description: Deletes the specified SMIL file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: smilfileName in: path required: true description: The SMIL file name without the extension schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putSMILFileAppConfig summary: Update SMIL file description: Updates the specified SMIL file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: smilfileName in: path required: true description: The SMIL file name without the extension schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SMILFileAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postSMILFileAppConfig summary: Create SMIL file description: Adds the specified SMIL file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: smilfileName in: path required: true description: The SMIL file name without the extension schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SMILFileAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles/{smilfileName}/actions/{action}: put: tags: - Applications operationId: putSMILFileAppAction summary: SMIL file actions description: SMIL file app action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - connect - copy - name: connectAppName in: query required: false description: The name of the application to connect to schema: type: string - name: appInstance in: query required: false description: The name of the application instance to connect to schema: type: string - name: mediaCasterType in: query required: true description: 'The MediaCasterType to use for the connection ' schema: type: string enum: - rtp - ' rtp-record' - shoutcast - shoutcast-record - liverepeater default: rtp - name: dstEntryName in: query required: false description: 'The destination SMIL file name when copying ' schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: smilfileName in: path required: true description: The SMIL file name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamconfiguration: get: tags: - Applications operationId: getStreamConfigurationConfig summary: Get stream config description: Retrieves the stream configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamConfigurationConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putStreamConfigurationConfig summary: Update stream config description: Updates the Stream configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamConfigurationConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamfiles: get: tags: - Applications operationId: getStreamFilesAppConfig summary: Get stream file list description: Retrieves the list of stream files for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamFilesAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postStreamFilesAppConfig summary: Update stream file list description: Adds a stream file to the list of stream files for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamFileAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamfiles/{streamfileName}: get: tags: - Applications operationId: getStreamFileAppConfig summary: Get stream file config description: Retrieves the specified stream file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: streamfileName in: path required: true description: The stream file name without the extension schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamFileAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteStreamFileAppConfig summary: Delete stream file config description: Deletes the specified stream file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: streamfileName in: path required: true description: The stream file name without the extension schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putStreamFileAppConfig summary: Update stream file config description: Updates the specified stream file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: streamfileName in: path required: true description: The stream file name without the extension schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamFileAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postStreamFileAppConfig summary: Create stream file config description: Adds the specified stream file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: streamfileName in: path required: true description: The stream file name without the extension schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamFileAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamfiles/{streamfileName}/actions/{action}: put: tags: - Applications operationId: putStreamFileAppAction summary: Stream file actions description: Stream file app action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - connect - copy - name: connectAppName in: query required: false description: The name of the application to connect to schema: type: string - name: appInstance in: query required: false description: The name of the application instance to connect to schema: type: string - name: mediaCasterType in: query required: true description: 'The MediaCasterType to use for the connection ' schema: type: string enum: - rtp - ' rtp-record' - shoutcast - shoutcast-record - liverepeater default: rtp - name: dstEntryName in: query required: false description: 'The destination stream file name when copying ' schema: type: string - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: streamfileName in: path required: true description: The stream file, file name needed for this REST call schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamfiles/{streamfileName}/adv: get: tags: - Applications operationId: getStreamFileAppConfigAdv summary: Get stream file config (adv) description: Retrieves the advanced stream file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: streamfileName in: path required: true description: The stream file name without the .stream extension schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StreamFileAppConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putStreamFileAppConfigAdv summary: Update stream file config (adv) description: Updates the advanced stream file configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: streamfileName in: path required: true description: The stream file name without the .stream extension schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamFileAppConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder: get: tags: - Applications operationId: getTranscoderAppConfig summary: Get transcoder config description: Retrieves the transcoder configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderAppConfig summary: Update transcoder config description: Updates the transcoder configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/adv: get: tags: - Applications operationId: getTranscoderAppConfigAdv summary: Get transcoder config (adv) description: Retrieves the advanced transcoder configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderAppConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderAppConfigAdv summary: Update transcoder config (adv) description: Updates the advanced transcoder configuration for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderAppConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates: get: tags: - Applications operationId: getTranscoderTemplatesAppConfig summary: Get transcoder template list description: Retrieves the list of transcoder template configurations for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplatesAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postTranscoderTemplatesAppConfig summary: Update transcoder template list description: Adds a transcoder templates configuration to the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplateAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}: get: tags: - Applications operationId: getTranscoderTemplateAppConfig summary: Get transcoder template description: Retrieves the specified transcoder template configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplateAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderTemplateAppConfig summary: Update transcoder template description: Updates the specified transcoder template configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplateAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postTranscoderTemplateAppConfig summary: Create transcoder template description: Adds the specified transcoder template configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplateAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteTranscoderTemplateAppConfig summary: Delete transcoder template description: Deletes the specified transcoder template configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/actions/{action}: put: tags: - Applications operationId: putTranscoderTemplateAppAction summary: Transcoder template actions description: Transcoder template app action. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: action in: path required: true description: The action which should be performed by the server schema: type: string enum: - copy - name: vhostName in: path required: true description: The name of the current VHost the action will be performed on schema: type: string default: _defaultVHost_ - name: appName in: path required: true description: The application name needed for this REST call schema: type: string - name: templateName in: path required: true description: The template name needed for this REST call schema: type: string - name: dstEntryName in: query required: false description: 'The destination transcode template file name when copying ' schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/adv: get: tags: - Applications operationId: getTranscoderTemplateAppConfigAdv summary: Get transcoder template (adv) description: Retrieves the advanced transcoder template configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplateAppConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderTemplateAppConfigAdv summary: Update transcoder template (adv) description: Updates the advanced transcoder template configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderTemplateAppConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/decode/overlays/{overlayName} : get: tags: - Applications operationId: getTranscoderOverlayDecodeAppConfig summary: Get transcoder overlay decode config description: Retrieves the specified transcoder overlay decode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: overlayName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderOverlayDecodeAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderOverlayDecodeAppConfig summary: Update transcoder overlay decode config description: Updates the specified transcoder overlay decode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: overlayName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderOverlayDecodeAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteTranscoderOverlayDecodeAppConfig summary: Delete transcoder overlay decode config description: Deletes the specified transcoder overlay decode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: overlayName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes: get: tags: - Applications operationId: getTranscoderEncodesAppConfig summary: Get transcoder encoder list description: Retrieves the list of transcoder encode configurations for the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodesAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postTranscoderEncodesAppConfig summary: Update transcoder encoder list description: Adds a transcoder encode configuration to the specified application. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodeAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes/{encodeName} : get: tags: - Applications operationId: getTranscoderEncodeAppConfig summary: Get transcoder encoder config description: Retrieves the specified transcoder encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodeAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postTranscoderEncodeAppConfig summary: Create transcoder encoder config description: Adds the specified transcoder encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodeAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderEncodeAppConfig summary: Update transcoder encoder config description: Updates the specified transcoder encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodeAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteTranscoderEncodeAppConfig summary: Delete transcoder encoder config description: Deletes the specified transcoder encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes/{encodeName}/adv : get: tags: - Applications operationId: getTranscoderEncodeAppConfigAdv summary: Get transcoder encoder config (adv) description: Retrieves the advanced transcoder encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodeAppConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderEncodeAppConfigAdv summary: Update transcoder encoder config (adv) description: Updates the advanced transcoder encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderEncodeAppConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName} : get: tags: - Applications operationId: getTranscoderOverlayEncodeAppConfig summary: Get transcoder overlay encoder description: Retrieves the specified transcoder overlay encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: overlayName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderOverlayEncodeAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderOverlayEncodeAppConfig summary: Update transcoder overlay encoder description: Updates the specified transcoder overlay encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: overlayName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderOverlayEncodeAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteTranscoderOverlayEncodeAppConfig summary: Delete transcoder overlay encoder description: Deletes the specified transcoder overlay encode configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: overlayName in: path required: true schema: type: string - name: encodeName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/streamnamegroups: get: tags: - Applications operationId: getTranscoderStreamNameGroupsAppConfig summary: Get transcoder stream name group list description: Retrieves the list of transcoder stream name groups for the specified template. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderStreamNameGroupsAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postTranscoderStreamNameGroupsAppConfig summary: Update transcoder stream name group list description: Adds a transcoder stream name groups configuration to the specified template. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderStreamNameGroupAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error ? /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/streamnamegroups/{groupName} : get: tags: - Applications operationId: getTranscoderStreamNameGroupAppConfig summary: Get transcoder stream name group config description: Retrieves the specified transcoder stream name group configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: groupName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TranscoderStreamNameGroupAppConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error post: tags: - Applications operationId: postTranscoderStreamNameGroupAppConfig summary: Create transcoder stream name group config description: Adds the specified transcoder stream name group configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: groupName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderStreamNameGroupAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putTranscoderStreamNameGroupAppConfig summary: Update transcoder stream name group config description: Updates the specified transcoder stream name group configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: groupName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TranscoderStreamNameGroupAppConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error delete: tags: - Applications operationId: deleteTranscoderStreamNameGroupAppConfig summary: Delete transcoder stream name group config description: Deletes the specified transcoder stream name group configuration. This API is available in builds 15089 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: templateName in: path required: true schema: type: string - name: groupName in: path required: true schema: type: string - name: appName in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/webrtc: get: tags: - Applications operationId: getWebRTCConfig summary: Get WEBRTC config description: Retrieves the WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/WebRTCConfig' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putWebRTCConfig summary: Update WebRTC config description: Updates the WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebRTCConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/webrtc/adv: get: tags: - Applications operationId: getWebRTCConfigAdv summary: Get WebRTC config (adv) description: Retrieves the advanced WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/WebRTCConfigAdv' '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error put: tags: - Applications operationId: putWebRTCConfigAdv summary: Update WebRTC config (adv) description: Updates the advanced WebRTC configuration for the specified application. This API is available in builds 20180816154459 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebRTCConfigAdv' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/wscrestproxy: post: tags: - Applications operationId: postWSCRESTProxyConfig summary: Create WSC proxy request description: Proxies a WSC REST API request. This API is available in builds 19950 or later. parameters: - name: serverName in: path required: true description: Reserved for future use schema: type: string default: _defaultServer_ - name: vhostName in: path required: true schema: type: string default: _defaultVHost_ - name: appName in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WSCRESTProxyConfig' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error components: schemas: VideoSettings: type: object properties: framerate: type: number format: double width: type: integer format: int32 bitrate: type: integer format: int32 height: type: integer format: int32 required: - framerate - width - height - bitrate ShortObject: type: object properties: id: type: string href: type: string required: - id - href ShortUrlEncoderConfig: type: object properties: statusText: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string url: type: string statusCode: $ref: '#/components/schemas/Integer' required: - version - serverName - url - statusText - statusCode TranscoderEncodeAppConfig: type: object properties: followSource: type: boolean implementation: type: string gpuid: type: integer format: int32 profile: type: string serverName: type: string description: type: string audioCodec: type: string version: type: string streamName: type: string Overlays: type: array items: $ref: '#/components/schemas/TranscoderOverlayEncodeConfig' audioBitrate: type: string videoBitrate: type: string enable: type: boolean name: type: string width: type: integer format: int32 interval: type: integer format: int32 fitMode: type: string saveFieldList: type: array items: type: string crop: type: string convert8bit: type: boolean videoCodec: type: string height: type: integer format: int32 sourceRectangle: type: string required: - version - serverName - name - enable - description - streamName - videoCodec - implementation - gpuid - profile - videoBitrate - followSource - interval - fitMode - width - height - crop - sourceRectangle - audioCodec - audioBitrate - Overlays - convert8bit SMILFileStreamConfig: type: object properties: systemLanguage: type: string dur: type: string ngrp: type: string keyFrameOnly: type: string src: type: string systemBitrate: type: string serverName: type: string videoCodecId: type: string type: type: string version: type: string audioBitrate: type: string audioCodecId: type: string videoBitrate: type: string isWowzaCaptionStream: type: string videoOnly: type: string audioOnly: type: string width: type: string saveFieldList: type: array items: type: string idx: type: integer format: int32 begin: type: string wowzaCaptionIngestType: type: string height: type: string required: - version - serverName - idx - type - src - systemLanguage - systemBitrate - width - height - begin - dur - videoBitrate - videoCodecId - videoOnly - ngrp - audioBitrate - audioCodecId - audioOnly - keyFrameOnly - isWowzaCaptionStream - wowzaCaptionIngestType ApplicationsConfig: type: object properties: serverName: type: string saveFieldList: type: array items: type: string version: type: string applications: type: array items: $ref: '#/components/schemas/AppShortObject' required: - version - serverName - applications ApplicationConfig: type: object properties: httpOptimizeFileReads: type: boolean captionLiveIngestType: type: string streamConfig: $ref: '#/components/schemas/StreamConfigurationConfig' serverName: type: string description: type: string closedCaptionLiveOutput608Enabled: type: boolean webRTCConfig: $ref: '#/components/schemas/WebRTCConfig' mediaCacheSourceList: type: array items: type: string repeaterOriginURL: type: string clientStreamReadAccess: type: string appType: type: string pingTimeout: type: integer format: int32 vodTimedTextProviders: type: array items: type: string saveFieldList: type: array items: type: string mediaReaderRandomAccessReaderClass: type: string mediaReaderBufferSeekIO: type: boolean httpStreamers: type: array items: type: string httpCORSHeadersEnabled: type: boolean closedCaptionLiveOutput708Enabled: type: boolean avSyncMethod: type: string transcoderConfig: $ref: '#/components/schemas/TranscoderAppConfig' clientStreamWriteAccess: type: string repeaterQueryString: type: string drmConfig: $ref: '#/components/schemas/DRMConfig' version: type: string modules: $ref: '#/components/schemas/ModulesConfig' srtListenerAuthenticationMode: type: string maxRTCPWaitTime: type: integer format: int32 securityConfig: $ref: '#/components/schemas/SecurityConfig' dvrConfig: $ref: '#/components/schemas/DVRConfig' applicationTimeout: type: integer format: int32 name: type: string required: - version - serverName - name - appType - description - applicationTimeout - pingTimeout - repeaterOriginURL - repeaterQueryString - clientStreamReadAccess - clientStreamWriteAccess - avSyncMethod - maxRTCPWaitTime - httpCORSHeadersEnabled - httpStreamers - mediaCacheSourceList - mediaReaderRandomAccessReaderClass - httpOptimizeFileReads - mediaReaderBufferSeekIO - captionLiveIngestType - closedCaptionLiveOutput608Enabled - closedCaptionLiveOutput708Enabled - srtListenerAuthenticationMode - vodTimedTextProviders - securityConfig - streamConfig - dvrConfig - drmConfig - transcoderConfig - webRTCConfig - modules WebRTCConfig: type: object properties: udpBindAddress: type: string enablePlay: type: boolean preferredCodecsAudio: type: string preferredCodecsVideo: type: string enableQuery: type: boolean debugLog: type: boolean serverName: type: string saveFieldList: type: array items: type: string iceCandidateIpAddresses: type: string version: type: string enablePublish: type: boolean required: - version - serverName - enablePublish - enablePlay - enableQuery - iceCandidateIpAddresses - udpBindAddress - preferredCodecsAudio - preferredCodecsVideo - debugLog PushPublishStreamsAppConfig: type: object properties: mapEntries: type: array items: $ref: '#/components/schemas/PushPublishStreamAppConfig' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - mapEntries VerimatrixStreamMapsConfig: type: object properties: filename: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string verimatrixStreamMaps: type: array items: type: string required: - version - serverName - filename - verimatrixStreamMaps TranscoderTemplatesAppConfig: type: object properties: vhostName: type: string templates: type: array items: $ref: '#/components/schemas/ShortObject' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - vhostName - templates StreamGroupsConfig: type: object properties: instanceName: type: string serverName: type: string streamGroups: type: array items: $ref: '#/components/schemas/StreamGroupConfig' saveFieldList: type: array items: type: string version: type: string required: - version - serverName - instanceName - streamGroups ModuleConfig: type: object properties: name: type: string serverName: type: string description: type: string saveFieldList: type: array items: type: string version: type: string class: type: string order: type: integer format: int32 required: - version - serverName - order - name - description - class InstanceConfig: type: object properties: incomingStreams: type: array items: $ref: '#/components/schemas/IncomingStreamConfig' name: type: string outgoingStreams: type: array items: $ref: '#/components/schemas/OutgoingStreamConfig' serverName: type: string streamGroups: type: array items: $ref: '#/components/schemas/StreamGroupConfig' saveFieldList: type: array items: type: string version: type: string recorders: type: array items: $ref: '#/components/schemas/StreamRecorderConfig' required: - version - serverName - name - incomingStreams - outgoingStreams - recorders - streamGroups TranscoderTemplatesConfig: type: object properties: vhostName: type: string templates: type: array items: $ref: '#/components/schemas/ShortObject' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - vhostName - templates PushPublishCloudStorageProvidersConfig: type: object properties: serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - providers HistoricApplicationStatistics: type: object properties: serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - entries WebRTCConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - advancedSettings DVRConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - advancedSettings DRMConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - advancedSettings PublishersAppConfig: type: object properties: serverName: type: string publishers: type: array items: $ref: '#/components/schemas/PublisherVhostConfig' saveFieldList: type: array items: type: string version: type: string required: - version - serverName - publishers DvrRESTConverterStore: type: object properties: dvrStoreName: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string DvrConverterStore: type: string required: - version - serverName - dvrStoreName - DvrConverterStore TranscoderTemplateAppConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' name: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - advancedSettings - name StreamFilesAppConfig: type: object properties: serverName: type: string streamFiles: type: array items: $ref: '#/components/schemas/ShortObject' saveFieldList: type: array items: type: string version: type: string required: - version - serverName - streamFiles TranscoderAppConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - advancedSettings Long: type: object properties: {} TranscoderAppConfig: type: object properties: profileDir: type: string licensed: type: boolean templates: $ref: '#/components/schemas/TranscoderTemplatesConfig' available: type: boolean serverName: type: string templateDir: type: string version: type: string createTemplateDir: type: boolean licenses: type: integer format: int32 liveStreamTranscoder: type: string templatesInUse: type: string licensesInUse: type: integer format: int32 saveFieldList: type: array items: type: string required: - version - serverName - available - licensed - licenses - licensesInUse - templates - liveStreamTranscoder - templatesInUse - profileDir - templateDir - createTemplateDir TranscoderTemplateAppConfig: type: object properties: enableDynamicOverlays: type: boolean streamNameGroups: type: array items: $ref: '#/components/schemas/TranscoderStreamNameGroupConfig' implementationScale: type: string deinterlace: type: boolean implementation: type: string overlays: type: array items: $ref: '#/components/schemas/TranscoderOverlayDecodeConfig' name: type: string serverName: type: string description: type: string saveFieldList: type: array items: type: string encodes: type: array items: $ref: '#/components/schemas/TranscoderEncodeConfig' version: type: string required: - version - serverName - name - description - implementation - implementationScale - deinterlace - enableDynamicOverlays - encodes - streamNameGroups - overlays TranscoderStreamNameGroupAppConfig: type: object properties: name: type: string serverName: type: string description: type: string saveFieldList: type: array items: type: string version: type: string streamName: type: string Members: type: array items: $ref: '#/components/schemas/TranscoderMemberConfig' required: - version - serverName - name - description - streamName - Members InstancesConfig: type: object properties: instanceList: type: array items: $ref: '#/components/schemas/InstanceConfig' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - instanceList CurrentApplicationStatistics: type: object properties: totalConnections: $ref: '#/components/schemas/Long' bytesOutRate: type: integer format: int64 serverName: type: string saveFieldList: type: array items: type: string version: type: string uptime: $ref: '#/components/schemas/Long' bytesIn: $ref: '#/components/schemas/Long' bytesOut: $ref: '#/components/schemas/Long' bytesInRate: type: integer format: int64 required: - version - serverName - uptime - bytesIn - bytesOut - bytesInRate - bytesOutRate - totalConnections - connectionCount MpegTSFilter: type: object properties: name: type: string mpegtsProgramID: type: string mpegtsVideoPID: type: string mpegtsAudioPID: type: string required: - name - mpegtsProgramID - mpegtsVideoPID - mpegtsAudioPID DVRConfig: type: object properties: windowDuration: type: integer format: int32 dvrMediaCacheEnabled: type: boolean dvrEnable: type: boolean startRecordingOnStartup: type: boolean serverName: type: string store: type: string version: type: string recorders: type: string dvrOnlyStreaming: type: boolean httpRandomizeMediaName: type: boolean licenseType: type: string dvrEncryptionSharedSecret: type: string inUse: type: boolean archiveStrategy: type: string storageDir: type: string saveFieldList: type: array items: type: string required: - version - serverName - licenseType - inUse - dvrEnable - recorders - store - windowDuration - storageDir - archiveStrategy - dvrOnlyStreaming - startRecordingOnStartup - dvrEncryptionSharedSecret - dvrMediaCacheEnabled - httpRandomizeMediaName BuyDRMStreamMapsConfig: type: object properties: buyDRMStreamNameMapFile: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - buyDRMStreamNameMapFile - buyDRMStreamMaps PublisherVhostConfig: type: object properties: password: type: string publisherName: type: string serverName: type: string description: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - publisherName - description - password IncomingStreamConfig: type: object properties: ptzPollingIntervalMinimum: type: integer format: int32 applicationInstance: type: string isPTZEnabled: type: boolean isConnected: type: boolean serverName: type: string version: type: string ptzPollingInterval: type: integer format: int32 isRecordingSet: type: boolean sourceIp: type: string name: type: string isPublishedToVOD: type: boolean saveFieldList: type: array items: type: string isStreamManagerStream: type: boolean required: - version - serverName - applicationInstance - name - sourceIp - isRecordingSet - isStreamManagerStream - isPublishedToVOD - isConnected - isPTZEnabled - ptzPollingInterval - ptzPollingIntervalMinimum PushPublishStreamAppConfig: type: object properties: facebook.360Projection: type: string wowzaCloud.adaptiveStreaming: type: boolean icecast2.public: type: boolean akamai.destinationServer: type: string srtSendBufferSizeUDP: type: integer format: int32 mpegdash.audioRepresentationId: type: string wowzaCloud.accountId: type: string password: type: string srtFlightFlagSize: type: integer format: int32 wowzaVideo.region: type: string facebook.destType: type: string mpegdash.videoRepresentationId: type: string rtpWrap: type: boolean icecast2.name: type: string akamai.hostId: type: string connectionFlashVersion: type: string wowzaCloud.accountAccessKey: type: string group.name: type: string shoutcast.public: type: boolean shoutcast.aim: type: string profile: type: string facebook.continuousLive: type: boolean icecast2.genre: type: string queryString: type: string akamai.eventName: type: string version: type: string sendStreamCloseCommands: type: boolean icecast2.aim: type: string http.playlistCount: type: integer format: int32 srtSendBufferSize: type: integer format: int32 srtMaximumSegmentSize: type: integer format: int32 facebook.destName: type: string wowzaVideo.playbackUrl: type: string audioPort: type: string icecast2.metaname: type: string sourceStreamName: type: string connectionCode: type: string wowzaVideoTranscoder.region: type: string serverName: type: string adaptiveStreaming: type: boolean enabled: type: boolean srtTimesToPrintStats: type: integer format: int32 facebook.description: type: string debugLog: type: boolean srtInputBandwidth: type: integer format: int32 http.playlistAcrossSessions: type: boolean secureTokenSharedSecret: type: string srtKeyAnnounce: type: integer format: int32 wowzaCloud.targetId: type: string srtMaximumBandwidth: type: integer format: int32 http.fakePosts: type: boolean sendSSL: type: boolean icecast2.destination: type: string facebook.privacy: type: string adaptiveGroup: type: string akamai.sendToBackupServer: type: boolean srtOverheadBandwidth: type: integer format: int32 wowzaCloud.accountApiKey: type: string entryName: type: string appInstance: type: string originalTimecodeThreshold: type: string srtPassPhrase: type: string shoutcast.destination: type: string shoutcast.icq: type: string wowzaVideoTranscoder.height: type: integer format: int32 wowzaVideo.liveStreamEmbedCode: type: string wowzaVideoTranscoder.width: type: integer format: int32 timeToLive: type: integer format: int32 wowzaVideo.liveStreamPlayerUrl: type: string icecast2.icq: type: string host: type: string cupertino.renditions: type: string facebook.title: type: string group.streamMatcher: type: string debugPackets: type: boolean srtKeyLength: type: integer format: int32 playbackHost: type: string icecast2.description: type: string sessionStatus: type: string shoutcast.metaname: type: string facebook.destId: type: string shoutcast.name: type: string port: type: integer format: int32 srtTimestampBasedDeliveryMode: type: boolean sendFCPublish: type: boolean srtLatency: type: integer format: int32 wowzaVideo.streamTargetId: type: string childProfile: type: string http.playlistTimeout: type: integer format: int32 localBindAddress: type: string debugLogChildren: type: boolean wowzaCloud.playbackUrl: type: string srtTooLatePacketDrop: type: boolean shoutcast.irc: type: string facebook.useAppSecret: type: boolean sendReleaseStream: type: boolean shoutcast.url: type: string icecast2.irc: type: string shoutcast.genre: type: string akamai.streamId: type: string akamai.hdNetwork: type: boolean adaptiveGroups: type: string srtKeyRefreshRate: type: integer format: int32 saveFieldList: type: array items: type: string srtStreamId: type: string facebook.userName: type: string srtPeerIdleTimeout: type: integer format: int32 wowzaCloud.accountName: type: string srtMinimumVersion: type: integer format: int32 srtConnectTimeout: type: integer format: int32 sendOriginalTimecodes: type: boolean facebook.accessToken: type: string userName: type: string streamName: type: string removeDefaultAppInstance: type: boolean videoPort: type: string http.writerDebug: type: boolean icecast2.url: type: string destinationServer: type: string application: type: string wowzaVideo.liveStreamId: type: string streamWaitTimeout: type: integer format: int32 autoStartTranscoder: type: boolean sanjose.representationId: type: string required: - version - serverName - entryName - sessionStatus - enabled - autoStartTranscoder - sourceStreamName - profile - streamName - application - appInstance - host - playbackHost - port - userName - password - secureTokenSharedSecret - adaptiveStreaming - sendFCPublish - sendReleaseStream - sendStreamCloseCommands - removeDefaultAppInstance - sendOriginalTimecodes - originalTimecodeThreshold - connectionFlashVersion - queryString - localBindAddress - akamai.hdNetwork - akamai.streamId - akamai.sendToBackupServer - akamai.hostId - akamai.eventName - akamai.destinationServer - destinationServer - adaptiveGroups - adaptiveGroup - cupertino.renditions - sanjose.representationId - mpegdash.videoRepresentationId - mpegdash.audioRepresentationId - http.playlistCount - http.playlistAcrossSessions - http.playlistTimeout - http.fakePosts - http.writerDebug - videoPort - audioPort - streamWaitTimeout - timeToLive - rtpWrap - shoutcast.name - shoutcast.destination - shoutcast.url - shoutcast.metaname - shoutcast.genre - shoutcast.aim - shoutcast.irc - shoutcast.icq - shoutcast.public - icecast2.name - icecast2.destination - icecast2.description - icecast2.url - icecast2.metaname - icecast2.genre - icecast2.aim - icecast2.irc - icecast2.icq - icecast2.public - srtPassPhrase - srtKeyLength - srtLatency - srtTooLatePacketDrop - srtTimestampBasedDeliveryMode - srtSendBufferSize - srtSendBufferSizeUDP - srtMaximumSegmentSize - srtFlightFlagSize - srtMaximumBandwidth - srtInputBandwidth - srtOverheadBandwidth - srtConnectTimeout - srtMinimumVersion - srtStreamId - srtKeyRefreshRate - srtKeyAnnounce - srtPeerIdleTimeout - srtTimesToPrintStats - connectionCode - debugLogChildren - debugLog - debugPackets - sendSSL - facebook.userName - facebook.useAppSecret - facebook.accessToken - facebook.title - facebook.description - facebook.privacy - facebook.destId - facebook.destType - facebook.destName - facebook.continuousLive - facebook.360Projection - wowzaCloud.accountName - wowzaCloud.accountId - wowzaCloud.accountApiKey - wowzaCloud.accountAccessKey - wowzaCloud.targetId - wowzaCloud.playbackUrl - wowzaVideo.playbackUrl - wowzaVideo.streamTargetId - wowzaVideo.region - wowzaVideoTranscoder.region - wowzaVideo.liveStreamEmbedCode - wowzaVideo.liveStreamPlayerUrl - wowzaVideo.liveStreamId - wowzaVideoTranscoder.width - wowzaVideoTranscoder.height - wowzaCloud.adaptiveStreaming - childProfile - group.streamMatcher - group.name - extraOptions TranscoderStreamNameGroupsAppConfig: type: object properties: streamNameGroups: type: array items: $ref: '#/components/schemas/ShortObject' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - streamNameGroups StreamRecorderConfig: type: object properties: timeScale: type: integer format: int64 instanceName: type: string fileVersionDelegateName: type: string serverName: type: string recorderName: type: string currentSize: type: integer format: int64 segmentSchedule: type: string startOnKeyFrame: type: boolean outputPath: type: string currentFile: type: string saveFieldList: type: array items: type: string defaultAudioSearchPosition: type: boolean recordData: type: boolean applicationName: type: string moveFirstVideoFrameToZero: type: boolean recorderErrorString: type: string segmentSize: type: integer format: int64 defaultRecorder: type: boolean splitOnTcDiscontinuity: type: boolean version: type: string skipKeyFrameUntilAudioTimeout: type: integer format: int32 baseFile: type: string segmentDuration: type: integer format: int64 recordingStartTime: type: string fileTemplate: type: string backBufferTime: type: integer format: int64 segmentationType: type: string currentDuration: type: integer format: int64 fileFormat: type: string recorderState: type: string option: type: string required: - version - serverName - recorderName - instanceName - applicationName - recorderState - recorderErrorString - defaultRecorder - segmentationType - outputPath - baseFile - fileFormat - fileVersionDelegateName - fileTemplate - segmentDuration - segmentSize - segmentSchedule - recordData - startOnKeyFrame - splitOnTcDiscontinuity - backBufferTime - option - moveFirstVideoFrameToZero - currentSize - currentDuration - currentFile - recordingStartTime - timeScale - defaultAudioSearchPosition - skipKeyFrameUntilAudioTimeout StreamGroupConfig: type: object properties: groupName: type: string isTranscodeResult: type: boolean instanceName: type: string members: type: array items: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - groupName - instanceName - members - isTranscodeResult ApplicationConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' serverName: type: string saveFieldList: type: array items: type: string version: type: string modules: type: array items: $ref: '#/components/schemas/ModuleConfig' required: - version - serverName - advancedSettings - modules SMILFileAppConfig: type: object properties: name: type: string serverName: type: string smilStreams: type: array items: $ref: '#/components/schemas/SMILFileStreamConfig' saveFieldList: type: array items: type: string title: type: string version: type: string required: - version - serverName - name - title - smilStreams StreamConfigurationConfig: type: object properties: streamType: type: string storageDirExists: type: boolean keyDir: type: string createStorageDir: type: boolean liveStreamPacketizer: type: array items: type: string serverName: type: string storageDir: type: string saveFieldList: type: array items: type: string version: type: string httpRandomizeMediaName: type: boolean required: - version - serverName - streamType - storageDir - createStorageDir - storageDirExists - keyDir - liveStreamPacketizer - httpRandomizeMediaName LiveEncoderConfig: type: object properties: output: $ref: '#/components/schemas/Output' serverName: type: string source: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - output - source TranscoderEncodesAppConfig: type: object properties: serverName: type: string saveFieldList: type: array items: type: string encodes: type: array items: $ref: '#/components/schemas/ShortObject' version: type: string required: - version - serverName - encodes StreamRecordersConfig: type: object properties: streamrecorder: type: array items: $ref: '#/components/schemas/StreamRecorderConfig' instanceName: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - instanceName - streamrecorder SecurityConfig: type: object properties: playMaximumConnections: type: integer format: int32 publishBlockDuplicateStreamNames: type: boolean publishIPWhiteList: type: string playAuthenticationMethod: type: string serverName: type: string clientStreamWriteAccess: type: string playIPWhiteList: type: string publishRequirePassword: type: boolean playIPBlackList: type: string version: type: string secureTokenVersion: type: integer format: int32 publishPasswordFile: type: string publishValidEncoders: type: string secureTokenQueryParametersPrefix: type: string secureTokenUseTEAForRTMP: type: boolean publishAuthenticationMethod: type: string secureTokenHashAlgorithm: type: string publishIPBlackList: type: string playRequireSecureConnection: type: boolean secureTokenOriginSharedSecret: type: string saveFieldList: type: array items: type: string secureTokenIncludeClientIPInHash: type: boolean publishRTMPSecureURL: type: string secureTokenSharedSecret: type: string required: - version - serverName - secureTokenVersion - clientStreamWriteAccess - publishRequirePassword - publishPasswordFile - publishRTMPSecureURL - publishIPBlackList - publishIPWhiteList - publishBlockDuplicateStreamNames - publishValidEncoders - publishAuthenticationMethod - playMaximumConnections - playRequireSecureConnection - secureTokenSharedSecret - secureTokenUseTEAForRTMP - secureTokenIncludeClientIPInHash - secureTokenHashAlgorithm - secureTokenQueryParametersPrefix - secureTokenOriginSharedSecret - playIPBlackList - playIPWhiteList - playAuthenticationMethod SDPFilesAppConfig: type: object properties: sdpFiles: type: array items: $ref: '#/components/schemas/ShortObject' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - sdpFiles DvrRESTConverterStores: type: object properties: groupConversionStatusList: type: array items: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string dvrconverterstoresummary: type: array items: type: string required: - version - serverName - dvrconverterstoresummary - groupConversionStatusList WSCRESTProxyConfig: type: object properties: apiRequest: type: string encrypted: type: boolean serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - encrypted - apiRequest TranscoderOverlayEncodeAppConfig: type: object properties: overlayName: type: string imagePath: type: string serverName: type: string description: type: string index: type: integer format: int32 align: type: string version: type: string enable: type: boolean x: type: integer format: int32 width: type: string name: type: string y: type: integer format: int32 saveFieldList: type: array items: type: string checkForUpdates: type: boolean opacity: type: integer format: int32 height: type: string required: - version - serverName - overlayName - description - enable - imagePath - index - checkForUpdates - opacity - x - y - width - height - align - name TranscoderOverlayDecodeAppConfig: type: object properties: overlayName: type: string imagePath: type: string serverName: type: string description: type: string index: type: integer format: int32 align: type: string version: type: string enable: type: boolean x: type: integer format: int32 width: type: string y: type: integer format: int32 saveFieldList: type: array items: type: string checkForUpdates: type: boolean opacity: type: integer format: int32 height: type: string required: - version - serverName - overlayName - description - enable - imagePath - index - checkForUpdates - opacity - x - y - width - height - align SourceControlConfig: type: object properties: featureList: type: array items: type: string serverName: type: string model: type: string saveFieldList: type: array items: type: string version: type: string firmware: type: string manufacturer: type: string required: - version - serverName - manufacturer - model - firmware - featureList AdvancedSetting: type: object properties: sectionName: type: string canRemove: type: boolean defaultValue: type: string documented: type: boolean name: type: string section: type: string type: type: string value: type: string initialValue: type: string enabled: type: boolean required: - enabled - canRemove - name - value - defaultValue - type - sectionName - section - documented - initialValue StreamFileAppConfigAdv: type: object properties: sourceControlDriver: type: string advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' serverName: type: string saveFieldList: type: array items: type: string version: type: string mpegTSFilters: type: array items: $ref: '#/components/schemas/MpegTSFilter' required: - version - serverName - advancedSettings - sourceControlDriver RTMP: type: object properties: password: type: string stream: type: string backup_url: type: string url: type: string username: type: string required: - url - backup_url - stream - username - password TranscoderOverlayEncodeConfig: type: object properties: overlayName: type: string imagePath: type: string serverName: type: string description: type: string index: type: integer format: int32 align: type: string version: type: string enable: type: boolean x: type: integer format: int32 width: type: string name: type: string y: type: integer format: int32 saveFieldList: type: array items: type: string checkForUpdates: type: boolean opacity: type: integer format: int32 height: type: string required: - version - serverName - overlayName - description - enable - imagePath - index - checkForUpdates - opacity - x - y - width - height - align - name DRMConfig: type: object properties: buyDRMProtectMpegDashStreaming: type: boolean serverName: type: string buyDRMProtectCupertinoStreaming: type: boolean version: type: string verimatrixCupertinoKeyServerPort: type: integer format: int32 verimatrixSmoothKeyServerPort: type: integer format: int32 verimatrixStreamMaps: $ref: '#/components/schemas/VerimatrixStreamMapsConfig' verimatrixSmoothKeyServerIpAddress: type: string licenseType: type: string verimatrixCupertinoKeyServerIpAddress: type: string buyDRMProtectSmoothStreaming: type: boolean buyDRMUserKey: type: string inUse: type: boolean ezDRMUsername: type: string verimatrixProtectSmoothStreaming: type: boolean buyDRMStreamMaps: $ref: '#/components/schemas/BuyDRMStreamMapsConfig' verimatrixCupertinoVODPerSessionKeys: type: boolean saveFieldList: type: array items: type: string ezDRMPassword: type: string verimatrixProtectCupertinoStreaming: type: boolean cupertinoEncryptionAPIBased: type: boolean required: - version - serverName - licenseType - inUse - ezDRMUsername - ezDRMPassword - buyDRMUserKey - buyDRMProtectSmoothStreaming - buyDRMProtectCupertinoStreaming - buyDRMProtectMpegDashStreaming - verimatrixProtectCupertinoStreaming - verimatrixCupertinoKeyServerIpAddress - verimatrixCupertinoKeyServerPort - verimatrixCupertinoVODPerSessionKeys - verimatrixProtectSmoothStreaming - verimatrixSmoothKeyServerIpAddress - verimatrixSmoothKeyServerPort - cupertinoEncryptionAPIBased - buyDRMStreamMaps - verimatrixStreamMaps TranscoderMemberConfig: type: object properties: wowzaVideoOnly: type: boolean encodeName: type: string wowzaAudioOnly: type: boolean serverName: type: string memberName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - memberName - encodeName - wowzaVideoOnly - wowzaAudioOnly Output: type: object properties: rtmp: $ref: '#/components/schemas/RTMP' video: $ref: '#/components/schemas/VideoSettings' required: - rtmp - video TranscoderEncodeConfig: type: object properties: followSource: type: boolean implementation: type: string gpuid: type: integer format: int32 profile: type: string serverName: type: string description: type: string audioCodec: type: string version: type: string streamName: type: string Overlays: type: array items: $ref: '#/components/schemas/TranscoderOverlayEncodeConfig' audioBitrate: type: string videoBitrate: type: string enable: type: boolean name: type: string width: type: integer format: int32 interval: type: integer format: int32 fitMode: type: string saveFieldList: type: array items: type: string crop: type: string convert8bit: type: boolean videoCodec: type: string height: type: integer format: int32 sourceRectangle: type: string required: - version - serverName - name - enable - description - streamName - videoCodec - implementation - gpuid - profile - videoBitrate - followSource - interval - fitMode - width - height - crop - sourceRectangle - audioCodec - audioBitrate - Overlays - convert8bit AppShortObject: type: object properties: drmEnabled: type: boolean streamTargetsEnabled: type: boolean appType: type: string transcoderEnabled: type: boolean dvrEnabled: type: boolean id: type: string href: type: string required: - id - href - appType - dvrEnabled - drmEnabled - transcoderEnabled - streamTargetsEnabled OutgoingStreamConfig: type: object properties: someProp2: type: string someProp: type: string name: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - name - someProp - someProp2 DefaultStreamRecorderConfig: type: object properties: timeScale: type: integer format: int64 instanceName: type: string fileVersionDelegateName: type: string serverName: type: string recorderName: type: string currentSize: type: integer format: int64 segmentSchedule: type: string startOnKeyFrame: type: boolean outputPath: type: string currentFile: type: string saveFieldList: type: array items: type: string defaultAudioSearchPosition: type: boolean recordData: type: boolean applicationName: type: string moveFirstVideoFrameToZero: type: boolean recorderErrorString: type: string segmentSize: type: integer format: int64 defaultRecorder: type: boolean splitOnTcDiscontinuity: type: boolean version: type: string skipKeyFrameUntilAudioTimeout: type: integer format: int32 baseFile: type: string segmentDuration: type: integer format: int64 recordingStartTime: type: string fileTemplate: type: string backBufferTime: type: integer format: int64 segmentationType: type: string currentDuration: type: integer format: int64 fileFormat: type: string recorderState: type: string option: type: string required: - version - serverName - recorderName - instanceName - applicationName - recorderState - recorderErrorString - defaultRecorder - segmentationType - outputPath - baseFile - fileFormat - fileVersionDelegateName - fileTemplate - segmentDuration - segmentSize - segmentSchedule - recordData - startOnKeyFrame - splitOnTcDiscontinuity - backBufferTime - option - moveFirstVideoFrameToZero - currentSize - currentDuration - currentFile - recordingStartTime - timeScale - defaultAudioSearchPosition - skipKeyFrameUntilAudioTimeout Integer: type: object properties: {} SMILFilesAppConfig: type: object properties: vhostName: type: string appName: type: string serverName: type: string smilFiles: type: array items: $ref: '#/components/schemas/ShortObject' saveFieldList: type: array items: type: string version: type: string required: - version - serverName - vhostName - smilFiles - appName StreamFileAppConfig: type: object properties: sourceControlDriver: type: string sourceControlUserName: type: string sourceControlPassword: type: string name: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string uri: type: string required: - version - serverName - name - uri - sourceControlUserName - sourceControlPassword - sourceControlDriver TranscoderStreamNameGroupConfig: type: object properties: name: type: string serverName: type: string description: type: string saveFieldList: type: array items: type: string version: type: string streamName: type: string Members: type: array items: $ref: '#/components/schemas/TranscoderMemberConfig' required: - version - serverName - name - description - streamName - Members TranscoderEncodeAppConfigAdv: type: object properties: advancedSettings: type: array items: $ref: '#/components/schemas/AdvancedSetting' name: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - advancedSettings - name ModulesConfig: type: object properties: moduleList: type: array items: $ref: '#/components/schemas/ModuleConfig' serverName: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - moduleList PublisherAppConfig: type: object properties: password: type: string publisherName: type: string serverName: type: string description: type: string saveFieldList: type: array items: type: string version: type: string required: - version - serverName - publisherName - description - password TranscoderOverlayDecodeConfig: type: object properties: overlayName: type: string imagePath: type: string serverName: type: string description: type: string index: type: integer format: int32 align: type: string version: type: string enable: type: boolean x: type: integer format: int32 width: type: string y: type: integer format: int32 saveFieldList: type: array items: type: string checkForUpdates: type: boolean opacity: type: integer format: int32 height: type: string required: - version - serverName - overlayName - description - enable - imagePath - index - checkForUpdates - opacity - x - y - width - height - align CurrentIncomingStreamStatistics: type: object properties: totalConnections: type: integer format: int64 applicationInstance: type: string bytesOutRate: type: integer format: int64 name: type: string serverName: type: string saveFieldList: type: array items: type: string version: type: string uptime: type: integer format: int64 bytesIn: type: integer format: int64 bytesOut: type: integer format: int64 bytesInRate: type: integer format: int64 required: - version - serverName - applicationInstance - name - uptime - bytesIn - bytesOut - bytesInRate - bytesOutRate - totalConnections - connectionCount securitySchemes: basicAuth: type: http scheme: basic description: HTTP Basic Authentication using Wowza Streaming Engine admin credentials digestAuth: type: http scheme: digest description: HTTP Digest Authentication