Account Details

Use this API to fetch your account details

API URL

https://gears.opswat.com/o/api/v3.2/account

Key	Datatype	Parameter Type	Required	Description	Default
access_token	string	Header	Yes	access token which archived from OAuth authentication step
score_type	string	Body	Optional	Specify what score type used to filter along with the field filter.score Value can be: "opswat_score", "cvss2_ score", "cvss3_score"	opswat_score

See details in the Response HTTP Code section in this page

Key	DataType	Description
name	string	Account Name
email	string	Owner email address
last_login	string	The last date when the owner user logged into My OPSWAT Central Management console
date_created	string	Date when the account was created
devices_allowed	int	Maximal number of devices is allowed to be monitored by on the account
devices_used	int	Number of monitored devices on the account
license_key	string	Account license key
devices_by_status	Array <object>
devices_by_status.status	string	compliant : device is compliance with policy non-compliant : device is non-compliance with policy exempted : device is exempted unknown : device is not installed My OPSWAT Central Management agent
devices_by_status.number_of_devices	int	Number of devices by status
devices_by_issue_severity	Array <object>
devices_by_issue_severity.severity	string	critical : device has critical issues warning : device has warning issues no_issue: device doesn't have any issues
devices_by___issue_severity.number_of_devices	int	Number of devices by issue severity
devices_by_vulnerability_severity	Array <object>
devices_by_vulnerability_severity.severity	string	Vulnerability severity: Value can be: "critical", "important", "moderate", "low", "unknown", "high", "medium".
devices_by_vulnerability_severity.number_of_devices	int	Number of devices by vulnerability severity

Example request using "score_type"

https://gears.opswat.com/o/api/v3.2/account?access_token=TEST7P9ZMJ2LBF8AMOMJLNPMMLO953AVQ4C9YFF52R61234

{

"score_type": "opswat_score"

}

Example Response

{

"name": "OPSWAT IT",

"email": "opswat_it@opswat.com",

"last_login": "2017-03-09T08:00:00Z",

"date_created": "2013-10-04T08:00:00Z",

"devices_allowed": 500,

"devices_used": 120,

"devices_by_status": [

{

"status": "compliant",

"number_of_devices": 110

{

"status": "non-compliant",

"number_of_devices": 5

{

"status": "exempted",

"number_of_devices": 5

{

"status": "unknown",

"number_of_devices": 25

}

"devices_by_issue_severity": [

{

"severity": "critical",

"number_of_devices": 2

Last updated on

Was this page helpful?