{ "openapi": "3.0.3", "info": { "title": "Wowza Streaming Engine REST 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" } ], "tags": [ { "name": "Applications", "description": "" }, { "name": "Machine Stats", "description": "" }, { "name": "Server Licenses", "description": "" }, { "name": "Server Listeners", "description": "" }, { "name": "Server log4j system", "description": "" }, { "name": "Server MediaCache", "description": "" }, { "name": "Server MediaCache Version 3", "description": "" }, { "name": "Server MediaCasters", "description": "" }, { "name": "Server Monitoring", "description": "" }, { "name": "Server Publishers", "description": "" }, { "name": "Server Publishers Version 3", "description": "" }, { "name": "REST information", "description": "" }, { "name": "Servers Configuration", "description": "" }, { "name": "Server Status", "description": "" }, { "name": "Server Transcoder", "description": "" }, { "name": "Server Tuning", "description": "" }, { "name": "Server Users", "description": "" }, { "name": "Virtual Hosts", "description": "" }, { "name": "Webhooks", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}": { "get": { "tags": [ "Applications" ], "operationId": "getApplicationConfig", "summary": "Get app", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Applications" ], "operationId": "postApplicationConfig", "summary": "Create app", "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putApplicationConfig", "summary": "Update app", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Applications" ], "operationId": "deleteApplicationConfig", "summary": "Delete app", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/adv": { "get": { "tags": [ "Applications" ], "operationId": "getApplicationConfigAdv", "summary": "Get app (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putApplicationConfigAdv", "summary": "Update app (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Applications" ], "operationId": "postApplicationConfigAdv", "summary": "Create app (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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm": { "get": { "tags": [ "Applications" ], "operationId": "getDRMConfig", "summary": "Get DRM", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putDRMConfig", "summary": "Update DRM", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/adv": { "get": { "tags": [ "Applications" ], "operationId": "getDRMConfigAdv", "summary": "Get DRM (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putDRMConfigAdv", "summary": "Update DRM (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}": { "get": { "tags": [ "Applications" ], "operationId": "getInstanceConfig", "summary": "Get instance", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/publishers/{publisherName}": { "get": { "tags": [ "Applications" ], "operationId": "getPublisherAppConfig", "summary": "Get publisher", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putPublisherAppConfig", "summary": "Update publisher", "description": "Updates 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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherAppConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Applications" ], "operationId": "postPublisherAppConfig", "summary": "Create publisher", "description": "Adds 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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherAppConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Applications" ], "operationId": "deletePublisherAppConfig", "summary": "Delete publisher", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamfiles/{streamfileName}": { "get": { "tags": [ "Applications" ], "operationId": "getStreamFileAppConfig", "summary": "Get stream file", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Applications" ], "operationId": "deleteStreamFileAppConfig", "summary": "Delete stream file", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putStreamFileAppConfig", "summary": "Update stream file", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Applications" ], "operationId": "postStreamFileAppConfig", "summary": "Create stream file", "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamfiles/{streamfileName}/adv": { "get": { "tags": [ "Applications" ], "operationId": "getStreamFileAppConfigAdv", "summary": "Get stream file (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putStreamFileAppConfigAdv", "summary": "Update stream file (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder": { "get": { "tags": [ "Applications" ], "operationId": "getTranscoderAppConfig", "summary": "Get transcoder", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putTranscoderAppConfig", "summary": "Update transcoder", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/adv": { "get": { "tags": [ "Applications" ], "operationId": "getTranscoderAppConfigAdv", "summary": "Get transcoder (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putTranscoderAppConfigAdv", "summary": "Update transcoder (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putTranscoderOverlayDecodeAppConfig", "summary": "Update transcoder overlay decode", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Applications" ], "operationId": "deleteTranscoderOverlayDecodeAppConfig", "summary": "Delete transcoder overlay decode", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Applications" ], "operationId": "postTranscoderEncodeAppConfig", "summary": "Create transcoder encoder", "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putTranscoderEncodeAppConfig", "summary": "Update transcoder encoder", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Applications" ], "operationId": "deleteTranscoderEncodeAppConfig", "summary": "Delete transcoder encoder", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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 (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putTranscoderEncodeAppConfigAdv", "summary": "Update transcoder encoder (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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "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", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Applications" ], "operationId": "postTranscoderStreamNameGroupAppConfig", "summary": "Create transcoder stream name group", "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" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Applications" ], "operationId": "putTranscoderStreamNameGroupAppConfig", "summary": "Update transcoder stream name group", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Applications" ], "operationId": "deleteTranscoderStreamNameGroupAppConfig", "summary": "Delete transcoder stream name group", "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/machine/monitoring/current": { "get": { "tags": [ "Machine Stats" ], "operationId": "getCurrentMachineStatistics", "summary": "Get current stats", "description": "Retrieves current statistics for the machine. This API is available in builds 15089 or later.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentMachineStatistics" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/machine/monitoring/historic": { "get": { "tags": [ "Machine Stats" ], "operationId": "getHistoricMachineStatistics", "summary": "Get historic stats", "description": "Retrieves historic statistics for the machine. This API is available in builds 15089 or later.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricMachineStatistics" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/licenses": { "get": { "tags": [ "Server Licenses" ], "operationId": "getServerLicensesConfig", "summary": "Get license list", "description": "Retrieves the list of server licenses. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLicensesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server Licenses" ], "operationId": "putServerLicensesConfig", "summary": "Update license list", "description": "Updates the server license list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLicensesConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/listeners": { "get": { "tags": [ "Server Listeners" ], "operationId": "getServerListenersConfig", "summary": "Get listener list", "description": "Retrieves the list of server listeners. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerListenersConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server Listeners" ], "operationId": "putServerListenersConfig", "summary": "Update listener list", "description": "Updates the server listeners list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerListenersConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/log4j": { "get": { "tags": [ "Server log4j system" ], "operationId": "getLog4js", "summary": "Get log4j config", "description": "Retrieves the server log4j 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log4js" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/log4j/actions/{action}": { "put": { "tags": [ "Server log4j system" ], "operationId": "putLog4jsAction", "summary": "Log4j actions", "description": "Tells the log4j system to perform an 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": [ "reload" ] } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/log4j/{loggerName}/actions/{action}": { "put": { "tags": [ "Server log4j system" ], "operationId": "putLog4jAction", "summary": "Log4j logger actions", "description": "Tells the specified log4j logger to perform an 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": [ "debug", "error", "fatal", "info", "reload", "warn" ] } }, { "name": "loggerName", "in": "path", "required": true, "description": "The logger name needed for this REST call", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheConfig", "summary": "Get media cache", "description": "Retrieves the server MediaCache 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache" ], "operationId": "putMediaCacheConfig", "summary": "Update media cache", "description": "Updates the server MediaCache 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/adv": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheConfigAdv", "summary": "Get media cache (adv)", "description": "Retrieves the advanced MediaCache 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache" ], "operationId": "putMediaCacheConfigAdv", "summary": "Update media cache (adv)", "description": "Updates the advanced MediaCache 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheConfigAdv", "summary": "Create media cache (adv)", "description": "Adds an advanced MediaCache 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/sources": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheSourcesConfig", "summary": "Get media cache source list", "description": "Retrieves the list of MediaCache Sources. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourcesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheSourcesConfig", "summary": "Update media cache source list", "description": "Adds the specified MediaCache Source to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/sources/{sourceName}": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheSourceConfig", "summary": "Get media cache source", "description": "Retrieves the specified MediaCache Source 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheSourceConfig", "summary": "Create media cache source", "description": "Adds the specified MediaCache Source 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache" ], "operationId": "putMediaCacheSourceConfig", "summary": "Update media cache source", "description": "Updates the specified MediaCache Source 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server MediaCache" ], "operationId": "deleteMediaCacheSourceConfig", "summary": "Delete media cache source", "description": "Deletes the specified MediaCache Source 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_" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/sources/{sourceName}/adv": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheSourceConfigAdv", "summary": "Get media cache source (adv)", "description": "Retrieves the specified advanced MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache" ], "operationId": "putMediaCacheSourceConfigAdv", "summary": "Update media cache source (adv)", "description": "Updates the specified advanced MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheSourceConfigAdv", "summary": "Create media cache source (adv)", "description": "Adds the specified advanced MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/stores": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheStoresConfig", "summary": "Get media cache store list", "description": "Retrieves the list of MediaCache Stores. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoresConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheStoresConfig", "summary": "Update media cache store list", "description": "Adds the specified MediaCache Store to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/stores/{storeName}": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheStoreConfig", "summary": "Get media cache store", "description": "Retrieves the specified MediaCache Store 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheStoreConfig", "summary": "Create media cache store", "description": "Adds the specified MediaCache Store 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache" ], "operationId": "putMediaCacheStoreConfig", "summary": "Update media cache store", "description": "Updates the specified MediaCache Store 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server MediaCache" ], "operationId": "deleteMediaCacheStoreConfig", "summary": "Delete media cache store", "description": "Deletes the specified MediaCache Store 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_" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacache/stores/{storeName}/adv": { "get": { "tags": [ "Server MediaCache" ], "operationId": "getMediaCacheStoreConfigAdv", "summary": "Get media cache store (adv)", "description": "Retrieves the specified advanced MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache" ], "operationId": "putMediaCacheStoreConfigAdv", "summary": "Update media cache store (adv)", "description": "Updates the specified advanced MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache" ], "operationId": "postMediaCacheStoreConfigAdv", "summary": "Create media cache store (adv)", "description": "Adds the specified advanced MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/mediacache": { "get": { "tags": [ "Server MediaCache Version 3" ], "operationId": "getMediaCacheConfig3", "summary": "Get media cache server V3", "description": "Retrieves the server MediaCache 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache Version 3" ], "operationId": "putMediaCacheConfig3", "summary": "Update media cache server V3", "description": "Updates the server MediaCache 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/mediacache/sources": { "get": { "tags": [ "Server MediaCache Version 3" ], "operationId": "getMediaCacheSourcesConfig3", "summary": "Get media cache source list V3", "description": "Retrieves the list of MediaCache Sources. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourcesConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache Version 3" ], "operationId": "postMediaCacheSourcesConfig3", "summary": "Update media cache source list V3", "description": "Adds the specified MediaCache Source to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/mediacache/sources/{sourceName}": { "get": { "tags": [ "Server MediaCache Version 3" ], "operationId": "getMediaCacheSourceConfig3", "summary": "Get media cache source V3", "description": "Retrieves the specified MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache Version 3" ], "operationId": "postMediaCacheSourceConfig3", "summary": "Create media cache source V3", "description": "Adds the specified MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache Version 3" ], "operationId": "putMediaCacheSourceConfig3", "summary": "Update media cache source V3", "description": "Updates the specified MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server MediaCache Version 3" ], "operationId": "deleteMediaCacheSourceConfig3", "summary": "Delete media cache source V3", "description": "Deletes the specified MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/mediacache/sources/{sourceName}/adv": { "get": { "tags": [ "Server MediaCache Version 3" ], "operationId": "getMediaCacheSourceConfigAdv3", "summary": "Get media cache source (adv) V3", "description": "Retrieves the specified advanced MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfigAdv3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache Version 3" ], "operationId": "putMediaCacheSourceConfigAdv3", "summary": "Update media cache source (adv) V3", "description": "Updates the specified advanced MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfigAdv3" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache Version 3" ], "operationId": "postMediaCacheSourceConfigAdv3", "summary": "Create media cache source (adv) V3", "description": "Adds the specified advanced MediaCache Source 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": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheSourceConfigAdv3" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/mediacache/stores": { "get": { "tags": [ "Server MediaCache Version 3" ], "operationId": "getMediaCacheStoresConfig3", "summary": "Get media cache store list V3", "description": "Retrieves the list of MediaCache Stores. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoresConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache Version 3" ], "operationId": "postMediaCacheStoresConfig3", "summary": "Update media cache store list V3", "description": "Adds the specified MediaCache Store to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/mediacache/stores/{storeName}": { "get": { "tags": [ "Server MediaCache Version 3" ], "operationId": "getMediaCacheStoreConfig3", "summary": "Get media cache store V3", "description": "Retrieves the specified MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server MediaCache Version 3" ], "operationId": "postMediaCacheStoreConfig3", "summary": "Create media cache store V3", "description": "Adds the specified MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server MediaCache Version 3" ], "operationId": "putMediaCacheStoreConfig3", "summary": "Update media cache store V3", "description": "Updates the specified MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server MediaCache Version 3" ], "operationId": "deleteMediaCacheStoreConfig3", "summary": "Delete media cache store V3", "description": "Deletes the specified MediaCache Store 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": "storeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacasters": { "get": { "tags": [ "Server MediaCasters" ], "operationId": "getMediaCastersConfig", "summary": "Get media caster list", "description": "Retrieves the list of MediaCasters. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCastersConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/mediacasters/{mediacastername}": { "get": { "tags": [ "Server MediaCasters" ], "operationId": "getMediaCasterConfig", "summary": "Get media caster", "description": "Retrieves the specified MediaCaster 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": "mediacastername", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCasterConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/monitoring": { "get": { "tags": [ "Server Monitoring" ], "operationId": "getMonitoringConfig", "summary": "Get monitoring config", "description": "Retrieves the server monitoring 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server Monitoring" ], "operationId": "putMonitoringConfig", "summary": "Update monitoring config", "description": "Updates the server monitoring 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/monitoring/historic": { "get": { "tags": [ "Server Monitoring" ], "operationId": "getHistoricServerStatistics", "summary": "Get historical stats", "description": "Retrieves the server historical 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricServerStatistics" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/publishers": { "get": { "tags": [ "Server Publishers" ], "operationId": "getPublishersConfig", "summary": "Get publisher list", "description": "Retrieves the list of server Publishers. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishersConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server Publishers" ], "operationId": "postPublishersConfig", "summary": "Update publisher list", "description": "Adds a new publisher to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/publishers/{publisher}": { "get": { "tags": [ "Server Publishers" ], "operationId": "getPublisherConfig", "summary": "Get publisher", "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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server Publishers" ], "operationId": "postPublisherConfig", "summary": "Create publisher", "description": "Adds 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server Publishers" ], "operationId": "deletePublisherConfig", "summary": "Delete publisher", "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_" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/publishers": { "get": { "tags": [ "Server Publishers Version 3" ], "operationId": "getPublishersConfig3", "summary": "Get publisher list V3", "description": "Retrieves the list of server Publishers. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishersConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server Publishers Version 3" ], "operationId": "postPublishersConfig3", "summary": "Update publisher list V3", "description": "Adds a new publisher to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v3/servers/{serverName}/publishers/{publisher}": { "put": { "tags": [ "Server Publishers Version 3" ], "operationId": "putPublisherConfig3", "summary": "Update publisher V3", "description": "Publisher config v3. This API is available in builds 20064 or later.", "parameters": [ { "name": "serverName", "in": "path", "required": true, "description": "Reserved for future use", "schema": { "type": "string", "default": "_defaultServer_" } }, { "name": "publisher", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "get": { "tags": [ "Server Publishers Version 3" ], "operationId": "getPublisherConfig3", "summary": "Get publisher V3", "description": "Retrieves the specified publisher configuration. This API is available in builds 20064 or later.", "parameters": [ { "name": "serverName", "in": "path", "required": true, "description": "Reserved for future use", "schema": { "type": "string", "default": "_defaultServer_" } }, { "name": "publisher", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig3" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server Publishers Version 3" ], "operationId": "postPublisherConfig3", "summary": "Create publisher V3", "description": "Adds the specified publisher configuration. This API is available in builds 20064 or later.", "parameters": [ { "name": "serverName", "in": "path", "required": true, "description": "Reserved for future use", "schema": { "type": "string", "default": "_defaultServer_" } }, { "name": "publisher", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherConfig3" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server Publishers Version 3" ], "operationId": "deletePublisherConfig3", "summary": "Delete publisher V3", "description": "Deletes the specified publisher configuration. This API is available in builds 20064 or later.", "parameters": [ { "name": "serverName", "in": "path", "required": true, "description": "Reserved for future use", "schema": { "type": "string", "default": "_defaultServer_" } }, { "name": "publisher", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/restinfo": { "get": { "tags": [ "REST information" ], "operationId": "getRESTInfoConfig", "summary": "Get REST API info", "description": "Retrieves the REST configuration information. This API is available in builds 15089 or later.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTInfoConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServersConfig", "summary": "Get server list", "description": "Retrieves the list of servers. This API is available in builds 15089 or later.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServersConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerConfig", "summary": "Get server", "description": "Retrieves the server 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Servers Configuration" ], "operationId": "putServerConfig", "summary": "Update server", "description": "Updates the server 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/actions/{action}": { "put": { "tags": [ "Servers Configuration" ], "operationId": "putServerAction", "summary": "Server actions", "description": "Tells the server to perform an action. This API is available in builds 18647 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": [ "heapDump", "restart", "stackTrace", "start", "stop" ] } }, { "name": "filename", "in": "query", "required": false, "description": "The file location to use when creating a heap dump or stack trace. By default the installation location and file are named appropriately for a heap dump or stack trace", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/adv": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerConfigAdv", "summary": "Get server (adv)", "description": "Retrieves the advanced server 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Servers Configuration" ], "operationId": "putServerConfigAdv", "summary": "Update server (adv)", "description": "Updates the advanced server 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/logfiles": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerLogFilesConfig", "summary": "Get log list", "description": "Retrieves the list of server log files. 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": "order", "in": "query", "required": false, "description": "The order of files in serverLogs list", "schema": { "type": "string", "enum": [ "newestFirst", "oldestFirst" ], "default": "newestFirst" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLogFilesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/logfiles/{logName}": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerLogFileConfig", "summary": "Get log", "description": "Retrieves the contents of a server log with the specified log name. 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": "lineCount", "in": "query", "required": false, "description": "The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset", "schema": { "type": "string", "default": "100" } }, { "name": "startOffset", "in": "query", "required": false, "description": "The byte offset in the file at which to begin getting log lines", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": false, "description": "A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "description": "A string containing a literal string on which to filter or a regex", "schema": { "type": "string" } }, { "name": "regexSearch", "in": "query", "required": false, "description": "Indicates if the 'search' parameter is a regex or a literal string ", "schema": { "type": "string", "enum": [ "false", "true" ], "default": "false" } }, { "name": "head", "in": "query", "required": false, "description": "Returns the first x lines from the requested log file, the overrides the startoffset and linecount values", "schema": { "type": "string" } }, { "name": "tail", "in": "query", "required": false, "description": "Returns the last x lines from the requested log file, the overrides the startoffset and linecount values", "schema": { "type": "string" } }, { "name": "logName", "in": "path", "required": true, "description": "The name of the log", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLogFileConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/logfiles/{logName}/download": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerLogFileDownloadConfig", "summary": "Get zipped log", "description": "Retrieves the server log file for the specified log name, zipped. 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": "logName", "in": "path", "required": true, "description": "The name of the log", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLogFileDownloadConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/logs": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerLogTypesConfig", "summary": "Get log types", "description": "Retrieves the list of available server log types. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLogTypesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/logs/{logType}": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getServerLogsConfig", "summary": "Get logs by type", "description": "Retrieves the contents of multiple server logs with the specified type in the log name. 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": "lineCount", "in": "query", "required": false, "description": "The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset", "schema": { "type": "string", "default": "100" } }, { "name": "startOffset", "in": "query", "required": false, "description": "The byte offset in the file at which to begin getting log lines", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": false, "description": "A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "description": "A string containing a literal string on which to filter or a regex", "schema": { "type": "string" } }, { "name": "regexSearch", "in": "query", "required": false, "description": "Indicates if the 'search' parameter is a regex or a literal string ", "schema": { "type": "string", "enum": [ "false", "true" ], "default": "false" } }, { "name": "head", "in": "query", "required": false, "description": "Returns the first x lines from the requested log file, the overrides the startoffset and linecount values", "schema": { "type": "string" } }, { "name": "tail", "in": "query", "required": false, "description": "Returns the last x lines from the requested log file, the overrides the startoffset and linecount values", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "description": "The start date to filter on (UTC milliseconds)", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "description": "The end date to filter on (UTC milliseconds)", "schema": { "type": "string" } }, { "name": "logType", "in": "path", "required": true, "description": "The type of the log", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerLogsConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/sourcecontrol/drivernames": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getSourceDriverNamesList", "summary": "Get source control drivers", "description": "Get the list of source control drivers. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDriverNamesList" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhostlisteners": { "get": { "tags": [ "Servers Configuration" ], "operationId": "getVHostListenersConfig", "summary": "Get vhost listener list", "description": "Retrieves the list of vhost listeners. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostListenersConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Servers Configuration" ], "operationId": "putVHostListenersConfig", "summary": "Update vhost listener list", "description": "Updates the full list of vhost listeners. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostListenersConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhostlisteners/{baseclass}": { "delete": { "tags": [ "Servers Configuration" ], "operationId": "deleteVHostListenerConfig", "summary": "Delete vhost listener", "description": "Deletes the vhost listener with the given base class. 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": "baseclass", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/status": { "get": { "tags": [ "Server Status" ], "operationId": "getServerStatusConfig", "summary": "Get server status", "description": "Retrieves the server status. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerStatusConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/transcoder": { "get": { "tags": [ "Server Transcoder" ], "operationId": "getTranscoderConfig", "summary": "Get transcoder", "description": "Retrieves the transcoder 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/tune": { "get": { "tags": [ "Server Tuning" ], "operationId": "getServerTuneConfig", "summary": "Get tuning config", "description": "Retrieves the server tuning 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerTuneConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server Tuning" ], "operationId": "putServerTuneConfig", "summary": "Update tuning config", "description": "Updates the server tuning 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerTuneConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/users": { "get": { "tags": [ "Server Users" ], "operationId": "getUsersConfig", "summary": "Get user list", "description": "Retrieves the list of server users. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server Users" ], "operationId": "postUsersConfig", "summary": "Update user list", "description": "Adds a new server user to the list. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/users/{userName}": { "get": { "tags": [ "Server Users" ], "operationId": "getUserConfig", "summary": "Get user", "description": "Retrieves the specified user 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": "userName", "in": "path", "required": true, "description": "The user name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Server Users" ], "operationId": "putUserConfig", "summary": "Update user", "description": "Updates the specified user 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": "userName", "in": "path", "required": true, "description": "The user name", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Server Users" ], "operationId": "postUserConfig", "summary": "Create user", "description": "Adds the specified user 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": "userName", "in": "path", "required": true, "description": "The user name", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Server Users" ], "operationId": "deleteUserConfig", "summary": "Delete user", "description": "Deletes the specified user 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": "userName", "in": "path", "required": true, "description": "The user name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getVHostsConfig", "summary": "Get vhost list", "description": "Retrieves the list of vhosts. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostsConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getVHostConfig", "summary": "Get vhost", "description": "Retrieves the specified vhost 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putVHostConfig", "summary": "Update vhost", "description": "Updates the specified vhost 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/actions/{action}": { "put": { "tags": [ "Virtual Hosts" ], "operationId": "putVHostAction", "summary": "Vhost actions", "description": "Vhost 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": [ "restart", "start", "stop" ] } }, { "name": "vhostName", "in": "path", "required": true, "description": "The name of the current VHost the action will be performed on", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/adv": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getVHostConfigAdv", "summary": "Get vhost (adv)", "description": "Retrieves the specified advanced vhost 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putVHostConfigAdv", "summary": "Update vhost (adv)", "description": "Updates the specified advanced vhost 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/hostports": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getHostPortsConfig", "summary": "Get host ports list", "description": "Retrieves the list of server host ports 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/HostPortsConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getHostPortConfig", "summary": "Get host port", "description": "Retrieves the host port for the specified vhost and port. 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": "portname", "in": "path", "required": true, "description": "The port name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostPortConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/adv": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getHostPortConfigAdv", "summary": "Get host port (adv)", "description": "Retrieves the advanced host port configuration for the specified vhost and port. 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": "portname", "in": "path", "required": true, "description": "The port name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostPortConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putHostPortConfigAdv", "summary": "Update host port (adv)", "description": "Host port config adv. 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": "portname", "in": "path", "required": true, "description": "The port name", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostPortConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/httpproviders/{baseClass}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getHTTPProviderConfig", "summary": "Get HTTP providers", "description": "Retrieves the HTTP providers for the specified vhost, port and baseclass. 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": "portname", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "baseClass", "in": "path", "required": true, "description": "Base class path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPProviderConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/ssl": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getSSLConfig", "summary": "Get SSL config", "description": "Retrieves the SSL configuration for the specified vhost and port. 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": "portname", "in": "path", "required": true, "description": "The port name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSLConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putSSLConfig", "summary": "Update SSL config", "description": "Updates the SSL configuration for the specified vhost and port. 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": "portname", "in": "path", "required": true, "description": "The port name", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSLConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/mediacache/stores": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getMediaCacheStoreList", "summary": "Get media cache store list", "description": "Retrieves all entries in the media cache system. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaCacheStoreList" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/mediacache/stores/actions/{action}": { "put": { "tags": [ "Virtual Hosts" ], "operationId": "putMediaCacheStoreAction", "summary": "Media cache store actions", "description": "Media cache 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_" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/monitoring/current": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getCurrentVHostStatistics", "summary": "Get current vhost stats", "description": "Retrieves the current vhost 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentVHostStatistics" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/monitoring/historic": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getHistoricVHostStatistics", "summary": "Get historic vhost stats", "description": "Retrieves the historic vhost 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricVHostStatistics" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/publishers": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getPublishersVhostConfig", "summary": "Get publisher list", "description": "Retrieves the list of publishers 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, "description": "The vhost name", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishersVhostConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postPublishersVhostConfig", "summary": "Update publisher list", "description": "Add a publisher to list of publishers 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, "description": "The vhost name", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherVhostConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/publishers/{publisherName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getPublisherVhostConfig", "summary": "Get publisher", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherVhostConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putPublisherVhostConfig", "summary": "Update publisher", "description": "Updates 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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherVhostConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postPublisherVhostConfig", "summary": "Create publisher", "description": "Adds 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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherVhostConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deletePublisherVhostConfig", "summary": "Delete publisher", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getSDPFilesConfig", "summary": "Get SDP file list", "description": "Retrieves the list of SDP Files 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/SDPFilesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles/{sdpfileName}": { "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteSDPFileConfig", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles/{sdpfileName}/actions/{action}": { "put": { "tags": [ "Virtual Hosts" ], "operationId": "putSDPFileAction", "summary": "SDP file actions", "description": "SDPF file 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": "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getSMILFilesConfig", "summary": "Get SMIL file list", "description": "Retrieves the list of SMIL files 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, "description": "The name of the current VHost the action will be performed on", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMILFilesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postSMILFilesConfig", "summary": "Update SMIL file list", "description": "Adds a SMIL file to the list of SMIL files 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, "description": "The name of the current VHost the action will be performed on", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMILFileConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getSMILFileConfig", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMILFileConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteSMILFileConfig", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putSMILFileConfig", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMILFileConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postSMILFileConfig", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMILFileConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/smilfiles/{smilfileName}/actions/{action}": { "put": { "tags": [ "Virtual Hosts" ], "operationId": "putSMILFileAction", "summary": "SMIL file actions", "description": "SMIL file 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": "smilfileName", "in": "path", "required": true, "description": "The SMIL file, file name needed for this REST call", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getStartupStreamsConfig", "summary": "Get startup stream list", "description": "Retrieves the list of startup streams 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/StartupStreamsConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postStartupStreamsConfig", "summary": "Update startup stream list", "description": "Adds a startup stream to the list of startup streams 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/StartupStreamConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getStartupStreamConfig", "summary": "Get startup stream", "description": "Retrieves the specified startup stream 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": "streamName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/StartupStreamConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteStartupStreamConfig", "summary": "Delete startup stream", "description": "Deletes the specified startup stream 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": "streamName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postStartupStreamConfig", "summary": "Create startup stream", "description": "Adds the specified startup stream 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": "streamName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/StartupStreamConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putStartupStreamConfig", "summary": "Update startup stream", "description": "Updates the specified startup stream 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": "streamName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/StartupStreamConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getStreamFilesConfig", "summary": "Get stream file list", "description": "Retrieves the list of stream files 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/StreamFilesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postStreamFilesConfig", "summary": "Update stream file list", "description": "Adds a stream file to the list of stream files 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/StreamFileConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getStreamFileConfig", "summary": "Get stream file", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamFileConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteStreamFileConfig", "summary": "Delete stream file", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putStreamFileConfig", "summary": "Update stream file", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamFileConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postStreamFileConfig", "summary": "Create stream file", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamFileConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/actions/{action}": { "put": { "tags": [ "Virtual Hosts" ], "operationId": "putStreamFileAction", "summary": "Stream file actions", "description": "Stream file 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": "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" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/adv": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getStreamFileConfigAdv", "summary": "Get stream file (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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamFileConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putStreamFileConfigAdv", "summary": "Update stream file (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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamFileConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/testPlaybackInfo": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTestPlaybackInfoConfig", "summary": "Get playback info", "description": "Retrieves the playback info 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, "description": "The name of the VHost", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestPlaybackInfoConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getVHostTranscoderConfig", "summary": "Get transcoder", "description": "Retrieves the transcoder configuration 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/TranscoderConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderConfig", "summary": "Update transcoder", "description": "Updates the transcoder configuration 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/TranscoderConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderTemplatesConfig", "summary": "Get transcoder template list", "description": "Retrieves the list of transcoder template configurations 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, "description": "The name of the current VHost the action will be performed on", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplatesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postTranscoderTemplatesConfig", "summary": "Update transcoder template list", "description": "Adds a transcoder templates configuration to 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, "description": "The name of the current VHost the action will be performed on", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplateConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderTemplateConfig", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplateConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderTemplateConfig", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplateConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postTranscoderTemplateConfig", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplateConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteTranscoderTemplateConfig", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/actions/{action}": { "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderTemplateAction", "summary": "Transcoder actions", "description": "Transcoder template 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": "dstEntryName", "in": "query", "required": false, "description": "The destination transcoder template 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": "templateName", "in": "path", "required": true, "description": "The template name needed for this REST call", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/adv": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderTemplateConfigAdv", "summary": "Get transcoder (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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplateConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderTemplateConfigAdv", "summary": "Update transcoder (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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderTemplateConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/decode/overlays/{overlayName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderOverlayDecodeConfig", "summary": "Get transcoder overlay decoder", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderOverlayDecodeConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderOverlayDecodeConfig", "summary": "Update transcoder overlay decoder", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderOverlayDecodeConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteTranscoderOverlayDecodeConfig", "summary": "Delete transcoder overlay decoder", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderEncodesConfig", "summary": "Get transcoder encoder list", "description": "Retrieves the list of transcoder encode configurations 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_" } }, { "name": "templateName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodesConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postTranscoderEncodesConfig", "summary": "Update transcoder encoder list", "description": "Adds a transcoder encode configuration to 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_" } }, { "name": "templateName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodeConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderEncodeConfig", "summary": "Get transcoder encoder", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodeConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postTranscoderEncodeConfig", "summary": "Create transcoder encoder", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodeConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderEncodeConfig", "summary": "Update transcoder encoder", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodeConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteTranscoderEncodeConfig", "summary": "Delete transcoder encoder", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/adv": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderEncodeConfigAdv", "summary": "Get transcoder encoder (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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodeConfigAdv" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderEncodeConfigAdv", "summary": "Update transcoder encoder (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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderEncodeConfigAdv" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderOverlayEncodeConfig", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderOverlayEncodeConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderOverlayEncodeConfig", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderOverlayEncodeConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteTranscoderOverlayEncodeConfig", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderStreamNameGroupsConfig", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderStreamNameGroupsConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postTranscoderStreamNameGroupsConfig", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderStreamNameGroupConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups/{groupName}": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getTranscoderStreamNameGroupConfig", "summary": "Get transcoder stream name group", "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" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderStreamNameGroupConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putTranscoderStreamNameGroupConfig", "summary": "Update transcoder stream name group", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderStreamNameGroupConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Virtual Hosts" ], "operationId": "postTranscoderStreamNameGroupConfig", "summary": "Create transcoder stream name group", "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscoderStreamNameGroupConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Virtual Hosts" ], "operationId": "deleteTranscoderStreamNameGroupConfig", "summary": "Delete transcoder stream name group", "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" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/tune": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getVHostTuneConfig", "summary": "Get tuning config", "description": "Retrieves the tuning configuration 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, "description": "The vhost name", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostTuneConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putVHostTuneConfig", "summary": "Update tuning config", "description": "Updates the tuning configuration 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, "description": "The vhost name", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VHostTuneConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/vhosts/{vhostName}/tunehostports": { "get": { "tags": [ "Virtual Hosts" ], "operationId": "getHostportsTuneConfig", "summary": "Get host port", "description": "Retrieves the host port configuration used for server tuning 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, "description": "The vhost name", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostportsTuneConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Virtual Hosts" ], "operationId": "putHostportsTuneConfig", "summary": "Update host port", "description": "Updates the host port configuration used for server tuning 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, "description": "The vhost name", "schema": { "type": "string", "default": "_defaultVHost_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostportsTuneConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/webhooks": { "get": { "tags": [ "Webhooks" ], "operationId": "getWebhooksConfig", "summary": "Get webhook config", "description": "Get all webhooks 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksConfig" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Webhooks" ], "operationId": "putWebhooksConfig", "summary": "Update webhook config", "description": "Replace the full webhooks JSON. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksConfig" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/webhooks/filters": { "get": { "tags": [ "Webhooks" ], "operationId": "getFiltersList", "summary": "Get filter list", "description": "List all filters. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiltersList" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Webhooks" ], "operationId": "postFiltersList", "summary": "Create filter list", "description": "Creates a list of filters. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiltersList" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/webhooks/filters/{id}": { "get": { "tags": [ "Webhooks" ], "operationId": "getFilterItem", "summary": "Get filter", "description": "Get filter. 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": "id", "in": "path", "required": true, "description": "Filter id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterItem" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Webhooks" ], "operationId": "putFilterItem", "summary": "Update filter", "description": "Create/replace filter. 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": "id", "in": "path", "required": true, "description": "Filter id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterItem" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Webhooks" ], "operationId": "deleteFilterItem", "summary": "Delete filter", "description": "Delete filter. 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": "id", "in": "path", "required": true, "description": "Filter id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/webhooks/source": { "get": { "tags": [ "Webhooks" ], "operationId": "getSourceItem", "summary": "Get source", "description": "Get source. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceItem" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Webhooks" ], "operationId": "putSourceItem", "summary": "Update source", "description": "Create/replace source. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceItem" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/webhooks/targets": { "get": { "tags": [ "Webhooks" ], "operationId": "getTargetsList", "summary": "Get target list", "description": "List all targets. 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_" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetsList" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Webhooks" ], "operationId": "postTargetsList", "summary": "Create target list", "description": "Creates a list of targets. 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_" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetsList" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } }, "/v2/servers/{serverName}/webhooks/targets/{id}": { "get": { "tags": [ "Webhooks" ], "operationId": "getTargetItem", "summary": "Get target", "description": "Get target. 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": "id", "in": "path", "required": true, "description": "Target id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetItem" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Webhooks" ], "operationId": "putTargetItem", "summary": "Update target", "description": "Create/replace target. 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": "id", "in": "path", "required": true, "description": "Target id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetItem" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Webhooks" ], "operationId": "deleteTargetItem", "summary": "Delete target", "description": "Delete target. 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": "id", "in": "path", "required": true, "description": "Target id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "402": { "description": "Payment Required" }, "404": { "description": "Not found" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "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" ] }, "SDPFileAppConfig": { "type": "object", "properties": { "name": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "uri": { "type": "string" } }, "required": [ "version", "serverName", "name", "uri" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "DvrRESTConverterStoreAction": { "type": "object", "properties": { "dvrStoreName": { "type": "string" }, "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName", "dvrStoreName" ] }, "SDPFileAppAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "sdpfileName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "sdpfileName" ] }, "StreamRecorderAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" }, "recorderName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName", "recorderName" ] }, "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" ] }, "MpegTSFilter": { "type": "object", "properties": { "name": { "type": "string" }, "mpegtsProgramID": { "type": "string" }, "mpegtsVideoPID": { "type": "string" }, "mpegtsAudioPID": { "type": "string" } }, "required": [ "name", "mpegtsProgramID", "mpegtsVideoPID", "mpegtsAudioPID" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "ApplicationAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName" ] }, "PushPublishCloudStorageProvidersConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "providers" ] }, "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" ] }, "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" ] }, "PushPublishStreamAppAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "appName": { "type": "string" }, "entryName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "entryName" ] }, "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" ] }, "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" ] }, "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" ] }, "DvrRESTConverterStoresAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName", "dvrsonverterstore" ] }, "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" ] }, "ShortObject": { "type": "object", "properties": { "id": { "type": "string" }, "href": { "type": "string" } }, "required": [ "id", "href" ] }, "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" ] }, "HistoricApplicationStatistics": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "entries" ] }, "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" ] }, "VerimatrixStreamMapConfig": { "type": "object", "properties": { "posCount": { "type": "integer", "format": "int32" }, "keyInterval": { "type": "integer", "format": "int32" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "streamName": { "type": "string" }, "resID": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "required": [ "version", "serverName", "streamName", "order", "resID", "posCount", "keyInterval" ] }, "MediaCacheApplicationStoreAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName" ] }, "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" ] }, "StreamFileAppAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "streamfileName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "streamfileName" ] }, "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" ] }, "SMILFileAppAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "smilfileName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "smilfileName" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "DvrRESTConverterStore": { "type": "object", "properties": { "dvrStoreName": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "DvrConverterStore": { "type": "object" } }, "required": [ "version", "serverName", "dvrStoreName", "DvrConverterStore" ] }, "BuyDRMStreamMapsConfig": { "type": "object", "properties": { "buyDRMStreamMaps": { "items": { "$ref": "#/components/schemas/BuyDRMStreamMapConfig" }, "type": "array" }, "buyDRMStreamNameMapFile": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "buyDRMStreamMaps", "buyDRMStreamNameMapFile" ] }, "Long": { "type": "object", "properties": {} }, "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" ] }, "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" ] }, "BuyDRMStreamMapConfig": { "type": "object", "properties": { "contentID": { "type": "string" }, "serverName": { "type": "string" }, "keyID": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "mediaID": { "type": "string" }, "version": { "type": "string" }, "streamName": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "required": [ "version", "serverName", "streamName", "order", "keyID", "contentID", "mediaID" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "Output": { "type": "object", "properties": { "rtmp": { "$ref": "#/components/schemas/RTMP" }, "video": { "$ref": "#/components/schemas/VideoSettings" } }, "required": [ "rtmp", "video" ] }, "IncomingStreamAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" }, "streamName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName", "streamName" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "StreamGroupAction": { "type": "object", "properties": { "groupName": { "type": "string" }, "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName", "groupName" ] }, "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" ] }, "SourceControlAction": { "type": "object", "properties": { "serverName": { "type": "string" } }, "required": [ "serverName" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "Integer": { "type": "object", "properties": {} }, "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" ] }, "TranscoderTemplateAppAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "templateName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "templateName" ] }, "InstanceAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "instanceName": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "appName", "instanceName" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "CurrentMachineStatistics": { "type": "object", "properties": { "heapUsed": { "$ref": "#/components/schemas/Long" }, "cpuSystem": { "$ref": "#/components/schemas/Integer" }, "connectionCount": { "$ref": "#/components/schemas/Long" }, "memoryFree": { "$ref": "#/components/schemas/Long" }, "cpuIdle": { "$ref": "#/components/schemas/Integer" }, "serverName": { "type": "string" }, "memoryUsed": { "$ref": "#/components/schemas/Long" }, "version": { "type": "string" }, "diskFree": { "$ref": "#/components/schemas/Long" }, "cpuUser": { "$ref": "#/components/schemas/Integer" }, "diskUsed": { "$ref": "#/components/schemas/Long" }, "heapFree": { "$ref": "#/components/schemas/Long" }, "serverUptime": { "type": "integer", "format": "int64" }, "saveFieldList": { "type": "array", "items": { "type": "string" } } }, "required": [ "version", "serverName", "serverUptime", "cpuIdle", "cpuUser", "cpuSystem", "memoryFree", "memoryUsed", "heapFree", "heapUsed", "diskFree", "diskUsed", "connectionCount" ] }, "HistoricMachineStatistics": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "entries" ] }, "ServerLicensesConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "licenseList": { "type": "array", "items": { "type": "string" } }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "licenseList" ] }, "ServerListenersConfig": { "type": "object", "properties": { "serverListeners": { "type": "array", "items": { "$ref": "#/components/schemas/ServerListenerConfig" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "serverListeners" ] }, "ServerListenerConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "baseClass": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "required": [ "version", "serverName", "order", "baseClass" ] }, "WMSLoggerConfig": { "type": "object", "properties": { "logLevel": { "type": "string" }, "name": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "name", "logLevel" ] }, "Log4js": { "type": "object", "properties": { "loggers": { "type": "array", "items": { "$ref": "#/components/schemas/Log4js" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "loggers" ] }, "Log4jsAction": { "type": "object", "properties": { "serverName": { "type": "string" } }, "required": [ "serverName" ] }, "Log4jAction": { "type": "object", "properties": { "serverName": { "type": "string" }, "loggerName": { "type": "string" } }, "required": [ "serverName", "loggerName" ] }, "MediaCacheSourcesConfig": { "type": "object", "properties": { "sources": { "type": "array", "items": { "$ref": "#/components/schemas/ShortObject" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "sources" ] }, "MediaCacheSourceConfigAdv": { "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" ] }, "MediaCacheSourceConfig": { "type": "object", "properties": { "readerClass": { "type": "string" }, "isPassThru": { "type": "boolean" }, "minTimeToLive": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "baseClass": { "type": "string" }, "type": { "type": "string" }, "isAmazonS3": { "type": "boolean" }, "s3BucketNameInDomain": { "type": "boolean" }, "googleServicePrivateKeyFile": { "type": "string" }, "googleServiceID": { "type": "string" }, "googleServicePrivateKeyPassword": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "azureAccountKey": { "type": "string" }, "awsSecretAccessKey": { "type": "string" }, "azureAccountName": { "type": "string" }, "awsAccessKeyId": { "type": "string" }, "httpReaderFactoryClass": { "type": "string" }, "googleServiceKey": { "type": "string" }, "azureContainerName": { "type": "string" }, "version": { "type": "string" }, "basePath": { "type": "string" }, "googleEncMethod": { "type": "string" }, "name": { "type": "string" }, "maxTimeToLive": { "type": "integer", "format": "int64" } }, "required": [ "version", "serverName", "name", "type", "description", "basePath", "prefix", "minTimeToLive", "maxTimeToLive", "isAmazonS3", "s3BucketNameInDomain", "awsAccessKeyId", "awsSecretAccessKey", "isPassThru", "baseClass", "readerClass", "httpReaderFactoryClass", "azureAccountName", "azureContainerName", "azureAccountKey", "googleServiceID", "googleServiceKey", "googleServicePrivateKeyFile", "googleServicePrivateKeyPassword", "googleEncMethod" ] }, "MediaCacheConfigAdv": { "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" ] }, "MediaCacheStoresConfig": { "type": "object", "properties": { "stores": { "type": "array", "items": { "$ref": "#/components/schemas/ShortObject" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "stores" ] }, "MediaCacheConfig": { "type": "object", "properties": { "maxPendingWriteRequestSizeAutoValue": { "type": "string" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCacheSourceConfig" } }, "stores": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCacheStoreConfig" } }, "serverName": { "type": "string" }, "version": { "type": "string" }, "maxPendingReadAheadRequestSizeAutoValue": { "type": "string" }, "readAheadThreadPoolSizeAutoValue": { "type": "string" }, "readAheadThreadPoolSize": { "type": "string" }, "maxPendingReadAheadRequestSize": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "maxPendingWriteRequestSize": { "type": "string" }, "writerThreadPoolSizeAutoValue": { "type": "string" }, "writerThreadPoolSize": { "type": "string" } }, "required": [ "version", "serverName", "writerThreadPoolSize", "writerThreadPoolSizeAutoValue", "readAheadThreadPoolSize", "readAheadThreadPoolSizeAutoValue", "maxPendingWriteRequestSize", "maxPendingWriteRequestSizeAutoValue", "maxPendingReadAheadRequestSize", "maxPendingReadAheadRequestSizeAutoValue", "stores", "sources" ] }, "MediaCacheStoreConfigAdv": { "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" ] }, "MediaCacheStoreConfig": { "type": "object", "properties": { "path": { "type": "string" }, "writeRate": { "type": "string" }, "name": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "maxSize": { "type": "string" }, "writeRateMaxBucketSize": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "name", "description", "path", "maxSize", "writeRate", "writeRateMaxBucketSize" ] }, "MediaCacheSourceConfig3": { "type": "object", "properties": { "readerClass": { "type": "string" }, "isPassThru": { "type": "boolean" }, "minTimeToLive": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "baseClass": { "type": "string" }, "type": { "type": "string" }, "isAmazonS3": { "type": "boolean" }, "s3BucketNameInDomain": { "type": "boolean" }, "googleServicePrivateKeyFile": { "type": "string" }, "googleServiceID": { "type": "string" }, "googleServicePrivateKeyPassword": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "azureAccountKey": { "type": "string" }, "awsSecretAccessKey": { "type": "string" }, "azureAccountName": { "type": "string" }, "awsAccessKeyId": { "type": "string" }, "httpReaderFactoryClass": { "type": "string" }, "googleServiceKey": { "type": "string" }, "azureContainerName": { "type": "string" }, "version": { "type": "string" }, "basePath": { "type": "string" }, "googleEncMethod": { "type": "string" }, "sourceName": { "type": "string" }, "maxTimeToLive": { "type": "integer", "format": "int64" } }, "required": [ "version", "serverName", "sourceName", "type", "description", "basePath", "prefix", "minTimeToLive", "maxTimeToLive", "isAmazonS3", "s3BucketNameInDomain", "awsAccessKeyId", "awsSecretAccessKey", "isPassThru", "baseClass", "readerClass", "httpReaderFactoryClass", "azureAccountName", "azureContainerName", "azureAccountKey", "googleServiceID", "googleServiceKey", "googleServicePrivateKeyFile", "googleServicePrivateKeyPassword", "googleEncMethod" ] }, "MediaCacheConfig3": { "type": "object", "properties": { "maxPendingWriteRequestSizeAutoValue": { "type": "string" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCacheSourceConfig3" } }, "stores": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCacheStoreConfig3" } }, "serverName": { "type": "string" }, "version": { "type": "string" }, "maxPendingReadAheadRequestSizeAutoValue": { "type": "string" }, "readAheadThreadPoolSizeAutoValue": { "type": "string" }, "readAheadThreadPoolSize": { "type": "string" }, "maxPendingReadAheadRequestSize": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "maxPendingWriteRequestSize": { "type": "string" }, "writerThreadPoolSizeAutoValue": { "type": "string" }, "writerThreadPoolSize": { "type": "string" } }, "required": [ "version", "serverName", "writerThreadPoolSize", "writerThreadPoolSizeAutoValue", "readAheadThreadPoolSize", "readAheadThreadPoolSizeAutoValue", "maxPendingWriteRequestSize", "maxPendingWriteRequestSizeAutoValue", "maxPendingReadAheadRequestSize", "maxPendingReadAheadRequestSizeAutoValue", "stores", "sources" ] }, "MediaCacheStoreConfig3": { "type": "object", "properties": { "path": { "type": "string" }, "writeRate": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "storeName": { "type": "string" }, "maxSize": { "type": "string" }, "writeRateMaxBucketSize": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "storeName", "description", "path", "maxSize", "writeRate", "writeRateMaxBucketSize" ] }, "MediaCacheSourceConfigAdv3": { "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" ] }, "MediaCacheSourcesConfig3": { "type": "object", "properties": { "sources": { "type": "array", "items": { "$ref": "#/components/schemas/ShortObject" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "sources" ] }, "MediaCacheStoresConfig3": { "type": "object", "properties": { "stores": { "type": "array", "items": { "$ref": "#/components/schemas/ShortObject" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "stores" ] }, "MediaCastersConfig": { "type": "object", "properties": { "mediaCasters": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCasterConfig" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "mediaCasters" ] }, "MediaCasterConfig": { "type": "object", "properties": { "streamType": { "type": "string" }, "keepAliveTime": { "type": "string" }, "name": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "baseClass": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "connectionTimeout": { "type": "string" } }, "required": [ "version", "serverName", "name", "description", "streamType", "baseClass", "connectionTimeout", "keepAliveTime" ] }, "HistoricServerStatistics": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "entries" ] }, "MonitoringConfig": { "type": "object", "properties": { "debugEnable": { "type": "boolean" }, "enable": { "type": "boolean" }, "databaseDebugEnable": { "type": "boolean" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "enable", "debugEnable", "databaseDebugEnable" ] }, "PublishersConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "publishers": { "type": "array", "items": { "$ref": "#/components/schemas/PublisherConfig" } }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "publishers" ] }, "PublisherConfig": { "type": "object", "properties": { "password": { "type": "string" }, "name": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "name", "description", "password" ] }, "PublishersConfig3": { "type": "object", "properties": { "serverName": { "type": "string" }, "publishers": { "type": "array", "items": { "$ref": "#/components/schemas/PublisherConfig3" } }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "publishers" ] }, "PublisherConfig3": { "type": "object", "properties": { "password": { "type": "string" }, "serverName": { "type": "string" }, "publisher": { "type": "string" }, "description": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "publisher", "description", "password" ] }, "RESTInfoConfig": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int32" }, "serverName": { "type": "string" }, "centralConfig": { "type": "boolean" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "restBuild": { "type": "string" }, "licenseValid": { "type": "boolean" } }, "required": [ "version", "serverName", "apiVersion", "restBuild", "centralConfig", "properties", "licenseValid" ] }, "ServerConfigAdv": { "type": "object", "properties": { "serverListeners": { "type": "array", "items": { "$ref": "#/components/schemas/ServerListenerConfig" } }, "advancedSettings": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSetting" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "advancedSettings", "serverListeners" ] }, "ServerLogsConfig": { "type": "object", "properties": { "endOffset": { "type": "integer", "format": "int64" }, "logStartDate": { "type": "string" }, "logDate": { "type": "string" }, "endDate": { "type": "string" }, "serverName": { "type": "string" }, "version": { "type": "string" }, "logLines": { "type": "array", "items": { "type": "string" } }, "filterStr": { "type": "string" }, "retLineCount": { "type": "integer", "format": "int64" }, "logFields": { "type": "string" }, "logSoftware": { "type": "string" }, "startOffset": { "type": "integer", "format": "int64" }, "searchStr": { "type": "string" }, "regexSearch": { "type": "boolean" }, "logVersion": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "fileLength": { "type": "integer", "format": "int64" }, "startDate": { "type": "string" } }, "required": [ "version", "serverName", "retLineCount", "startOffset", "endOffset", "fileLength", "filterStr", "logFields", "logVersion", "logStartDate", "logSoftware", "logDate", "logLines", "searchStr", "regexSearch", "startDate", "endDate" ] }, "VHostListenersConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "vhostListeners": { "type": "array", "items": { "$ref": "#/components/schemas/VHostListenerConfig" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "vhostListeners" ] }, "ServerLogShortObject": { "type": "object", "properties": { "fileSize": { "type": "integer", "format": "int64" }, "startDateMS": { "type": "integer", "format": "int64" }, "id": { "type": "string" }, "href": { "type": "string" } }, "required": [ "id", "href", "fileSize", "startDateMS" ] }, "ServerLogTypesConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "serverLogType": { "type": "array", "items": { "type": "string" } }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "serverLogType" ] }, "ServersConfig": { "type": "object", "properties": { "servers": { "type": "array", "items": { "$ref": "#/components/schemas/ServerConfig" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "servers" ] }, "ServerLogFileDownloadConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName" ] }, "ServerLogFileConfig": { "type": "object", "properties": { "endOffset": { "type": "integer", "format": "int64" }, "logStartDate": { "type": "string" }, "logDate": { "type": "string" }, "endDate": { "type": "string" }, "serverName": { "type": "string" }, "version": { "type": "string" }, "logLines": { "type": "array", "items": { "type": "string" } }, "filterStr": { "type": "string" }, "retLineCount": { "type": "integer", "format": "int64" }, "logFields": { "type": "string" }, "logSoftware": { "type": "string" }, "startOffset": { "type": "integer", "format": "int64" }, "searchStr": { "type": "string" }, "regexSearch": { "type": "boolean" }, "logVersion": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "fileLength": { "type": "integer", "format": "int64" }, "startDate": { "type": "string" } }, "required": [ "version", "serverName", "retLineCount", "startOffset", "endOffset", "fileLength", "filterStr", "logFields", "logVersion", "logStartDate", "logSoftware", "logDate", "logLines", "searchStr", "regexSearch", "startDate", "endDate" ] }, "ServerConfig": { "type": "object", "properties": { "transportThreadPoolAutoValue": { "type": "string" }, "handlerThreadPool": { "type": "string" }, "transportThreadPool": { "type": "string" }, "ipAddress": { "type": "string" }, "serverId1": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "rtpDataPortSharingPort": { "type": "integer", "format": "int32" }, "version": { "type": "string" }, "serverId2": { "type": "string" }, "serverTS": { "type": "integer", "format": "int64" }, "port": { "type": "integer", "format": "int32" }, "serverListeners": { "$ref": "#/components/schemas/ServerListenersConfig" }, "name": { "type": "string" }, "rtpDataPortSharing": { "type": "boolean" }, "handlerThreadPoolAutoValue": { "type": "string" }, "defaultStreamPrefix": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } } }, "required": [ "version", "serverName", "name", "description", "defaultStreamPrefix", "ipAddress", "port", "handlerThreadPool", "handlerThreadPoolAutoValue", "transportThreadPool", "transportThreadPoolAutoValue", "rtpDataPortSharing", "rtpDataPortSharingPort", "serverListeners", "serverId1", "serverId2", "serverTS" ] }, "VHostListenerConfig": { "type": "object", "properties": { "baseclass": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "required": [ "version", "serverName", "order", "baseclass" ] }, "SourceDriverNamesList": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "list": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "list" ] }, "ServerAction": { "type": "object", "properties": { "serverName": { "type": "string" } }, "required": [ "serverName" ] }, "ServerLogFilesConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "serverLogFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ServerLogShortObject" } } }, "required": [ "version", "serverName", "serverLogFiles" ] }, "ServerStatusConfig": { "type": "object", "properties": { "transcoderWatermark": { "type": "boolean" }, "serverVersion": { "type": "string" }, "gpuAcceleration": { "type": "string" }, "wseName": { "type": "string" }, "transcoderLicensed": { "type": "boolean" }, "javaMaxHeapSize": { "type": "string" }, "transcoderLicensesInUse": { "type": "integer", "format": "int32" }, "javaVersion": { "type": "string" }, "httpOriginAvailable": { "type": "boolean" }, "serverName": { "type": "string" }, "osArchitecture": { "type": "string" }, "drmApplications": { "type": "array", "items": { "type": "string" } }, "javaVMVersion": { "type": "string" }, "transcoderLicenses": { "type": "integer", "format": "int32" }, "timeRunning": { "type": "number", "format": "double" }, "licenseType": { "type": "string" }, "osBitness": { "type": "string" }, "dvrApplications": { "type": "array", "items": { "type": "string" } }, "osVersion": { "type": "string" }, "serverBuild": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "javaName": { "type": "string" }, "maxConnections": { "type": "integer", "format": "int64" }, "dvrLicensed": { "type": "boolean" }, "serverMode": { "type": "string" }, "javaBitness": { "type": "string" }, "currentConnections": { "type": "integer", "format": "int64" }, "drmLicensed": { "type": "boolean" }, "javaVendor": { "type": "string" }, "osName": { "type": "string" }, "version": { "type": "string" }, "transcoderApplications": { "type": "array", "items": { "type": "string" } }, "transcoderAvailable": { "type": "boolean" }, "javaHome": { "type": "string" }, "maxIncommingStreams": { "type": "integer", "format": "int64" }, "totalMemory": { "type": "integer", "format": "int64" }, "availableMemory": { "type": "integer", "format": "int64" }, "nativeBase": { "type": "string" }, "dvrInUse": { "type": "boolean" }, "drmInUse": { "type": "boolean" }, "licenseExpireDate": { "type": "string" }, "processorCores": { "type": "integer", "format": "int32" }, "restAPIAvailable": { "type": "boolean" } }, "required": [ "version", "serverName", "wseName", "serverVersion", "serverBuild", "licenseType", "licenseExpireDate", "serverMode", "osName", "osVersion", "osArchitecture", "osBitness", "totalMemory", "availableMemory", "processorCores", "gpuAcceleration", "javaVersion", "javaVMVersion", "javaBitness", "javaName", "javaVendor", "javaHome", "javaMaxHeapSize", "timeRunning", "currentConnections", "maxConnections", "maxIncommingStreams", "restAPIAvailable", "httpOriginAvailable", "transcoderLicensed", "transcoderAvailable", "transcoderWatermark", "transcoderLicenses", "transcoderLicensesInUse", "transcoderApplications", "dvrLicensed", "dvrInUse", "dvrApplications", "drmLicensed", "drmInUse", "drmApplications", "nativeBase" ] }, "TranscoderConfig": { "type": "object", "properties": { "licenses": { "type": "integer", "format": "int32" }, "licensed": { "type": "boolean" }, "licensesInUse": { "type": "integer", "format": "int32" }, "available": { "type": "boolean" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "templates": { "$ref": "#/components/schemas/TranscoderTemplatesConfig" }, "version": { "type": "string" } }, "required": [ "version", "serverName", "available", "licensed", "licenses", "licensesInUse", "templates" ] }, "ServerTuneConfig": { "type": "object", "properties": { "heapSizeCurrent": { "type": "integer", "format": "int64" }, "garbageCollectorCurrent": { "type": "string" }, "serverName": { "type": "string" }, "heapSize": { "type": "string" }, "garbageCollector": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "heapSize", "heapSizeCurrent", "garbageCollector", "garbageCollectorCurrent" ] }, "UsersConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } } }, "required": [ "version", "serverName", "users" ] }, "UserConfig": { "type": "object", "properties": { "password": { "type": "string" }, "passwordEncoding": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "realm": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "userName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "version", "serverName", "userName", "description", "groups", "password", "passwordEncoding", "realm" ] }, "HostPortConfigAdv": { "type": "object", "properties": { "processorCountAutoValue": { "type": "integer", "format": "int32" }, "port": { "type": "string" }, "processorCount": { "type": "string" }, "advancedSettings": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSetting" } }, "name": { "type": "string" }, "ipAddress": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "version": { "type": "string" } }, "required": [ "version", "serverName", "advancedSettings", "name", "type", "ipAddress", "port", "processorCount", "processorCountAutoValue" ] }, "MediaCacheStoreList": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "mediacacheitemlist": { "type": "array", "items": { "type": "string" } } }, "required": [ "version", "serverName", "mediacacheitemlist" ] }, "PublishersVhostConfig": { "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" ] }, "HostPortsConfig": { "type": "object", "properties": { "hostports": { "type": "array", "items": { "$ref": "#/components/schemas/ShortObject" } }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "hostports" ] }, "StartupStreamsConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "Streams": { "type": "array", "items": { "$ref": "#/components/schemas/StartupStreamConfig" } } }, "required": [ "version", "serverName", "Streams" ] }, "VHostsConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "vhosts": { "type": "array", "items": { "$ref": "#/components/schemas/VHostShortObject" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "vhosts" ] }, "Boolean": { "type": "object", "properties": {} }, "HTTPProviderConfig": { "type": "object", "properties": { "requestFilters": { "type": "string" }, "authenticationMethod": { "type": "string" }, "serverName": { "type": "string" }, "baseClass": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "baseClass", "requestFilters", "authenticationMethod" ] }, "TranscoderStreamNameGroupsConfig": { "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" ] }, "SDPFileConfig": { "type": "object", "properties": { "name": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "uri": { "type": "string" } }, "required": [ "version", "serverName", "name", "uri" ] }, "HostportsTuneConfig": { "type": "object", "properties": { "hostports": { "type": "array", "items": { "$ref": "#/components/schemas/HostPortConfigAdv" } }, "name": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "name", "hostports" ] }, "MediaCacheStoreAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName" ] }, "TranscoderTemplateAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "templateName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "templateName" ] }, "SMILFilesConfig": { "type": "object", "properties": { "vhostName": { "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" ] }, "VHostShortObject": { "type": "object", "properties": { "connectingSSLEnable": { "type": "boolean" }, "connectingIPAddress": { "type": "string" }, "connectingPort": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "href": { "type": "string" } }, "required": [ "id", "href", "connectingIPAddress", "connectingPort", "connectingSSLEnable" ] }, "StreamFilesConfig": { "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" ] }, "VHostAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName" ] }, "SMILFileAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "smilfileName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "smilfileName" ] }, "HistoricVHostStatistics": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "entries" ] }, "VHostConfig": { "type": "object", "properties": { "testPlayerSSLEnable": { "type": "string" }, "securityPublishValidEncoders": { "type": "string" }, "serverName": { "type": "string" }, "description": { "type": "string" }, "maximumConcurrentTranscodes": { "type": "integer", "format": "int32" }, "srtListenerLocalPort": { "type": "integer", "format": "int32" }, "version": { "type": "string" }, "configurationDir": { "type": "string" }, "testPlayerPort": { "type": "string" }, "running": { "type": "boolean" }, "HostPorts": { "type": "array", "items": { "$ref": "#/components/schemas/HostPortConfig" } }, "connectionLimit": { "type": "integer", "format": "int32" }, "testPlayerIPAddress": { "type": "string" }, "name": { "type": "string" }, "srtListenerLocalIPAddress": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "srtPassPhrase": { "type": "string" } }, "required": [ "version", "serverName", "name", "description", "running", "configurationDir", "connectionLimit", "testPlayerIPAddress", "testPlayerPort", "testPlayerSSLEnable", "maximumConcurrentTranscodes", "securityPublishValidEncoders", "HostPorts", "srtListenerLocalIPAddress", "srtListenerLocalPort", "srtPassPhrase" ] }, "SMILFileConfig": { "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" ] }, "TranscoderTemplateConfig": { "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" ] }, "SDPFilesConfig": { "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" ] }, "SSLConfig": { "type": "object", "properties": { "sslKeyStorePassword": { "type": "string" }, "sslProtocols": { "type": "array", "items": { "type": "string" } }, "sslDomainToKeyStoreMapPath": { "type": "string" }, "sslCipherSuites": { "type": "array", "items": { "type": "string" } }, "serverName": { "type": "string" }, "sslKeyStoreType": { "type": "string" }, "sslProtocol": { "type": "string" }, "sslAlgorithm": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "sslKeyStorePath": { "type": "string" }, "version": { "type": "string" }, "sslEnable": { "type": "boolean" } }, "required": [ "version", "serverName", "sslEnable", "sslKeyStorePath", "sslKeyStorePassword", "sslKeyStoreType", "sslDomainToKeyStoreMapPath", "sslProtocol", "sslAlgorithm", "sslCipherSuites", "sslProtocols" ] }, "TranscoderEncodeConfigAdv": { "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" ] }, "SDPFileAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "sdpfileName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "sdpfileName" ] }, "StreamFileConfig": { "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" ] }, "TranscoderTemplateConfigAdv": { "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" ] }, "TestPlaybackInfoConfig": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "applications": { "$ref": "#/components/schemas/ApplicationsConfig" } }, "required": [ "version", "serverName", "testPlayers", "applications", "instances" ] }, "CurrentVHostStatistics": { "type": "object", "properties": { "totalConnections": { "$ref": "#/components/schemas/Long" }, "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" } }, "required": [ "version", "serverName", "uptime", "bytesIn", "bytesOut", "totalConnections", "connectionCount" ] }, "TranscoderEncodesConfig": { "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" ] }, "StartupStreamConfig": { "type": "object", "properties": { "mediaCasterType": { "type": "string" }, "instance": { "type": "string" }, "appName": { "type": "string" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "streamName": { "type": "string" } }, "required": [ "version", "serverName", "streamName", "appName", "instance", "mediaCasterType" ] }, "HostPortConfig": { "type": "object", "properties": { "sslDomainToKeyStoreMapPath": { "type": "string" }, "ipAddress": { "type": "string" }, "serverName": { "type": "string" }, "sslKeyStoreType": { "type": "string" }, "HTTPProviders": { "type": "array", "items": { "$ref": "#/components/schemas/HTTPProviderConfig" } }, "sslAlgorithm": { "type": "string" }, "type": { "type": "string" }, "sslKeyStorePath": { "type": "string" }, "version": { "type": "string" }, "ssl": { "type": "array", "items": { "type": "string" } }, "sslEnable": { "type": "boolean" }, "sslKeyStorePassword": { "type": "string" }, "sslProtocols": { "type": "array", "items": { "type": "string" } }, "webRtcEnable": { "$ref": "#/components/schemas/Boolean" }, "port": { "type": "string" }, "name": { "type": "string" }, "sslProtocol": { "type": "string" }, "sslDomains": { "type": "array", "items": { "type": "string" } }, "saveFieldList": { "type": "array", "items": { "type": "string" } } }, "required": [ "version", "serverName", "name", "type", "port", "ipAddress", "sslEnable", "sslKeyStorePath", "sslKeyStorePassword", "sslKeyStoreType", "sslDomainToKeyStoreMapPath", "sslProtocol", "sslAlgorithm", "ssl", "sslProtocols", "sslDomains", "webRtcEnable", "HTTPProviders" ] }, "StreamFileConfigAdv": { "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" ] }, "VHostConfigAdv": { "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" ] }, "VHostTuneConfig": { "type": "object", "properties": { "multicastOutgoingProcessorCountAutoValue": { "type": "string" }, "netConnectionsProcessorCountAutoValue": { "type": "string" }, "idleWorkerCountAutoValue": { "type": "string" }, "unicastIncomingProcessorCountAutoValue": { "type": "string" }, "unicastOutgoingProcessorCountAutoValue": { "type": "string" }, "mediaCasterProcessorCount": { "type": "string" }, "serverName": { "type": "string" }, "multicastOutgoingProcessorCount": { "type": "string" }, "multicastIncomingProcessorCountAutoValue": { "type": "string" }, "version": { "type": "string" }, "netConnectionsProcessorCount": { "type": "string" }, "unicastOutgoingProcessorCount": { "type": "string" }, "mediaCasterProcessorCountAutoValue": { "type": "string" }, "idleWorkerCount": { "type": "string" }, "transportThreadPoolSize": { "type": "integer", "format": "int32" }, "clientIdleFrequency": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "unicastIncomingProcessorCount": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "multicastIncomingProcessorCount": { "type": "string" }, "rtpIdleFrequency": { "type": "integer", "format": "int32" }, "handlerThreadPoolSize": { "type": "integer", "format": "int32" } }, "required": [ "version", "serverName", "name", "netConnectionsProcessorCount", "netConnectionsProcessorCountAutoValue", "mediaCasterProcessorCount", "mediaCasterProcessorCountAutoValue", "idleWorkerCount", "idleWorkerCountAutoValue", "unicastIncomingProcessorCount", "unicastIncomingProcessorCountAutoValue", "unicastOutgoingProcessorCount", "unicastOutgoingProcessorCountAutoValue", "multicastIncomingProcessorCount", "multicastIncomingProcessorCountAutoValue", "multicastOutgoingProcessorCount", "multicastOutgoingProcessorCountAutoValue", "clientIdleFrequency", "rtpIdleFrequency", "handlerThreadPoolSize", "transportThreadPoolSize" ] }, "StreamFileAction": { "type": "object", "properties": { "vhostName": { "type": "string" }, "streamfileName": { "type": "string" }, "serverName": { "type": "string" } }, "required": [ "serverName", "vhostName", "streamfileName" ] }, "SourceItem": { "type": "object", "properties": { "serverName": { "type": "string" }, "source": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "source" ] }, "TargetItem": { "type": "object", "properties": { "headers": { "type": "array", "items": { "$ref": "#/components/schemas/TargetHeader" } }, "auth": { "$ref": "#/components/schemas/TargetAuth" }, "serverName": { "type": "string" }, "id": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "url": { "type": "string" } }, "required": [ "version", "serverName", "id", "url", "headers", "auth" ] }, "TargetHeader": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] }, "TargetConfig": { "type": "object", "properties": { "headers": { "type": "array", "items": { "$ref": "#/components/schemas/TargetHeader" } }, "auth": { "$ref": "#/components/schemas/TargetAuth" }, "id": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "url", "headers", "auth" ] }, "FilterItem": { "type": "object", "properties": { "retryDelay": { "$ref": "#/components/schemas/Long" }, "retryDelayUnit": { "type": "string" }, "targetRef": { "type": "string" }, "criteria": { "type": "string" }, "serverName": { "type": "string" }, "id": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "enabled": { "$ref": "#/components/schemas/Boolean" }, "maxRetryAttempts": { "$ref": "#/components/schemas/Integer" } }, "required": [ "version", "serverName", "id", "enabled", "criteria", "targetRef", "maxRetryAttempts", "retryDelay", "retryDelayUnit" ] }, "TargetsList": { "type": "object", "properties": { "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetConfig" } } }, "required": [ "version", "serverName", "targets" ] }, "WebhooksConfig": { "type": "object", "properties": { "webhooks": { "$ref": "#/components/schemas/Webhooks" }, "serverName": { "type": "string" }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "webhooks" ] }, "TargetAuth": { "type": "object", "properties": { "secret": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "secret" ] }, "Webhooks": { "type": "object", "properties": { "debugLog": { "$ref": "#/components/schemas/Boolean" }, "source": { "type": "string" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConfig" } }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetConfig" } } }, "required": [ "debugLog", "source", "filters", "targets" ] }, "FilterConfig": { "type": "object", "properties": { "retryDelay": { "$ref": "#/components/schemas/Long" }, "retryDelayUnit": { "type": "string" }, "targetRef": { "type": "string" }, "criteria": { "type": "string" }, "id": { "type": "string" }, "enabled": { "$ref": "#/components/schemas/Boolean" }, "maxRetryAttempts": { "$ref": "#/components/schemas/Integer" } }, "required": [ "id", "enabled", "criteria", "targetRef", "maxRetryAttempts", "retryDelay", "retryDelayUnit" ] }, "FiltersList": { "type": "object", "properties": { "serverName": { "type": "string" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConfig" } }, "saveFieldList": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } }, "required": [ "version", "serverName", "filters" ] } }, "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" } } }, "security": [ { "basicAuth": [] } ] }