Account Details
| 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
Request 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 APIs
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 MetaDefender IT-OT Access 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"
Example Response
History
| Action | Version | URL |
|---|---|---|
| Account Details | 3.1 | Account Details v3.1 |
| Account Details | 3.0 | Account Details v3.0 |
| Account Details | 2.0 | Account Details v2.0 |
Was this page helpful?