API Information

API version information Copied

URL: /rest

Authentication not required.

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.

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 system Copied

URL: /rest/system

Requires authentication.

This returns back information about Opsview that relates to your My System page. For example, this could respond with:

{
  list => [
    {
      alias          => "Autodiscovery Manager",
      cpu_pct        => "0.0",
      hostname       => "wg-v6-orch",
      mem_kb         => 1480,
      mem_pct        => "0.0",
      name           => "opsview-autodiscoverymanager",
      pid            => 11066,
      status         => "running",
      uptime_seconds => 1049809,
      version        => "6.8.1.202208011246",
      workers        => 0,
    },
["Opsview On-premises"] ["API", "Technical Reference"]

Was this topic helpful?