Developer Guidelines
3.54.0
Search this version
Developer Guidelines
Developer Guidelines
METADEFENDER IT ACCESS APIs
Archived 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?
Get Reports v3.0
Copy Markdown
Open in ChatGPT
Open in Claude
| API version | 3.0 |
|---|---|
| Last Update | 01/22/2019 |
| Authentication | YES |
| Response Format | CSV | ZIP | JSON |
| HTTP Method | GET |
| Rate limited | YES |
| Requests per rate limit | 10/min |
| Change History | 01/22/2019: add one more export type (type parameter in request), agent_log |
Use to download reports such as OS patches summary, devices which missing a specific OS patch, missing OS patches on a specific device, MetaAccess agent log
API URL
https://gears.opswat.com/o/api/v3/get_reportsRequest Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| access_token | string | URL | Yes | access token which archived from OAuth authentication step | |
| type | string | URL | Yes | Specify what report you want to download. Values can be:
| |
| command_id | string | URL | Optional | Must be passed in if the report type is agent_log Command ID which archived from Device Action when you request to retrieve MetaAccess agent logs | |
| kb | string | URL | Optional | Must be passed in with if the report type is device_missing_os_patch KB Number of an OS patch you would like to download devices which are missing the OS patch. | |
| id | string | URL | Optional | Must be passed in if the report type is missing_os_patch Device ID or D MAC address |
Response HTTP Code
See APIs
Response Parameters
| Key | Datatype | Description |
|---|---|---|
| status | string | This is only applied for agent_log type Status of a command. Value can be
|
| message | string | This is only applied for agent_log type Details of the status |
| error | string | This is only applied for agent_log type Indicate what is wrong |
| error_description | string | This is only applied for agent_log type Details of the error |
Example
GET OS Patches Summary Report
Request Example
https://gears.opswat.com/o/api/v3/get_reports?type=os_patch_summary&access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234Example Response: csv file
| No. | Category | KB Number | Title | Description | Product | Vendor | Severity | No. of Devices |
|---|---|---|---|---|---|---|---|---|
| 1 | critical_update | KB3115040 | Update for Microsoft Project 2013 32-Bit Edition | Microsoft has released an update for Microsoft Project 2013 32-Bit Edition. | Office 2013 | Microsoft Corporation | unknown | 1 |
| 2 | critical_update | KB3115039 | Update for Microsoft OneDrive for Business 32-Bit Edition | Microsoft has released an update for Microsoft OneDrive for Business 32-Bit Edition. | Office 2013 | Microsoft Corporation | unknown | 1 |
GET Devices Which Missing a Specific OS Patch Report
Request Example
https://gears.opswat.com/o/api/v3/get_reports?type=device_missing_os_patch&kb=KB3115040&access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234Response Example: csv file
| KB Number: KB3115040 | |||
|---|---|---|---|
| Title: Update for Microsoft Project 2013 32-Bit Edition | |||
| No. | Device ID | Device Name | Username |
| 1 | 3AD89B1F7647455889897B5D2A63D15A | WSEVN20 | bob |
GET Missing OS Patches on Device
Request Example
https://gears.opswat.com/o/api/v3/get_reports?type=missing_os_patch&id=00:0c:29:cd:c7:b2&access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234Response Example: csv file
| Last information updated: May 04, 2016 03:23:13 AM UTC | |||||||
|---|---|---|---|---|---|---|---|
| No. | Category | KB Number | Title | Description | Product | Vendor | Severity |
| 1 | update | KB3013816 | Update for Windows 8.1 for x64-based Systems | Install this update to resolve issues in Windows | Windows 8.1 | Microsoft Corporation | unknown |
GET Fetch Log Reports
Request Example
https://gears.opswat.com/o/api/v3/get_reports?type=agent_log&command_id=5c2c59e91e772804e4235319&access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234Response Example:
Successful
- HTTP 200
- Response: a zip file. It contains MetaAccess agent logs
Command ID is valid but MetaAccess agent log is not available
- HTTP 202
- Response: json
//The command is in queue{ "status" : "Queued", "message" : "Command has not completed"} //The command is sent to a device but the device has not responded yet{ "status" : "Pending", "message" : "Command has not completed"} //A device responded but the device couldn't complete a command{ "status" : "Failed", "message" : "Command has not been successful"}- Command is invalid or doesn't exist
- HTTP 404
- Response: json
{ "error" : "invalid_request", "error_description" : "Command not found"}History
| API | Version | URL |
|---|---|---|
| Get Reports | 2.0 | Get Reports v2.0 |
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:
Search Devices v2.1Discard 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
