IVSWikiBlue: Created page with "The application information API provides general information about the VALT application including current build version and media server status. ===Resource URL===

http..."

2020-04-14T19:21:24Z

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..."

New page

The application information API provides general information about the VALT application including current build version and media server status.

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/general</pre>

===Resource Information===
{|class="wikitable"
|'''Method'''
|GET
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===

No parameters can be passed to this call.

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|}

{|class="wikitable"
|+JSON Response
!colspan="3"|data
|-
|colspan="2"|'''version'''
|Current build version of VALT.
|-
|colspan="2"|'''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===
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/general?access_token=e82632d19c523678fea3d1016c6df9e9</pre>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"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
}
]
}
}</nowiki>

===Failure Response===
<pre>{"error":{"code":401,"message":"No API key provided"}}</pre>

API Application Information - Revision history

IVSWikiBlue: Created page with "The application information API provides general information about the VALT application including current build version and media server status. ===Resource URL===
http..."