openapi: 3.0.3 info: title: Wowza Streaming Engine REST advanced_token_authentication transcoders API description: Complete REST API for Wowza Streaming Engine. Auto-converted from Swagger 1.2 (http://localhost:8089/swagger.json) to OpenAPI 3.0.3 for public documentation. version: 2.0.0 contact: name: Wowza Media Systems url: https://www.wowza.com/docs/wowza-streaming-engine-rest-api license: name: Wowza Media Systems url: https://www.wowza.com servers: - url: http://localhost:8087 description: Wowza Streaming Engine Server security: - basicAuth: [] tags: - name: transcoders description: "Operations related to transcoders, output renditions, and output stream targets.\n ### Transcoders\n Wowza Video transcoders allow you to customize transcoding processes by creating transcoders that are optimized for various network or streaming conditions. When you create a transcoder through the ``/transcoders`` endpoint, you must manually configure output renditions and associated output stream targets.\n\n Transcoders, like live streams, can be adaptive bitrate or passthrough. An adaptive bitrate transcoder generates multiple output renditions of your live stream, at different bitrates. A passthrough transcoder, in contrast, sends the source video to a stream target without performing transcoding. Passthrough transcoders, which can only be created if you have a subscription plan that supports them, accrue processing time, bandwidth, and egress usage, but much less than their adaptive bitrate counterparts.\n ### Output Renditions\n Before you can start an adaptive bitrate transcoder, you must use the ``/transcoders/{transcoder_id}/outputs`` operations to define the adaptive bitrate output renditions that you want the transcoder to create. Passthrough transcoders require only one output rendition because they send source video to a stream target without transcoding.\n ### Output Stream Targets\n Transcoders require output stream targets before you can start them. Although you create and configure stream targets using the different ``/stream_targets`` operations, you must associate a stream target to a transcoder's output rendition using the /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets operations. For an adaptive bitrate transcoder with multiple output renditions defined, you must create output stream targets to associate a stream target to each output rendition. For a passthrough transcoder, you only need one output stream target." x-displayName: Transcoders paths: /transcoders: post: summary: Create a transcoder description: This operation creates a transcoder. operationId: createTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v2.0/transcoders\" \\\n -d $'{\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/transcoder_create_input' description: Provide the details of the transcoder to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: $ref: '#/components/schemas/transcoder' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all transcoders description: This operation shows limited details for all of your transcoders. For detailed information, fetch a single transcoder. operationId: listTranscoders tags: - transcoders parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/transcoders' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' /transcoders/{id}: get: summary: Fetch a transcoder description: This operation shows the details of a specific transcoder. operationId: showTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: $ref: '#/components/schemas/transcoder' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' patch: summary: Update a transcoder description: This operation updates a transcoder. operationId: updateTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17\" \\\n -d $'{\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/transcoder_update_input' description: Provide the details of the transcoder to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: $ref: '#/components/schemas/transcoder' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete a transcoder description: 'This operation deletes a transcoder, including all of its assigned output renditions and stream targets.

Note: You can''t remove transcoders that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ' operationId: deleteTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'DELETE',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/enable_all_stream_targets: put: summary: Enable a transcoder's stream targets description: This operation enables all of the stream targets assigned to a specific transcoder. operationId: enableAllStreamTargetsTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/enable_all_stream_targets\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/enable_all_stream_targets';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder required: - stream_targets properties: stream_targets: type: object title: stream_targets properties: state: type: string description: The state of the transcoder's stream targets. example: enabled enum: - enabled - disabled '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/disable_all_stream_targets: put: summary: Disable a transcoder's stream targets description: This operation disables all of the stream targets assigned to a specific transcoder. operationId: disableAllStreamTargetsTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/disable_all_stream_targets\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/disable_all_stream_targets';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder required: - stream_targets properties: stream_targets: type: object title: stream_targets properties: state: type: string description: The state of the transcoder's stream targets. example: enabled enum: - enabled - disabled '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/start: put: summary: Start a transcoder description: This operation starts a transcoder. operationId: startTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/start\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/start';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: state: type: string description: The state of the transcoder. example: starting enum: - starting - stopping - started - stopped - resetting uptime_id: type: string description: The unique identifier associated with a specific uptime period of a transcoder. example: abcd1234 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/stop: put: summary: Stop a transcoder description: This operation stops a transcoder. operationId: stopTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/stop\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/stop';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: state: type: string description: The state of the transcoder. example: starting enum: - starting - stopping - started - stopped - resetting uptime_id: type: string description: The unique identifier associated with a specific uptime period of a transcoder. example: abcd1234 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/reset: put: summary: Reset a transcoder description: This operation resets a transcoder. operationId: resetTranscoder tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/reset\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/reset';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: state: type: string description: The state of the transcoder. example: resetting enum: - starting - stopping - started - stopped - resetting '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/start_recording: put: summary: Start recording description: 'This operation starts the recording of a transcoder after the transcoder has started. If you want the recording to start and stop automatically when you start or stop the transcoder instead, set _recording_ to **true** when you create a transcoder or update a transcoder.' operationId: startTranscoderRecording tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/start_recording\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/start_recording';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: recording: type: object description: The recording for the transcoder. properties: state: type: string description: The state of video capture for the transcoder. example: started enum: - started - stopped '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/stop_recording: put: summary: Stop recording description: 'This operation stops the recording of a transcoder before the transcoder has stopped. Wowza Video begins converting the recording to an MP4 file after the transcoder has stopped. You can use this operation to manually stop recording even if _recording_ is set to **true** on the transcoder, meaning the recording was automatically started at transcoder start. If you want the recording to start and stop automatically when you start and stop the transcoder, set _recording_ to **true** when you create a transcoder or update a transcoder and then don''t use the manual stop recording operation.' operationId: stopTranscoderRecording tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/stop_recording\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/stop_recording';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: recording: type: object description: The recording for the transcoder. properties: state: type: string description: The state of video capture for the transcoder. example: stopped enum: - started - stopped '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{id}/recordings: get: summary: Fetch a transcoder's recordings description: '
Deprecated in 2.0.
This operation shows limited details of all of the recordings for a specific transcoder. For detailed information about a recording, use the recording ID to fetch a recording.' operationId: listTranscoderRecordings tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/recordings\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/recordings';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - recordings properties: recordings: type: array description: Array of recordings of this transcoder. See /recordings for more details. items: $ref: '#/components/schemas/index_recordings' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/schedules: get: summary: Fetch transcoder's schedules description: This operation shows the details of all of the schedules for a specific transcoder. operationId: listTranscoderSchedules tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/schedules\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/schedules';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - schedules properties: schedules: type: array description: Array of schedules of this transcoder. See /schedules for more details. items: $ref: '#/components/schemas/schedule' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/thumbnail_url: get: summary: Fetch the thumbnail URL of a transcoder description: This operation shows the thumbnail URL of a started transcoder. operationId: showTranscoderThumbnailUrl tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/thumbnail_url\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/thumbnail_url';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: thumbnail_url: type: string description: The URL to receive the preview thumbnail. example: https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/state: get: summary: Fetch the state and uptime ID of a transcoder description: This operation shows the current state and uptime ID of a transcoder. operationId: showTranscoderState tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/state\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/state';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - transcoder properties: transcoder: type: object title: transcoder properties: ip_address: type: string description: The IP address of the transcoder instance. If the transcoder *state* is anything other than **started**, the *ip_address* is **0.0.0.0**. example: 1.2.3.4 state: type: string description: The state of the transcoder. example: started enum: - starting - stopping - started - stopped - resetting uptime_id: type: string description: The unique identifier associated with a specific uptime period of a transcoder. example: abcd1234 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{id}/vod_streams: get: summary: Fetch all VOD streams for a transcoder description: (Available from version 1.5) This operation shows the details of all VOD streams associated to a specific transcoder. operationId: listTranscoderVODStreams tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/vod_streams\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/vod_streams';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/vod_streams' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/uptimes: get: summary: Fetch all uptime records for a transcoder description: This operation shows all of the uptime records for a specific transcoder. An *uptime record* identifies a specific transcoding session. operationId: indexUptimes tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/uptimes\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/uptimes';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/uptimes' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/uptimes/{id}: get: summary: Fetch an uptime record description: This operation shows the details of a specific uptime record for a specific transcoder. An *uptime record* identifies a transcoding session. operationId: showUptime tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/uptimes/1acfg43d\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/uptimes/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the uptime record. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - uptime properties: uptime: $ref: '#/components/schemas/uptime' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/outputs: post: summary: Create an output description: This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder. operationId: createTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs\" \\\n -d $'{\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_create_input' description: Provide the details of the output rendition to create in the body of the request. required: true responses: '201': description: Success content: application/json: schema: type: object required: - output properties: output: $ref: '#/components/schemas/output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all outputs of a transcoder description: This operation shows the details of all of the output renditions of a specific transcoder. operationId: listTranscoderOutputs tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/outputs' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/outputs/{id}: get: summary: Fetch an output description: This operation shows the details of a specific output rendition for a specific transcoder. operationId: showTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - output properties: output: $ref: '#/components/schemas/output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update an output description: This operation updates an output rendition. operationId: updateTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d\" \\\n -d $'{\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_update_input' description: Provide the details of the output rendition to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - output properties: output: $ref: '#/components/schemas/output' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete an output description: This operation deletes an output, including all of its assigned targets. operationId: deleteTranscoderOutput tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'DELETE',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets: post: summary: Create an output stream target description: 'This operation creates an output stream target, assigning the stream target to the specified output rendition. ' operationId: createTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets\" \\\n -d $'{\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_stream_target_create_input' description: 'Provide the details of the output stream target to create in the body of the request. ' required: true responses: '201': description: Success content: application/json: schema: type: object required: - output_stream_target properties: output_stream_target: $ref: '#/components/schemas/output_stream_target' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch all output stream targets of an output of a transcoder description: This operation shows the details of all of the output stream targets of an output of a transcoder. operationId: listTranscoderOutputOutputStreamTargets tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/output_stream_targets' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}: get: summary: Fetch an output stream target description: This operation shows the details of an output stream target. operationId: showTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: 'The unique alphanumeric string that identifies the stream target. **Tip:** If you''re using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.' schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: output_stream_target: $ref: '#/components/schemas/output_stream_target' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' patch: summary: Update an output stream target description: This operation updates an output stream target. operationId: updateTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77\" \\\n -d $'{\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"transcoder\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: 'The unique alphanumeric string that identifies the stream target. **Tip:** If you''re using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/output_stream_target_update_input' description: Provide the details of the output stream target to update in the body of the request. required: true responses: '200': description: Success content: application/json: schema: type: object required: - output_stream_target properties: output_stream_target: $ref: '#/components/schemas/output_stream_target' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' delete: summary: Delete an output stream target description: This operation deletes an output stream target, including all of its assigned targets. operationId: deleteTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'DELETE',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: 'The unique alphanumeric string that identifies the stream target. **Tip:** If you''re using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.' schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/enable: put: summary: Enable an output stream target description: This operation enables an output stream target. operationId: enableTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: 'The unique alphanumeric string that identifies the stream target. **Tip:** If you''re using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.' schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: state: type: string description: The state of the output stream target. example: enabled enum: - enabled - disabled - restarted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/disable: put: summary: Disable an output stream target description: This operation disables an output stream target. operationId: disableTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: 'The unique alphanumeric string that identifies the stream target. **Tip:** If you''re using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.' schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: state: type: string description: The state of the output stream target. example: disabled enum: - enabled - disabled - restarted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/restart: put: summary: Restart an output stream target description: This operation restarts an output stream target. operationId: restartTranscoderOutputOutputStreamTarget tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PUT',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: output_id in: path required: true description: The unique alphanumeric string that identifies the output rendition. schema: type: string - name: stream_target_id in: path required: true description: 'The unique alphanumeric string that identifies the stream target. **Tip:** If you''re using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.' schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - stream_target properties: stream_target: type: object title: stream_target properties: state: type: string description: The state of the output stream target. example: restarted enum: - enabled - disabled - restarted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/properties: post: summary: Configure a property for a transcoder description: 'This operation configures a single property or an array of properties for a transcoder. For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api).' operationId: createTranscoderProperty tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/properties\" \\\n -d $'{\n \"property\": {\n \"key\": \"rtpIgnoreProfileLevelId\",\n \"section\": \"rtsp\",\n \"value\": true\n }\n}'\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/properties';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"property\": {\n \"key\": \"rtpIgnoreProfileLevelId\",\n \"section\": \"rtsp\",\n \"value\": true\n }\n}));\nreq.end();\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string requestBody: content: application/json: schema: required: - property - properties oneOf: - $ref: '#/components/schemas/transcoder_property_create_input' - $ref: '#/components/schemas/transcoder_properties_create_input' description: Provide the details of the property or properties to configure in the body of the request. You must include either *property* or *properties* in the request as the root object. required: true responses: '200': description: Success content: application/json: schema: required: - property - properties oneOf: - $ref: '#/components/schemas/transcoder_configure_property_post_response' - $ref: '#/components/schemas/transcoder_configure_properties_post_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' get: summary: Fetch a transcoder's properties description: This operation shows all of the properties of a specific transcoder. operationId: listTranscoderProperties tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/properties\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/properties';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/transcoder_configure_properties_post_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' /transcoders/{transcoder_id}/properties/{id}: get: summary: Fetch a property for a transcoder description: This operation shows the details of a specific property for a specific transcoder. operationId: showTranscoderProperty tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, **cupertino-aes128Secret**. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/transcoder_configure_property_post_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' delete: summary: Delete a transcoder's property description: This operation deletes a specific property from a specific transcoder. operationId: deleteTranscoderProperty tags: - transcoders x-codeSamples: - lang: Shell source: "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \\\n \"${WV_HOST}/api/v2.0/transcoders/2adffc17/properties/cupertino-aes128Secret\"\n" - lang: JavaScript source: "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v2.0/transcoders/2adffc17/properties/cupertino-aes128Secret';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'DELETE',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});\n" parameters: - name: transcoder_id in: path required: true description: The unique alphanumeric string that identifies the transcoder. schema: type: string - name: id in: path required: true description: The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, **cupertino-aes128Secret**. schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error404' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/Error410' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error422' components: schemas: vod_streams: type: object description: '' required: - vod_streams properties: vod_streams: type: array items: type: object title: vod_streams description: '' properties: id: type: string description: The unique alphanumeric string that identifies the VOD stream. example: '' name: type: string description: A descriptive name for the VOD stream. Maximum 200 characters. example: '' state: type: string description: The state of the VOD stream. example: '' enum: - processing - completed - failed playback_enabled: type: boolean description: Specifies whether playback is enabled for the VOD stream. example: '' enum: - true - false reason: type: string description: The reason that a VOD stream has the state of **failed**. Only returned when the state is **failed**. example: '' created_at: type: string description: The date and time that the VOD stream was created. example: '' updated_at: type: string description: The date and time that the VOD stream was updated. example: '' example: vod_streams: - id: wdjfqvsv name: My VOD Stream 1 state: failed playback_enabled: false created_at: '2020-02-25T17:16:25.849Z' updated_at: '2020-01-28T16:06:47.849Z' - id: XyxZKqHO name: My VOD Stream 2 state: completed playback_enabled: true created_at: '2020-01-29T17:16:21.849Z' updated_at: '2020-01-31T02:26:05.849Z' - id: Pz21DRSt name: My VOD Stream 3 state: completed playback_enabled: true created_at: '2020-01-29T17:16:21.849Z' updated_at: '2020-01-30T18:13:18.849Z' transcoder_configure_properties_post_response: type: object title: properties description: '' properties: properties: type: array description: An array of properties. items: $ref: '#/components/schemas/transcoder_property' example: properties: - key: fitMode section: output value: letterbox - key: rtpIgnoreProfileLevelId section: rtsp value: true output_update_input: description: '' allOf: - $ref: '#/components/schemas/output_input' transcoder_configure_property_post_response: type: object title: property description: '' properties: property: description: The configured transcoder property. $ref: '#/components/schemas/transcoder_property' example: property: - key: rtpIgnoreProfileLevelId section: rtsp value: true transcoder_update_input: type: object description: '' required: - transcoder properties: transcoder: type: object title: transcoder description: '' properties: delivery_method: type: string description: 'The type of connection between the source encoder and the transcoder. The default, **pull**, instructs the transcoder to pull the video from the source. **push** instructs the source to push the stream to the transcoder. **cdn** uses a stream source to deliver the stream to the transcoder. **Example:** "delivery_method": "pull"' example: '' enum: - pull - cdn - push name: type: string description: 'A descriptive name for the transcoder. Maximum 200 characters. **Example:** "name": "My Updated Transcoder"' example: '' protocol: type: string description: 'The transport protocol for the source video. The default is **rtmp**. **Example:** "protocol": "webrtc"' example: '' enum: - file - rtmp - rtsp - srt - udp - webrtc broadcast_location: type: string description: 'The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source. You cannot change the broadcast location after initial creation if you are using autostart functionality on your transcoder. **Example:** "broadcast_location": "us_central_iowa"' example: '' enum: - asia_pacific_australia - asia_pacific_india - asia_pacific_japan - asia_pacific_singapore - asia_pacific_s_korea - asia_pacific_taiwan - eu_belgium - eu_germany - eu_ireland - south_america_brazil - us_central_iowa - us_east_s_carolina - us_east_virginia - us_west_california - us_west_oregon buffer_size: type: integer description: 'The size, in milliseconds, of the incoming buffer. **0** means no buffer. The default is **4000** (4 seconds). **Example:** "buffer_size": 4000' example: '' enum: - 0 - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 format: int32 closed_caption_type: type: string description: 'The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided. **Example:** "closed_caption_type": "cea"' example: '' enum: - none - cea - on_text - both delivery_protocols: type: array description: 'An array of playback protocols enabled for this transcoder. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are returned. **Example:** See response body sample ' items: type: string description: type: string description: 'An optional description of the transcoder. **Example:** "description": "This transcoder runs our 24/7 stream."' example: '' disable_authentication: type: boolean description: 'Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify **true** to disable authentication with the video source. **Example:** "disable_authentication": false' example: '' idle_timeout: type: integer description: 'The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers **0** (never shuts down) to **172800** (48 hours). The default is **1200** (20 minutes). **Example:** "idle_timeout": 1600' example: '' format: int32 low_latency: type: boolean description: 'If **true**, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is **false**. **Example:** "low_latency": false' example: '' password: type: string description: 'A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used. **Example:** "password": 68332313' example: '' play_maximum_connections: type: integer description: 'The number of users who are allowed to connect directly to the transcoder. The minimum and default value is **10**. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers. **Example:** "play_maximum_connections": 30' example: '' format: int32 properties: type: array description: 'An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in. Available from version 1.5. **Example:** See response body sample' items: $ref: '#/components/schemas/transcoder_property' reference_id: type: string description: 'A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~| You can''t use brackets or quotation marks. See Wowza Video Webhook Event Reference Documentation to learn about webhooks. Available from version 1.7. **Example:** "reference_id": "mySystemID_01"' example: '' remove_watermark_image: type: boolean description: 'If **true**, removes the watermark from the output. The default is **false**. **Example:** "remove_watermark_image": true' example: '' source_url: type: string description: 'For the *delivery_method* **pull** or *protocol* **file**. For **pull**, enter the source''s web address without the protocol or the trailing slash (/). For **file**, enter the source file URL, including the protocol (http, https, gs, s3). **Example:** "source_url": "xyz.streamlock.net/vod/mp4:Movie.mov"' example: '' stream_extension: type: string description: 'For the *delivery_method* **push**. Some encoders append an extension to their stream names. If the device you''re using does this, enter the extension as a period (.) followed by alphanumeric characters. **Example:** "stream_extension": ".sdp"' example: '' stream_source_id: type: string description: 'For the *delivery_method* **cdn**. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder. **Example:** "stream_source_id": "rxHQQpWw"' example: '' suppress_stream_target_start: type: boolean description: 'If **true**, disables stream targets when the transcoder starts. If **false** (the default), the targets start when the transcoder starts. **Example:** "suppress_stream_target_start": false' example: '' username: type: string description: 'A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used. **Example:** "username": "client2"' example: '' watermark: type: boolean description: 'Embeds an image into the transcoded stream for copyright protection. Specify **true** to embed a watermark image. **Example:** "watermark": true' example: '' watermark_height: type: integer description: 'The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height. **Example:** "watermark_height": 80' example: '' format: int32 watermark_image: type: string description: 'A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller. **Example:** "watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"' example: '' watermark_opacity: type: integer description: 'The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque. **Example:** "watermark_opacity": 75' example: '' enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 - 100 format: int32 watermark_position: type: string description: 'The corner of the video frame in which you want the watermark to appear. The default is **top-left**. **Example:** "watermark_position": "top-left"' example: '' enum: - top-left - top-right - bottom-left - bottom-right watermark_width: type: integer description: 'The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width. **Example:** "watermark_width": 100' example: '' format: int32 example: transcoder: name: My Updated Transcoder description: My Transcoder Description watermark_position: bottom-left output_stream_targets: type: object description: '' required: - output_stream_targets properties: output_stream_targets: type: array items: $ref: '#/components/schemas/output_stream_target' example: output_stream_targets: - id: 4Gp5rF23 stream_target_id: QvvJYJjk use_stream_target_backup_url: false stream_target: id: QvvJYJjk name: My provisioned RTMP Stream Target type: wowza created_at: '2020-01-29T17:16:21.965Z' updated_at: '2020-01-31T05:45:33.965Z' - id: 345Gd9Hs stream_target_id: R32u8HDk use_stream_target_backup_url: false stream_target: id: R32u8HDk name: My other provisioned RTMP Stream Target type: wowza created_at: '2020-01-29T17:16:21.965Z' updated_at: '2020-01-31T12:19:50.965Z' transcoder_properties_create_input: type: object title: properties description: '' properties: properties: type: array title: properties description: 'An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in. Available from version 1.7.' required: - section - key - value items: $ref: '#/components/schemas/transcoder_property' example: properties: - key: fitMode section: output value: letterbox - key: rtpIgnoreProfileLevelId section: rtsp value: true index_transcoder: type: object title: transcoders description: '' properties: created_at: type: string description: The date and time that the transcoder was created. example: '' format: date-time id: type: string description: The unique alphanumeric string that identifies the transcoder. example: '' name: type: string description: A descriptive name for the transcoder. Maximum 200 characters. example: '' state: type: string description: The state of the transcoder. example: resetting enum: - starting - stopping - started - stopped - resetting workflow: type: string description: The method by which the transcoder was created, either **transcoder** for a transcoder created through the transcoder workflow or **live_stream** for a transcoder created automatically as part of the live stream workflow. example: '' enum: - live_stream - transcoder updated_at: type: string description: The date and time that the transcoder was updated. example: '' format: date-time uptime: type: object description: '' properties: billed: type: boolean description: A Boolean value that indicates if the usage generated by this uptime has been sent for billing processing. example: '' created_at: type: string description: The date and time that the uptime record was created. example: '' format: date-time ended_at: type: string description: The date and time that the transcoder was stopped for this uptime. If this value is not present, it indicates that the transcoder is currently running. example: '' format: date-time id: type: string description: The unique alphanumeric string that identifies the uptime record. example: '' running: type: boolean description: A Boolean value that indicates if the transcoder is still running for this uptime. example: '' started_at: type: string description: The date and time that the transcoder started for this uptime. example: '' format: date-time transcoder_id: type: string description: The unique alphanumeric string that identifies the transcoder. example: '' updated_at: type: string description: The date and time that the uptime record was updated. example: '' example: billed: false created_at: '2017-07-06T14:22:00.000Z' id: 1234abcd running: true started_at: '2017-07-06T14:22:00.000Z' transcoder_id: 2adffc17 updated_at: '2017-07-06T14:22:00.000Z' index_recordings: type: object description: '' title: recordings properties: created_at: type: string description: The date and time that the recording was created. example: '2020-01-29T17:16:21.993Z' format: date-time id: type: string description: The unique alphanumeric string that identifies the recording. example: 4Jjzstdt asset_id: type: string description: Only applies to recordings created for Asset Management. The id for the asset associated with your recording. You can manage your asset in Asset Management. example: tk1plmzr file_name: type: string description: 'The file name of the recording.
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.
' example: '' real_time_stream_id: type: string description: Only applies to Real-Time Streaming at Scale. The unique alphanumeric string that identifies the real-time stream that was recorded. example: cj39nmrt reason: type: string description: The reason that a recording has the state **failed**. example: '' state: type: string description: The state of the recording. example: completed enum: - uploading - converting - removing - completed - failed transcoder_id: type: string description: The unique alphanumeric string that identifies the transcoder that was recorded. example: bjaplmrw updated_at: type: string description: The date and time that the recording was updated. example: '2020-01-31T14:14:01.993Z' format: date-time uptimes: type: object description: '' required: - uptimes properties: uptimes: type: array items: $ref: '#/components/schemas/uptime' example: uptimes: - billed: false created_at: '2017-07-06T14:22:00.000Z' id: 1234abcd running: true started_at: '2017-07-06T14:22:00.000Z' transcoder_id: 2adffc17 updated_at: '2017-07-06T14:22:00.000Z' - billed: true created_at: '2017-07-08T14:22:00.000Z' ended_at: '2017-07-08T16:40:00.000Z' id: 5679wxyz running: false started_at: '2017-07-08T14:22:00.000Z' transcoder_id: ff9l4838 updated_at: '2017-07-08T16:40:00.000Z' transcoders: type: object description: '' required: - transcoders properties: transcoders: type: array items: $ref: '#/components/schemas/index_transcoder' example: transcoders: - id: 2lsWj3F9 name: My transcoder workflow: live_stream state: stopped created_at: '2020-01-28T17:16:22.097Z' updated_at: '2020-01-31T01:17:48.097Z' - id: VJbkhjzl name: My other transcoder workflow: transcoder state: started created_at: '2020-01-28T17:16:22.097Z' updated_at: '2020-01-30T16:03:28.097Z' transcoder_property_create_input: type: object title: property description: '' properties: property: type: object title: property description: ' The single property to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in.' required: - section - key - value properties: key: type: string description: 'The key of the property. The following table lists the available property keys and what transcoder table section they''re stored in. Section | Valid keys for the section ----------------|------------- **asset_management** |
**Note:** You need a Wowza Video subscription to access Asset Management. **cupertino** | **ezdrm** | **file** | **output** | **recording** | **rtmp** | **rtsp** | **srt** | **vod_stream** |
**Note:** VOD streams require a Fastly stream target with HLS as a delivery protocol.' example: rtpIgnoreProfileLevelId section: type: string description: The section of the transcoder configuration table that contains the property. example: rtsp enum: - asset_management - cupertino - ezdrm - file - output - recording - rtmp - rtsp - srt - vod_stream value: type: string description: 'The value of the property. The following table provides information about valid values for each property key. Key(s) | Values for the key ----------------|------------- **aes128Host** | Specify the URL that devices will use to fetch the key to decrypt the stream. **aes128Secret** | Specify the 16-byte key that will be used to decrypt the stream. The key must be 32 characters in length and can only contain hex characters (a-f, A-F, 0-9). The key must match the key returned by the **aes128Host**. **enabled** | Specify **true** or **false**. Used in the **asset_mangement** section. **fitMode** | Use **letterbox**, **fit-width**, **fit-height**, **crop**, **stretch**, or **match-source**. The default is **fit-height**. **maxRtcpWaitTime** | Use a whole number, expressed as a string or an integer. The default is **2000** (ms). **passPhrase** | Use a string between 10-79 characters in length. It adds security to a live stream for an incoming SRT stream from your device or encoder to Wowza Video. The password protection secures the data payload of SRT live streams, ensuring that the transmitted content is encrypted and safeguarded against unauthorized interception during its journey across the network. **record** | Use an output ID associated with the transcoder. **rtpDePacketizerPacketSorterBufferTime** | Use an integer, expressed as a string or an integer. The default is **500** (ms). **rtpDePacketizerPacketSorterFlushTime** | Use an integer, expressed as a string or an integer. The default is **10** (ms). **rtpDePacketizerWrapper** | Use the string **RTPDePacketizerWrapperPacketSorter**. **rtpTransportMode** | Use the string **udp** or **interleave** (the default). **rtspValidationFrequency** | Use a whole number, expressed as a string or an integer. The default is **15000** (ms). **start_streaming_at** | Specify the month, day, year, and time of day that the file should start streaming, expressed as a string. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC. | Use account information and asset IDs from EZDRM. All strings. | Use **true** or **false**, expressed as a string or a Boolean. | Use **true** or **false**, expressed as a string or a Boolean. When **true**, **hls** generates a VOD stream and **live2vod** replaces the live playlist with the VOD playlist after the stream ends so viewers can access the VOD stream on the live playback URL. **hls** must be **true** to enable **live2VOD**.' example: 'true' transcoder_property: type: object description: A single property. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in. title: property required: - section - key - value properties: key: type: string description: 'The key of the property. The following table lists the available property keys and what transcoder table section they''re stored in. Section | Valid keys for the section ----------------|------------- **asset_management** |
**Note:** You need a Wowza Video subscription to access Asset Management. **cupertino** | **ezdrm** | **file** | **output** | **recording** | **rtmp** | **rtsp** | **srt** | **vod_stream** |
**Note:** VOD streams require a Fastly stream target with HLS as a delivery protocol.' example: '' section: type: string description: The section of the transcoder configuration table that contains the property. example: '' enum: - asset_management - cupertino - ezdrm - file - output - recording - rtmp - rtsp - srt - vod_stream value: type: string description: 'The value of the property. The following table provides information about valid values for each property key. Key(s) | Values for the key ----------------|------------- **aes128Host** | Specify the URL that devices will use to fetch the key to decrypt the stream. **aes128Secret** | Specify the 16-byte key that will be used to decrypt the stream. The key must be 32 characters in length and can only contain hex characters (a-f, A-F, 0-9). The key must match the key returned by the **aes128Host**. **enabled** | Specify **true** or **false**. Used in the **asset_mangement** section. **fitMode** | Use **letterbox**, **fit-width**, **fit-height**, **crop**, **stretch**, or **match-source**. The default is **fit-height**. **maxRtcpWaitTime** | Use a whole number, expressed as a string or an integer. The default is **2000** (ms). **passPhrase** | Use a string between 10-79 characters in length. It adds security to a live stream for an incoming SRT stream from your device or encoder to Wowza Video. The password protection secures the data payload of SRT live streams, ensuring that the transmitted content is encrypted and safeguarded against unauthorized interception during its journey across the network. **record** | Use an output ID associated with the transcoder. **rtpDePacketizerPacketSorterBufferTime** | Use an integer, expressed as a string or an integer. The default is **500** (ms). **rtpDePacketizerPacketSorterFlushTime** | Use an integer, expressed as a string or an integer. The default is **10** (ms). **rtpDePacketizerWrapper** | Use the string **RTPDePacketizerWrapperPacketSorter**. **rtpTransportMode** | Use the string **udp** or **interleave** (the default). **rtspValidationFrequency** | Use a whole number, expressed as a string or an integer. The default is **15000** (ms). **start_streaming_at** | Specify the month, day, year, and time of day that the file should start streaming, expressed as a string. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC. | Use account information and asset IDs from EZDRM. All strings. | Use **true** or **false**, expressed as a string or a Boolean. | Use **true** or **false**, expressed as a string or a Boolean. When **true**, **hls** generates a VOD stream and **live2vod** replaces the live playlist with the VOD playlist after the stream ends so viewers can access the VOD stream on the live playback URL. **hls** must be **true** to enable **live2VOD**.' example: '' output_stream_target: type: object description: '' properties: created_at: type: string description: The date and time that the output stream target was created. example: '' format: date-time id: type: string description: The unique alphanumeric string that identifies the output stream target. example: '' stream_target: $ref: '#/components/schemas/index_stream_target' stream_target_id: type: string description: The unique alphanumeric string that identifies the stream target. example: '' updated_at: type: string description: The date and time that the output stream target was updated. example: '' format: date-time use_stream_target_backup_url: type: boolean description: Specifies whether the output stream target uses the stream target's primary or backup URL. example: '' target_state: type: string description: Specifies whether the stream target is **enabled** or **disabled**. This parameter displays in the response when the transcoder or live stream associated with the stream target is running and receiving a stream. **Enabled** means the stream target is enabled and streaming video to its destination. **Disabled** means the stream target is disabled and is not streaming video to its destination. example: '' enum: - enabled - disabled example: id: 4Gp5rF23 stream_target_id: QvvJYJjk use_stream_target_backup_url: true stream_target: id: QvvJYJjk name: My provisioned RTMP Stream Target type: wowza created_at: '2020-01-29T17:16:21.965Z' updated_at: '2020-01-31T04:06:40.965Z' target_state: Enabled Error401: type: object description: '' required: - meta properties: meta: type: object title: meta description: '' properties: status: type: integer description: '' example: '' format: int32 code: type: string description: '' example: '' title: type: string description: '' example: '' message: type: string description: '' example: '' description: type: string description: '' example: '' links: type: array description: '' example: '' items: {} example: Example Response 1: meta: status: 401 code: ERR-401-NoApiKey title: No API Key Error message: No API key sent in header. description: '' links: [] Example Response 2: meta: status: 401 code: ERR-401-NoAccessKey title: No Access Key Error message: No access key sent in header. description: '' links: [] Example Response 3: meta: status: 401 code: ERR-401-InvalidApiKey title: Invalid Api Key Error message: Invalid API key. description: '' links: [] Example Response 4: meta: status: 401 code: ERR-401-InvalidAccessKey title: Invalid Access Key Error message: Invalid access key. description: '' links: [] Example Response 5: meta: status: 401 code: ERR-401-BadAccountStatus title: Bad Account Status Error message: Your account's status doesn't allow this action. description: '' links: [] Example Response 6: meta: status: 401 code: ERR-401-FeatureNotEnabled title: Feature Not Enabled Error message: This feature isn't enabled. description: '' links: [] Example Response 7: meta: status: 401 code: ERR-401-TrialExceeded title: Bad Billing Status Error message: Your billing status needs attention. You can't start or add live streams until your billing status is updated. description: '' links: [] Example Response 8: meta: status: 401 code: ERR-401-ExpiredToken title: JWT is expired message: Token has exired. description: '' links: [] Example Response 9: meta: status: 401 code: ERR-401-InvalidToken title: JWT is invalid message: Token is invalid. description: '' links: [] output_create_input: description: '' allOf: - $ref: '#/components/schemas/output_input' transcoder: type: object description: '' properties: application_name: type: string description: The application name from the pull stream source URL. example: '' asset_id: type: string description: Only applies to the transcoder of a live stream created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management. billing_mode: type: string description: "The billing mode for the transcoder. The default is **pay_as_you_go**.\n\n\n \n**pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.\n \n\n**twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited." example: '' enum: - pay_as_you_go - twentyfour_seven broadcast_location: type: string description: The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source. example: '' enum: - asia_pacific_australia - asia_pacific_india - asia_pacific_japan - asia_pacific_singapore - asia_pacific_s_korea - asia_pacific_taiwan - eu_belgium - eu_germany - eu_ireland - south_america_brazil - us_central_iowa - us_east_s_carolina - us_east_virginia - us_west_california - us_west_oregon buffer_size: type: integer description: The size, in milliseconds, of the incoming buffer. **0** means no buffer. The default is **4000** (4 seconds). example: '' enum: - 0 - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 format: int32 closed_caption_type: type: string description: The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided. example: '' enum: - none - cea - on_text - both created_at: type: string description: The date and time that the transcoder was created. example: '' format: date-time delivery_method: type: string description: The type of connection between the source encoder and the transcoder. The default, **pull**, instructs the transcoder to pull the video from the source. **push** instructs the source to push the stream to the transcoder. **cdn** uses a stream source to deliver the stream to the transcoder. example: '' enum: - pull - cdn - push delivery_protocols: type: array description: An array of playback protocols enabled for this transcoder. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are returned. items: type: string description: type: string description: An optional description of the transcoder. example: '' direct_playback_urls: type: object description: A list of direct playback URLs for the transcoder's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition. properties: delivery_protocol: type: array description: The name of the direct playback protocol. items: type: object title: direct_playback_url properties: name: type: string description: 'The name of the playback URL: **source**, **default**, or the output rendition''s resolution.' example: '' output_id: type: string description: Only for output rendition-based playback URLs, not source playback URLs. The unique alphanumeric string that identifies the output rendition. example: dcxq5q6c url: type: string description: The playback URL for the source or output rendition. example: https://abcdef.dev.entrypoint.video.wowza.com/app-B8P6K226/ngrp:43a23e5a_all/playlist.m3u8 application_name: type: string description: (WebRTC only) The application name for the WebRTC output. example: '' stream_name: type: string description: (WebRTC only) The stream name for the WebRTC output rendition. example: '' disable_authentication: type: boolean description: Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify **true** to disable authentication with the video source. example: '' domain_name: type: string description: The domain name from the pull stream source URL. example: '' id: type: string description: The unique alphanumeric string that identifies the transcoder. example: '' idle_timeout: type: integer description: The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers **0** (never shuts down) to **172800** (48 hours). The default is **1200** (20 minutes). example: '' format: int32 low_latency: type: boolean description: If **true**, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is **false**. example: '' name: type: string description: A descriptive name for the transcoder. Maximum 200 characters. example: '' outputs: type: array description: Output renditions associated with the transcoder. items: $ref: '#/components/schemas/output' password: type: string description: A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used. example: '' playback_stream_name: type: string description: The stream name used in the direct playback URL. example: '' play_maximum_connections: type: integer description: The number of users who are allowed to connect directly to the transcoder. The minimum and default value is **10**. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers. example: '' format: int32 protocol: type: string description: The transport protocol for the source video. The default is **rtmp**. example: '' enum: - file - rtmp - rtsp - srt - udp - webrtc reference_id: type: string description: 'A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~| You can''t use brackets or quotation marks. See Wowza Video Webhook Event Reference Documentation to learn about webhooks. Available from version 1.7.' example: '' source_port: type: integer description: The port used for RTMP pull connections to Wowza Video. example: '' format: int32 source_url: type: string description: 'For the *delivery_method* **pull** or *protocol* **file**. For **pull**, enter the source''s web address without the preceding protocol or the trailing slash (/). For **file**, enter the source file URL, including the protocol (http, https, gs, s3).' example: '' stream_extension: type: string description: For the *delivery_method* **push**. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters. example: '' stream_name: type: string description: The stream name from the pull stream source URL. example: '' stream_source_id: type: string description: For the *delivery_method* **cdn**. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder. example: '' suppress_stream_target_start: type: boolean description: If **true**, disables stream targets when the transcoder starts. If **false** (the default), the targets start when the transcoder starts. example: '' transcoder_type: type: string description: 'The type of transcoder, either **transcoded** for streams that are transcoded into adaptive bitrate renditions or **passthrough** for streams that aren''t processed by the transcoder. > **Note**: **passthrough** isn''t supported in the **asia_pacific_singapore** region. Default: **transcoded**' example: '' enum: - transcoded - passthrough updated_at: type: string description: The date and time that the transcoder was updated. example: '' format: date-time username: type: string description: A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used. example: '' watermark: type: boolean description: Embeds an image into the transcoded stream for copyright protection. Specify **true** to embed a watermark image. example: '' watermark_height: type: integer description: The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height. example: '' format: int32 watermark_image_url: type: string description: The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller. example: '' watermark_opacity: type: integer description: The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque. example: '' enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 - 100 format: int32 watermark_position: type: string description: The corner of the video frame in which you want the watermark to appear. The default is **top-left**. example: '' enum: - top-left - top-right - bottom-left - bottom-right watermark_width: type: integer description: The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width. example: '' format: int32 example: application_name: app-B8P6K226 billing_mode: pay_as_you_go broadcast_location: us_central_iowa buffer_size: 4000 closed_caption_type: cea created_at: '2020-01-28T17:16:22.098Z' delivery_method: push delivery_protocols: - rtmp - rtsp - wowz - webrtc description: My Transcoder Description direct_playback_urls: rtmp: - name: source url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789 - name: webrtc output_id: dcxq5q6c url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6 rtsp: - name: source url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789 - name: webrtc output_id: dcxq5q6c url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6 wowz: - name: source url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789 - name: webrtc output_id: dcxq5q6c url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6 webrtc: - name: source url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead - name: webrtc output_id: dcxq5q6c url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream1 - name: V:1280x720+A:128K output_id: 0g116zkf url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream2 - name: V:854x480+A:128K output_id: 4qqkwndt url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream3 - name: V:640x360+A:128K output_id: 0pv8djpg url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream4 - name: V:512x288+A:128K output_id: b09xrxjf url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream5 - name: V:320x180+A:128K output_id: bvkh2nsz url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json application_name: app-B8P6K226 stream_name: 1722aead_stream6 disable_authentication: false domain_name: f92334.entrypoint.video.wowza.com id: 2lsWj3F9 idle_timeout: 1200 low_latency: false name: My PAYG Transcoder outputs: - {} password: 82e0e971 playback_stream_name: wxyz6789 play_maximum_connections: 20 properties: - key: fitMode section: output value: letterbox - key: rtpIgnoreProfileLevelId section: rtsp value: true protocol: rtmp reference_id: mySystemID_01 source_port: 1935 stream_extension: .sdp stream_name: 10eb0ed8 suppress_stream_target_start: false transcoder_type: transcoded updated_at: '2020-01-31T15:46:50.098Z' username: client2 watermark: true watermark_height: 80 watermark_image_url: https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg watermark_opacity: 75 watermark_position: top-right watermark_width: 100 output_stream_target_input: type: object description: '' required: - output_stream_target properties: output_stream_target: type: object title: output_stream_target description: '' required: - stream_target_id properties: stream_target_id: type: string description: The unique alphanumeric string that identifies the stream target. example: 1234abcd use_stream_target_backup_url: type: boolean description: ' Specifies whether the output stream target uses the stream target''s primary or backup URL. When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with *use_stream_target_backup_url* as **false** (the default) and once with *use_stream_target_backup_url* as **true**. **Example:** "use_stream_target_backup_url": true' example: true index_stream_target: type: object description: '' title: stream_targets properties: created_at: type: string description: The date and time that the stream target was created. example: '' format: date-time id: type: string description: The unique alphanumeric string that identifies the stream target. example: '' name: type: string description: A descriptive name for the stream target. Maximum 255 characters. example: '' state: type: string description: The state of the stream target. example: activated enum: - activated - archived type: type: string description: '**custom** is an external, third-party destination and **wowza_cdn** is a Wowza CDN target. ' example: '' enum: - custom - wowza_cdn updated_at: type: string description: The date and time that the stream target was updated. example: '' format: date-time schedule: type: object description: '' properties: action_type: type: string description: The type of action that the schedule should trigger on the transcoder. The default is **start**. example: start_stop enum: - start - stop - start_stop created_at: type: string description: The date and time that the schedule was created. example: '2020-01-29T17:16:21.995Z' format: date-time end_repeat: type: string description: The month, day, and year that a recurring schedule should stop running. Specify **YYYY-MM-DD**. example: '2020-02-29T00:00:00.000Z' format: date id: type: string description: The unique alphanumeric string that identifies the schedule. example: vhB0jSlB name: type: string description: A descriptive name for the schedule. Maximum 255 characters. example: Scheduled start for my camera recurrence_data: type: string description: The day or days of the week that a recurring schedule should run. example: monday,tuesday,wednesday,thursday,friday enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday recurrence_type: type: string description: A schedule can run one time only (**once**) or repeat (**recur**) until a specified *end_repeat* date. The default is **once**. example: recur enum: - once - recur start_repeat: type: string description: The month, day, and year that the recurring schedule should go into effect. Specify **YYYY-MM-DD**. example: '2020-02-01T00:00:00.000Z' format: date start_transcoder: type: string description: The month, day, year, and time of day that the *action_type* **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC. example: '2020-02-01T00:00:00.000Z' format: date-time state: type: string description: A schedule must be **enabled** to run. Specify **enabled** to run the schedule or **disabled** to turn off the schedule so that it doesn't run. example: enabled enum: - enabled - disabled - expired stop_transcoder: type: string description: The month, day, year, and time of day that the *action_type* **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC. example: '2020-02-29T23:59:59.999Z' format: date-time time_zone: type: string description: The time zone the schedule runs in. transcoder_id: type: string description: The unique alphanumeric string that identifies the transcoder being scheduled. example: P0NrTP7m transcoder_name: type: string description: The name of the transcoder being scheduled. example: My Camera updated_at: type: string description: The date and time that the schedule was updated. example: '2020-01-30T16:44:37.995Z' format: date-time example: id: 28bwb5WT state: disabled name: Scheduled recurring start for my camera time_zone: America/New_York transcoder_id: VGB21JFJ transcoder_name: My Camera recurrence_type: recur recurrence_data: monday,tuesday,wednesday,thursday,friday action_type: start_stop start_transcoder: '2020-02-01T00:00:00.000Z' stop_transcoder: '2020-02-29T23:59:59.999Z' start_repeat: '2020-02-01T00:00:00.000Z' end_repeat: '2020-02-29T00:00:00.000Z' created_at: '2020-01-29T17:16:21.995Z' updated_at: '2020-01-31T07:00:48.995Z' Error403: type: object description: '' required: - meta properties: meta: type: object title: meta description: '' properties: status: type: integer description: '' example: '' format: int32 code: type: string description: '' example: '' title: type: string description: '' example: '' message: type: string description: '' example: '' description: type: string description: '' example: '' links: type: array description: '' example: '' items: {} example: Example Response 1: meta: status: 403 code: ERR-403-RecordUnaccessible title: Record Unaccessible Error message: The requested resource isn't accessible. description: '' links: [] outputs: type: object description: '' required: - outputs properties: outputs: type: array items: $ref: '#/components/schemas/output' example: outputs: - aspect_ratio_height: 480 aspect_ratio_width: 848 bitrate_audio: 128 bitrate_video: 1600 created_at: '2020-01-29T17:16:21.958Z' framerate_reduction: 1/2 h264_profile: main id: w9vJm3BJ keyframes: follow_source name: 'Standard Output: Video (848 x 480) + Audio' output_stream_targets: - {} video_codec: h264 audio_codec: aac transcoder_id: PblTJm1t updated_at: '2020-01-31T03:29:50.958Z' - created_at: '2020-01-29T17:16:21.958Z' id: PPqV0kcm name: 'Standard Output: Video + Audio' output_stream_targets: - {} video_codec: passthrough audio_codec: passthrough transcoder_id: Yf5lyjCV updated_at: '2020-01-31T03:55:05.958Z' Error422: type: object description: '' required: - meta properties: meta: type: object title: meta description: '' properties: status: type: integer description: '' example: '' format: int32 code: type: string description: '' example: '' title: type: string description: '' example: '' message: type: string description: '' example: '' description: type: string description: '' example: '' links: type: array description: '' example: '' items: {} example: Example Response 1: meta: status: 422 code: ERR-422-RecordInvalid title: Record Invalid Error message: The request couldn't be processed. ... can't be blank description: '' links: [] Example Response 2: meta: status: 422 code: ERR-422-RecordInvalid title: Record Invalid Error message: The request couldn't be processed. Provider wowza_video is not allowed description: '' links: [] Example Response 3: meta: status: 422 code: ERR-422-InvalidStateChange title: Invalid State Change Error message: The request couldn't be processed. There must be at least one WebRTC output for this transcoder. description: '' links: [] Example Response 4: meta: status: 422 code: ERR-422-RecordInvalid title: Record Invalid Error message: API cannot remove the primary Output Stream Target with the ID of from the Live Stream . description: '' links: [] Example Response 5: meta: status: 422 code: ERR-422-InvalidStateChange title: Invalid State Change Error message: The request couldn't be processed. The broadcast location can't be updated when using autostart. description: '' links: [] Error410: type: object description: '' required: - meta properties: meta: type: object title: meta description: '' properties: status: type: integer description: '' example: '' format: int32 code: type: string description: '' example: '' title: type: string description: '' example: '' message: type: string description: '' example: '' description: type: string description: '' example: '' links: type: array description: '' example: '' items: {} example: Example Response 1: meta: status: 410 code: ERR-410-RecordDeleted title: Record Deleted Error message: The requested resource has been deleted. description: '' links: [] output_input: type: object description: '' required: - output properties: output: type: object title: output description: '' required: - video_codec - audio_codec properties: video_codec: type: string description: The codec used to encode the video stream. **disabled** sends the stream without a video track and **passthrough** sends the stream without transcoding the video track. Available from version 1.6. example: h264 enum: - h264 - passthrough - disabled audio_codec: type: string description: The codec used to encode the audio stream. **disabled** sends the stream without an audio track and **passthrough** sends the stream without transcoding the audio track. **aac** is the most commonly compatible audio codec for protocols, while **opus** is for WebRTC streams. Available from version 1.6. example: aac enum: - aac - opus - passthrough - disabled aspect_ratio_height: type: integer description: 'The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1080**. Combined with **aspect_ratio_width**, makes up the input resolution. **Example:** "aspect_ratio_height": 1080' example: 480 format: int32 aspect_ratio_width: type: integer description: 'The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1920**. Combined with **aspect_ratio_height**, makes up the input resolution. **Example:** "aspect_ratio_width": 1920' example: 848 format: int32 bitrate_audio: type: integer description: 'The audio bitrate, in kilobits per second (Kbps). Must be between **1** and **9999**. If the **audio_codec** is **opus**, the default is **510**, otherwise the default is **128**. **Example:** "bitrate_audio": 128' example: 128 format: int32 bitrate_video: type: integer description: 'The video bitrate, in kilobits per second (Kbps). Must be between **1** and **10240**. The default is **4000**. **Example:** "bitrate_audio": 1600' example: 1600 format: int32 framerate_reduction: type: string description: 'Reduce the frame rate of the transcoded output rendition. The default, **0**, uses the encoded stream''s frame rate without reduction. **Example:** "frame_reduction": "1/2"' example: 1/2 enum: - '0' - 1/2 - 1/4 - 1/25 - 1/30 - 1/50 - 1/60 h264_profile: type: string description: 'The encoding method. Specify **main** for desktop streaming, **baseline** for playback on mobile devices, or **high** for HD playback. The default is **high**. **Example:** "h264_profile": "main"' example: main enum: - main - baseline - high keyframes: type: string description: 'The interval used to define the compression applied to a group of frames. The default, **follow_source**, uses the keyframe interval of the source video. **Example:** "keyframes": "follow_source"' example: follow_source enum: - follow_source - '25' - '30' - '50' - '60' - '100' - '120' example: output: video_codec: h264 audio_codec: aac aspect_ratio_height: 480 aspect_ratio_width: 848 bitrate_audio: 128 bitrate_video: 1600 framerate_reduction: 1/2 h264_profile: main keyframes: follow_source output_stream_target_create_input: description: '' allOf: - $ref: '#/components/schemas/output_stream_target_input' output_stream_target_update_input: description: '' allOf: - $ref: '#/components/schemas/output_stream_target_input' output: type: object description: '' properties: aspect_ratio_height: type: integer description: The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1080**. Combined with **aspect_ratio_width**, makes up the input resolution. example: '' format: int32 aspect_ratio_width: type: integer description: The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1920**. Combined with **aspect_ratio_height**, makes up the input resolution. example: '' format: int32 bitrate_audio: type: integer description: The audio bitrate, in kilobits per second (Kbps). Must be between **1** and **9999**. If the **audio_codec** is **opus**, the default is **510**, otherwise the default is **128**. example: '' format: int32 bitrate_video: type: integer description: The video bitrate, in kilobits per second (Kbps). Must be between **1** and **10240**. The default is **4000**. example: '' format: int32 created_at: type: string description: The date and time that the output rendition was created. example: '' format: date-time framerate_reduction: type: string description: Reduce the frame rate of the transcoded output rendition. The default, **0**, uses the encoded stream's frame rate without reduction. example: '' enum: - '0' - 1/2 - 1/4 - 1/25 - 1/30 - 1/50 - 1/60 h264_profile: type: string description: The encoding method. Specify **main** for desktop streaming, **baseline** for playback on mobile devices, or **high** for HD playback. The default is **high**. example: '' enum: - main - baseline - high id: type: string description: The unique alphanumeric string that identifies the output rendition. example: '' type: type: string description: The type of output rendition, be it WebRTC to use with a transcoder that uses WebRTC as the protocol or a normal output rendition. example: '' enum: - WebRtcOutput - Output keyframes: type: string description: The interval used to define the compression applied to a group of frames. The default, **follow_source**, uses the keyframe interval of the source video. example: '' enum: - follow_source - '25' - '30' - '50' - '60' - '100' - '120' name: type: string description: A descriptive name for the output (generated, not writable). example: '' delete_restrictions: type: array description: The reasons why the output cannot be deleted. example: '' items: type: string output_stream_targets: type: array items: $ref: '#/components/schemas/output_stream_target' video_codec: type: string description: The codec used to encode the video stream. **disabled** sends the stream without a video track and **passthrough** sends the stream without transcoding the video track. Available from version 1.6. example: '' enum: - h264 - passthrough - disabled audio_codec: type: string description: The codec used to encode the audio stream. **disabled** sends the stream without an audio track and **passthrough** sends the stream without transcoding the audio track. **aac** is the most commonly compatible audio codec for protocols, while **opus** is for WebRTC streams. Available from version 1.6. example: '' enum: - aac - opus - passthrough - disabled transcoder_id: type: string description: The unique alphanumeric string that identifies the transcoder. example: '' updated_at: type: string description: The date and time that the output rendition was updated. example: '' format: date-time target_state: type: string description: Specifies whether the stream target is **enabled** or **disabled**. This parameter displays in the response when the transcoder or live stream associated with the stream target is running and receiving a stream. **Enabled** means the stream target is enabled and streaming video to its destination. **Disabled** means the stream target is disabled and is not streaming video to its destination. example: '' enum: - enabled - disabled example: aspect_ratio_height: 480 aspect_ratio_width: 848 bitrate_audio: 128 bitrate_video: 1600 created_at: '2020-01-29T17:16:21.964Z' framerate_reduction: 1/2 h264_profile: main id: w9vJm3BJ keyframes: follow_source name: 'Standard Output: Video (848 x 480) + Audio' output_stream_targets: - {} video_codec: h264 audio_codec: aac transcoder_id: PblTJm1t updated_at: '2020-01-31T13:47:33.964Z' Error404: type: object description: '' required: - meta properties: meta: type: object title: meta description: '' properties: status: type: integer description: '' example: '' format: int32 code: type: string description: '' example: '' title: type: string description: '' example: '' message: type: string description: '' example: '' description: type: string description: '' example: '' links: type: array description: '' example: '' items: {} example: Example Response 1: meta: status: 404 code: ERR-404-RecordNotFound title: Record Not Found Error message: The requested resource couldn't be found. description: '' links: [] transcoder_create_input: type: object description: '' required: - transcoder properties: transcoder: type: object title: transcoder description: '' required: - name - transcoder_type - billing_mode - broadcast_location - protocol - delivery_method properties: billing_mode: type: string description: 'The billing mode for the transcoder. The default is **pay_as_you_go**. **pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming. **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn''t incur overages, since it''s unlimited.' example: '' enum: - pay_as_you_go - twentyfour_seven broadcast_location: type: string description: The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source. example: '' enum: - asia_pacific_australia - asia_pacific_india - asia_pacific_japan - asia_pacific_singapore - asia_pacific_s_korea - asia_pacific_taiwan - eu_belgium - eu_germany - eu_ireland - south_america_brazil - us_central_iowa - us_east_s_carolina - us_east_virginia - us_west_california - us_west_oregon delivery_method: type: string description: The type of connection between the source encoder and the transcoder. The default, **pull**, instructs the transcoder to pull the video from the source. **push** instructs the source to push the stream to the transcoder. **cdn** uses a stream source to deliver the stream to the transcoder. example: '' enum: - pull - cdn - push name: type: string description: A descriptive name for the transcoder. Maximum 200 characters. example: '' protocol: type: string description: The transport protocol for the source video. The default is **rtmp**. example: '' enum: - file - rtmp - rtsp - srt - udp - webrtc transcoder_type: type: string description: 'The type of transcoder, either **transcoded** for streams that are transcoded into adaptive bitrate renditions or **passthrough** for streams that aren''t processed by the transcoder. > **Note**: **passthrough** isn''t supported in the **asia_pacific_singapore** region. Default: **transcoded**' example: '' enum: - transcoded - passthrough buffer_size: type: integer description: 'The size, in milliseconds, of the incoming buffer. **0** means no buffer. The default is **4000** (4 seconds). **Example:** "buffer_size": 4000' example: '' enum: - 0 - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 format: int32 closed_caption_type: type: string description: 'The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided. **Example:** "closed_caption_type": "cea"' example: '' enum: - none - cea - on_text - both delivery_protocols: type: array description: 'An array of playback protocols enabled for this transcoder. By default, **rtmp**, **rtsp**, and **wowz** are returned. **Example:** See response body sample ' items: type: string description: type: string description: 'An optional description of the transcoder. **Example:** "description": "This transcoder runs our 24/7 stream."' example: '' disable_authentication: type: boolean description: 'Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify **true** to disable authentication with the video source. **Example:** "disable_authentication": false' example: '' idle_timeout: type: integer description: 'The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers **0** (never shuts down) to **172800** (48 hours). The default is **1200** (20 minutes). **Example:** "idle_timeout": 1600' example: '' format: int32 low_latency: type: boolean description: 'If **true**, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is **false**. **Example:** "low_latency": false' example: '' password: type: string description: 'A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used. **Example:** "password": 68332313' example: '' play_maximum_connections: type: integer description: 'The number of users who are allowed to connect directly to the transcoder. The minimum and default value is **10**. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers. **Example:** "play_maximum_connections": 30' example: '' format: int32 properties: type: array description: 'An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in. Available from version 1.5. **Example:** See response body sample' items: $ref: '#/components/schemas/transcoder_property' reference_id: type: string description: 'A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~| You can''t use brackets or quotation marks. See Wowza Video Webhook Event Reference Documentation to learn about webhooks. Available from version 1.7. **Example:** "reference_id": "mySystemID_01"' example: '' source_url: type: string description: 'For the *delivery_method* **pull** or *protocol* **file**. For **pull**, enter the source''s web address without the protocol or the trailing slash (/). For **file**, enter the source file URL, including the protocol (http, https, gs, s3). **Example:** "source_url": "xyz.streamlock.net/vod/mp4:Movie.mov"' example: '' stream_extension: type: string description: 'For the *delivery_method* **push**. Some encoders append an extension to their stream names. If the device you''re using does this, enter the extension as a period (.) followed by alphanumeric characters. **Example:** "stream_extension": ".sdp"' example: '' stream_source_id: type: string description: 'For the *delivery_method* **cdn**. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder. **Example:** "stream_source_id": "rxHQQpWw"' example: '' suppress_stream_target_start: type: boolean description: 'If **true**, disables stream targets when the transcoder starts. If **false** (the default), the targets start when the transcoder starts. **Example:** "suppress_stream_target_start": false' example: '' username: type: string description: 'A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used. **Example:** "username": "client2"' example: '' watermark: type: boolean description: 'Embeds an image into the transcoded stream for copyright protection. Specify **true** to embed a watermark image. **Example:** "watermark": true' example: '' watermark_height: type: integer description: 'The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height. **Example:** "watermark_height": 80' example: '' format: int32 watermark_image: type: string description: 'A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller. **Example:** "watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"' example: '' watermark_opacity: type: integer description: 'The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque. **Example:** "watermark_opacity": 75' example: '' enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 - 100 format: int32 watermark_position: type: string description: 'The corner of the video frame in which you want the watermark to appear. The default is **top-left**. **Example:** "watermark_position": "top-left"' example: '' enum: - top-left - top-right - bottom-left - bottom-right watermark_width: type: integer description: 'The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width. **Example:** "watermark_width": 100' example: '' format: int32 example: transcoder: billing_mode: pay_as_you_go broadcast_location: us_central_iowa delivery_method: pull description: My Transcoder Description name: My PAYG Transcoder protocol: rtmp transcoder_type: transcoded parameters: filter: name: filter in: query description: 'Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index. For valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api). Example: **filter[0][field]=state&filter[0][eq]=stopped**' schema: type: string per_page: name: per_page in: query description: For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**. schema: type: integer page: name: page in: query description: "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." schema: type: integer 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