Difference between revisions of "API Application Information"
IVSWikiBlue (talk | contribs) (Created page with "The application information API provides general information about the VALT application including current build version and media server status. ===Resource URL=== <pre>http...") |
IVSWikiBlue (talk | contribs) |
||
| Line 63: | Line 63: | ||
==Examples== | ==Examples== | ||
===Request=== | ===Request=== | ||
| − | <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/general?access_token= | + | <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/general?access_token=exampletoken</pre> |
===Successful Response=== | ===Successful Response=== | ||
Latest revision as of 15:30, 18 September 2026
The application information API provides general information about the VALT application including current build version and media server status.
Contents
Resource URL
http://valt.example.com/api/v3/admin/general
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 | ||
|---|---|---|
| version | Current build version of VALT. | |
| media_servers | List of all currently configured media servers. | |
| name | Media Server Name | |
| address | Media server FQDN or IP address. | |
| free_space | Free space available on media server. | |
| total | Total media server capacity. | |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/admin/general?access_token=exampletoken
Successful Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{
"data":{
"version": 641,
"media_servers":[
{
"name": "localhost",
"address": "ivstest1.ad.ipivs.com",
"free_space": 62702,
"total": 96633
},
{
"name": "ivstest2.ad.ipivs.com",
"address": "ivstest2.ad.ipivs.com",
"free_space": 83437,
"total": 96633
}
]
}
}
Failure Response
{"error":{"code":401,"message":"No API key provided"}}
