×
![]()
API Information
API version information Copied
URL: /rest
Authentication not required.
GET— gets version information.POST,PUT,DELETE— unimplemented.
This returns back information about the API. For example, this would respond with:
{
api_version => "6.007001",
api_min_version => "2.000"
}
api_version and api_min_version are floating point numbers.
Clients should check that api_min_version is less than or equal to the version that the client was written for. api_min_version will be incremented if backwards compatibility has been broken.
Opsview information Copied
URL: /rest/info
Requires authentication.
GET— gets version information.POST,PUT,DELETE— unimplemented.
This returns back information about Opsview. For example, this could respond with:
{
opsview_version => "6.8.1",
opsview_build => "6.8.1.202205101417",
opsview_edition => "commercial",
server_timezone => "UTC",
server_timezone_offset => 0,
uuid => "5B40A354-90C4-11DE-8C65-487C69EFFEC7",
hosts_limit => "1000",
}
opsview_nameis based on the top level in the host group hierarchy.opsview_editionis a string, which could be either community, enterprise or commercial.server_timezone_offsetis the number of seconds that this server’s time zone is, relative to UTC. This could be a negative value. This is based on the current time, so you will get a different offset if you are currently in daylight saving time. This is a simple calculation to work out differences between browser time and server time, taking into account the time zone differences.hosts_limitis the maximum number of hosts that you can add to Opsview based on your Opsview subscription. If the value is an empty string, then this means there is no limit on the number of hosts. This field will only exist if the current user can see all the hosts in the system (otherwise this user must have a subset of CONFIGUREHOSTS and thus cannot have a complete list of all hosts).
Opsview system Copied
URL: /rest/system
Requires authentication.
GET— gets version information.POST,PUT,DELETE— unimplemented.
This returns back information about Opsview that relates to your My System page. For example, this could respond with:
{
list => [
{
alias => "Agent",
cpu_pct => "0.0",
hostname => "wg-v6-orch",
mem_kb => 1480,
mem_pct => "0.0",
name => "opsview-agent",
pid => 11066,
status => "running",
uptime_seconds => 1049809,
version => "6.8.1.202208011246",
workers => 0,
},
["Opsview On-premises"]
["API", "Technical Reference"]