Difference between revisions of "API List Media Servers"
IVSWikiBlue (talk | contribs) (Created page with "This API provides general information about the current media servers. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/wowza</pre> ===Resource Information=== {...") |
(No difference)
|
Latest revision as of 13:21, 14 April 2020
This API provides general information about the current media servers.
Contents
Resource URL
http://valt.example.com/api/v3/admin/wowza
Resource Information
| Method | GET |
| Response Type | JSON |
| Authentication Required | Yes |
Parameters
No parameters can be passed to this call.
Response
| Code | Reason |
|---|---|
| 200 | Request Successful |
| 401 | Unauthorized |
| data | ||
|---|---|---|
| media_servers | List of all currently configured media servers. | |
| id | Media Server ID | |
| name | Media Server Name | |
| address | Media server FQDN or IP address. | |
| port | Communications port for streaming video. (Default: 1935 for unsecure, 444 for secure.) | |
| ssl | True or False (encryption enabled for video stream) | |
| storage_folder | Folder videos are stored in under /usr/local/WowzaStreamingEngine/content/ (Default: valt_recordings) | |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/admin/wowza?access_token=e82632d19c523678fea3d1016c6df9e9
Successful Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{
"data":{
"media_servers":[
{
"id": 1,
"name": "localhost",
"address": "ivstest1.ad.ipivs.com",
"port": 444,
"ssl": true,
"storage_folder": "valt_recordings"
},
{
"id": 2,
"name": "ivstest2.ad.ipivs.com",
"address": "ivstest2.ad.ipivs.com",
"port": 444,
"ssl": true,
"storage_folder": "valt_recordings"
}
]
}
}
Failure Response
{"error":{"code":401,"message":"No API key provided"}}