Developer Guidelines
10.4.2602
Search this version
Developer Guidelines
Developer Guidelines
oAuth APIs
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
Account Details
Summarize Page
Copy Markdown
Open in ChatGPT
Open in Claude
| API version | 3.2 |
|---|---|
| Last Update | 04/18/2023 |
| Authentication | YES |
| HTTP Method | POST |
| Rate limited | YES |
| Requests per rate limit | 10/min |
| Response Format | JSON |
| Change History | Added a new “score_type” |
Use this API to fetch your account details
API URL
https://gears.opswat.com/o/api/v3.2/accountRequest Parameters
| 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 |
Response HTTP Code
See auto$
Response Parameters
| Key | DataType | Description |
|---|---|---|
| name | string | Account Name |
| 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 |
|
| devices_by_status.number_of_devices | int | Number of devices by status |
| devices_by_issue_severity | Array <object> | |
| devices_by_issue_severity.severity | string |
|
| 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
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 }, { "severity": "warning", "number_of_devices": 50 }, { "severity": "no_issue", "number_of_devices": 68 } ], "devices_by_vulnerability_severity": [ { "severity": "critical", "number_of_devices": 20 }, { "severity": "important", "number_of_devices": 50 }, { "severity": "moderate", "number_of_devices": 23 }, { "severity": "low", "number_of_devices": 17 }, { "severity": "unknown", "number_of_devices": 10 } ], "license_key": "testcccd3e7201ee83e2c4b9f6dfc96c"}History
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Last updated on
Was this page helpful?
Next to read:
Account PolicyDiscard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message
