openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 469 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Contact Us","url":"https://www.wowza.com/contact","x-twitter":"wowzamedia"},"description":"\n# About the REST API\n\nThe Wowza Streaming Cloud<sup>TM</sup> REST API (application programming interface) offers complete programmatic control over live streams, transcoders, stream sources, and stream targets. Anything you can do in the Wowza Streaming Cloud UI can also be achieved by making HTTP-based requests to cloud-based servers through the REST API.\n\nThe Wowza Streaming Cloud REST API features *cross-origin resource sharing*, or CORS.\nCORS is a [W3C specification](https://www.w3.org/TR/cors/) that provides headers in HTTP requests to enable a web server to safely make a network request to another domain.\n\nIn order to protect shared resources, the Wowza Streaming Cloud REST API is subject to limits. For details, see [Wowza Streaming Cloud REST API limits](https://www.wowza.com/docs/wowza-streaming-cloud-rest-api-limits).\n# About this documentation\nThis reference documentation is based on the open-source [Swagger framework](http://swagger.io/specification/).\nIt allows you to view the operations, parameters, and request and reponse schemas for every resource. Request samples are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON.\n\nFor more information and examples on using the Wowza Streaming Cloud REST API, see our [library of Wowza Streaming Cloud REST API technical articles](https://www.wowza.com/docs/wowza-streaming-cloud-rest-api).\n\n# Query requirements\nThe Wowza Streaming Cloud REST API uses HTTP requests to retrieve data from cloud-based servers. Requests must contain proper JSON, two authentication keys, and the correct version number in the base path.\n\n## JSON\nThe Wowza Streaming Cloud REST API uses the [JSON API specification](http://jsonapi.org/format/) to request and return data. This means requests must include the header `Content-Type: application/json` and must include a single resource object in JSON format as primary data.\n\nResponses include HTTP status codes that indicate whether the query was successful. If there was an error, a description explains the problem so that you can fix it and try again.\n\n## Authentication\nRequests to the Wowza Streaming Cloud REST API must be authenticated with two keys: an API key and an access key. Each key is a 64-character alphanumeric string that you can find on the **API Access** page in Wowza Streaming Cloud.\n\nUse the `wsc-api-key` and `wsc-access-key` headers to authenticate requests, like this (in cURL):\n\n```bash\ncurl -H 'wsc-api-key: [64-character-api-key-goes-here]' -H 'wsc-access-key: [64-character-access-key-goes-here]'\n```\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n## Version\nThe Wowza Streaming Cloud API is currently at version 1.0.0. Use `v1` in your base path in every request, like this path to the live_streams endpoint:\n```\nhttps://api.cloud.wowza.com/api/v1/live_streams\n```\n## Example query\nHere is a complete example POST request, in cURL, with proper JSON syntax, headers, authentication, and version information:\n```bash\ncurl -H 'wsc-api-key: [64-character-api-key-goes-here]' -H 'wsc-access-key: [64-character-access-key-goes-here]'\n -H 'Content-Type: application/json' -X POST -d '{\n \"live_stream\": {\n \"name\": \"My live Stream\",\n \"...\": \"...\"\n }\n }' https://api.cloud.wowza.com/api/v1/live_streams\n```\n","license":{"name":"Terms of Use","url":"https://www.wowza.com/legal/terms-of-use"},"termsOfService":"http://www.wowza.com/legal/terms-of-use","title":"Wowza Streaming Cloud REST API Reference Documentation","version":"1","x-apisguru-categories":["media"],"x-logo":{"url":"https://twitter.com/wowzamedia/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://sandbox.cloud.wowza.com/en/docs/api/v1","version":"2.0"}],"x-providerName":"wowza.com"},"externalDocs":{"description":"Quick Start: How to broadcast a live stream by using the Wowza Streaming Cloud REST API","url":"https://www.wowza.com/docs/how-to-broadcast-a-live-stream-by-using-the-wowza-streaming-cloud-rest-api"},"security":[{"wsc-api-key":[]},{"wsc-access-key":[]}],"tags":[{"description":"Operations related to live streams.","name":"live_streams","x-displayName":"Live Streams"},{"description":"Operations related to players, which are created through the /live_streams resource.","name":"players","x-displayName":"Players"},{"description":"Operations related to recordings.","name":"recordings","x-displayName":"Recordings"},{"description":"Operations related to schedules.","name":"schedules","x-displayName":"Schedules"},{"description":"Operations related to stream sources.","name":"stream_sources","x-displayName":"Stream Sources"},{"description":"Operations related to stream targets.","name":"stream_targets","x-displayName":"Stream Targets"},{"description":"Operations related to transcoders, output renditions, and output stream targets.","name":"transcoders","x-displayName":"Transcoders"},{"description":"Operations related to network usage for an account.","name":"network","x-displayName":"Network"},{"description":"Operations related to stream processing time for an account.","name":"processing time","x-displayName":"Processing Time"},{"description":"Operations related to the Swagger specification.","name":"specs","x-displayName":"Specs"},{"description":"Operations related to peak recording storage for an account.","name":"storage","x-displayName":"Storage"},{"description":"Operations related to stream target viewer data.","name":"viewer data","x-displayName":"Viewer Data"}],"paths":{"/api/v1/specs":{"get":{"description":"This operation shows the details of the Swagger specification.\n","operationId":"specs","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spec"}}}}},"security":[{}],"summary":"Fetch Swagger information","tags":["specs"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/specs\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nhttps.get('https://api-sandbox.cloud.wowza.com/api/v1/specs', 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"}]}},"/live_streams":{"get":{"description":"This operation shows the details of all of your live streams.","operationId":"listLiveStreams","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per_page"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_streams"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}}},"summary":"Fetch all live streams","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"post":{"description":"This operation creates a live stream.","operationId":"createLiveStream","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_stream_create_input"}}},"description":"Provide the details of the live stream to create in the body of the request.","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"$ref":"#/components/schemas/live_stream"}},"required":["live_stream"],"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error422"}}}}},"summary":"Create a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"POST\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams\" \\\n -d $'{\n \"live_stream\": {\n \"name\": \"My New Live Stream\",\n \"transcoder_type\": \"transcoded\",\n \"billing_mode\": \"pay_as_you_go\",\n \"broadcast_location\": \"us_west_california\",\n \"encoder\": \"other_rtmp\",\n \"delivery_method\": \"push\",\n \"aspect_ratio_width\": 1920,\n \"aspect_ratio_height\": 1080\n }\n}'\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams',\n method: 'POST',\n headers: {\n 'api-key': 'a726c273...',\n 'access-key': '68289d8d...',\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 \"live_stream\": {\n \"name\": \"My New Live Stream\"\n }\n}));\nreq.end();\n"}]}},"/live_streams/{id}":{"delete":{"description":"This operation deletes a live stream, including all assigned outputs and targets.","operationId":"deleteLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"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"}}}}},"summary":"Delete a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17',\n method: 'DELETE',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"get":{"description":"This operation shows the details of a specific live stream.","operationId":"showLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"$ref":"#/components/schemas/live_stream"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Fetch a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"patch":{"description":"This operation updates a live stream.","operationId":"updateLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_stream_update_input"}}},"description":"Provide the details of the live stream to update in the body of the request.","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"$ref":"#/components/schemas/live_stream"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Update a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17\" \\\n -d $'{\n \"live_stream\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17',\n method: 'PATCH',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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 \"live_stream\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n"}]}},"/live_streams/{id}/regenerate_connection_code":{"put":{"description":"This operation regenerates the connection code of a live stream.","operationId":"regenerateConnectionCodeLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"properties":{"connection_code":{"description":"A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Streaming Cloud. The code can be used once and expires 24 hours after it's created.","example":"0cd2e8","type":"string"}},"title":"live_stream","type":"object"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Regenerate the connection code for a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/regenerate_connection_code\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/regenerate_connection_code',\n method: 'PUT',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/live_streams/{id}/reset":{"put":{"description":"This operation resets a live stream.","operationId":"resetLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"properties":{"state":{"description":"The state of the live stream.","enum":["started","stopped","starting","stopping","resetting"],"example":"resetting","type":"string"}},"title":"live_stream","type":"object"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Reset a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/reset\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/reset',\n method: 'PUT',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/live_streams/{id}/start":{"put":{"description":"This operation starts a live stream.","operationId":"startLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"properties":{"state":{"description":"The state of the live stream.","enum":["started","stopped","starting","stopping","resetting"],"example":"starting","type":"string"}},"title":"live_stream","type":"object"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Start a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/start\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/start',\n method: 'PUT',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/live_streams/{id}/state":{"get":{"description":"This operation shows the current state of a live stream.","operationId":"showLiveStreamState","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"properties":{"state":{"description":"The state of the live stream.","enum":["started","stopped","starting","stopping","resetting"],"example":"stopped","type":"string"}},"title":"live_stream","type":"object"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Fetch the state of a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/state\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/state',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/live_streams/{id}/stats":{"get":{"description":"This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value.","operationId":"showLiveStreamStats","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"$ref":"#/components/schemas/shm_metrics"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Fetch metrics for an active live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/stats\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/stats',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/live_streams/{id}/stop":{"put":{"description":"This operation stops a live stream.","operationId":"stopLiveStream","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"properties":{"state":{"description":"The state of the live stream.","enum":["started","stopped","starting","stopping","resetting"],"example":"stopped","type":"string"}},"title":"live_stream","type":"object"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Stop a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"PUT\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/stop\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/stop',\n method: 'PUT',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/live_streams/{id}/thumbnail_url":{"get":{"description":"This operation shows the thumbnail URL of a started live stream.","operationId":"showLiveStreamThumbnailUrl","parameters":[{"description":"The unique alphanumeric string that identifies the live stream.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"live_stream":{"properties":{"thumbnail_url":{"description":"The URL to receive the preview thumbnail.","example":"https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-79b8&stream=99b62146@130135.stream&media=json","type":"string"}},"title":"live_stream","type":"object"}},"required":["live_stream"],"type":"object"}}}},"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"}}}}},"summary":"Fetch the thumbnail URL of a live stream","tags":["live_streams"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/live_streams/2adffc17/thumbnail_url\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/live_streams/2adffc17/thumbnail_url',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/players":{"get":{"description":"This operation shows the details of all of your players.","operationId":"listPlayers","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/per_page"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/players"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}}},"summary":"Fetch all players","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/players\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/players/{id}":{"get":{"description":"This operation shows details of a specific player.","operationId":"showPlayer","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"player":{"$ref":"#/components/schemas/player"}},"required":["player"],"type":"object"}}}},"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"}}}}},"summary":"Fetch a player","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"patch":{"description":"This operation updates a player.","operationId":"updatePlayer","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/player_update_input"}}},"description":"Provide the details of the player to update in the body of the request.","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"player":{"$ref":"#/components/schemas/player"}},"required":["player"],"type":"object"}}}},"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"}}}}},"summary":"Update a player","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17\" \\\n -d $'{\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17',\n method: 'PATCH',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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 \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n"}]}},"/players/{id}/rebuild":{"post":{"description":"This operation rebuilds the player with the current configuration.","operationId":"requestPlayerRebuild","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"player":{"properties":{"state":{"description":"The state of the player.","enum":["requested","already_requested","activated","archived"],"example":"requested","type":"string"}},"title":"player","type":"object"}},"required":["player"],"type":"object"}}}},"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"}}}}},"summary":"Rebuild player code","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"POST\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17/rebuild\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17/rebuild',\n method: 'POST',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/players/{id}/state":{"get":{"description":"This operation shows the current state of a player.","operationId":"showPlayerState","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"player":{"properties":{"state":{"description":"The state of the player.","enum":["requested","already_requested","activated","archived"],"example":"activated","type":"string"}},"title":"player","type":"object"}},"required":["player"],"type":"object"}}}},"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"}}}}},"summary":"Fetch the state of a player","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17/state\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17/state',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]}},"/players/{player_id}/urls":{"get":{"description":"This operation shows the details of all player URLs.","operationId":"listPlayerUrls","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"player_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/urls"}}}},"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"}}}}},"summary":"Fetch all player URLs","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17/urls\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17/urls',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"post":{"description":"This operation creates a new player URL.","operationId":"createPlayerUrl","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"player_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/url_create_input"}}},"description":"Provide the details of the player URL to create in the body of the request.","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"url":{"$ref":"#/components/schemas/url"}},"required":["url"],"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error422"}}}}},"summary":"Create a player URL","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"POST\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17/urls\" \\\n -d $'{\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17/urls',\n method: 'POST',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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 \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n"}]}},"/players/{player_id}/urls/{id}":{"delete":{"description":"This operation deletes a player URL. ","operationId":"deletePlayerUrl","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"player_id","required":true,"schema":{"type":"string"}},{"description":"The unique alphanumeric string that identifies the player URL.","in":"path","name":"id","required":true,"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"}}}}},"summary":"Delete a player URL","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17/urls/cupertino-cupertinoProgramDateTimeOffset\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17/urls/cupertino-cupertinoProgramDateTimeOffset',\n method: 'DELETE',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"get":{"description":"This operation shows the details of a player URL.","operationId":"showPlayerUrl","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"player_id","required":true,"schema":{"type":"string"}},{"description":"The unique alphanumeric string that identifies the player URL.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"url":{"$ref":"#/components/schemas/url"}},"required":["url"],"type":"object"}}}},"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"}}}}},"summary":"Fetch a player URL","tags":["players"],"x-code-samples":[{"lang":"Shell","source":"// Using cURL\ncurl -H \"wsc-api-key: a726c273...\" \\\n -H \"wsc-access-key: 68289d8d...\" \\\n -H \"Content-Type: application/json\" \\\n -X \"GET\" \"https://api-sandbox.cloud.wowza.com/api/v1/players/2adffc17/urls/cupertino-cupertinoProgramDateTimeOffset\"\n"},{"lang":"JavaScript","source":"// Using Node.js\nvar https = require('https');\nconst options = {\n hostname: 'api-sandbox.cloud.wowza.com',\n path: '/api/v1/players/2adffc17/urls/cupertino-cupertinoProgramDateTimeOffset',\n headers: {\n 'wsc-api-key': 'a726c273...',\n 'wsc-access-key': '68289d8d...',\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"}]},"patch":{"description":"This operation updates a player URL.","operationId":"updatePlayerUrl","parameters":[{"description":"The unique alphanumeric string that identifies the player.","in":"path","name":"player_id","required":true,"schema":{"type":"string"}},{"description":"The unique alphanumeric string that identifies the player URL.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/url_update_input"}}},"description":"Provide the details of the player URL to update in the body of the request.","required":true},"responses":{"200":{"description":"Success","con