Opsview 6.8.x End of Support
With the release of Opsview 6.11.0 on February 2025, versions 6.8.x have reached their End of Support (EOS) status, according to our Support policy. This means that versions 6.8.x will no longer receive code fixes or security updates.
The documentation for version 6.8.9 and earlier versions will remain accessible for the time being, but it will no longer be updated or receive backports. We strongly recommend upgrading to the latest version of Opsview to ensure continued support and access to the latest features and security enhancements.
Authentication
There is process flow for authenticating to Opsview within the Introduction in the Authentication section
Logging in Copied
URL: /rest/login
GET— unimplemented.POST— get session token. Pass in username and password.PUT— unimplemented.DELETE— if session token is valid, deletes from session list, effectively a logout.
Note
Theopsview_restcommand will automatically take care of authentication for you without having to post credentials to the login endpoint.
If a token cannot be generated, a 503 HTTP status code will be returned, with the text, “Error creating session token after 5 attempts”.
Example curl request:
$ curl -H 'Content-Type: application/json' -X 'application/json' -X POST -d '{"username":"admin","password":"initial"}' http://localhost/rest/login
Example response:
{
"token": "7cd5652f7bfde4220211d063c166b263160a7d52"
}
The length of the token is 32 characters.
If you can pass the parameter, include_user_data=1, a user_data field will be returned in the response. This will contain the data from the /rest/user call.
Logging out Copied
URL: /rest/logout
POST— deletes the session.GET,PUT,DELETE— unimplemented.
Example opsview_rest request
opsview_rest --username=admin --password=initial --data-format=json --pretty POST logout
Expected response:
{
"logout_via" : "REST API"
}
User information Copied
URL: /rest/user
GET— returns user information for the currently authenticated user.POST,PUT,DELETE— unimplemented.
This returns information about the user.
See include_user_data=1 in the login section above for fetching this information via a curl request when authenticating.
Example opsview_rest request:
$ opsview_rest --token-file /path/to/opsview_restapi_token --pretty GET user
Example response:
{
"access_list": {
"ACTIONALL": 1,
"ADMINACCESS": 1,
"VIEWALL": 1,
...
},
"fullname": "Admin user",
"language": "",
"name": "admin",
"realm": "local",
"role": "Administrator"
}