Update Yara rules and file hashes for MetaDefender Kiosk
| API version | 1.0 |
|---|---|
| Last Update | 06/17/2025 |
| Authentication | YES |
| HTTP Method | POST |
| Content Type | application/json |
| Rate limited | YES |
| Requests per rate limit | 10/min |
| Response Format | JSON |
Update Yara rules and file hashes for MetaDefender Kiosk.
API URL
Request Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| Authorization | string | Header | Yes | Bearer token for Authentication Authorization: Bearer ACCESS_TOKEN | |
| apply_type | string | Body | Yes | Value:
| |
| apply_to | array<string> | Body | Optional | The list of instance IDs will be updated the file hashes and Yara rules. | 20 |
| yara_sources | object | Body | Optional | ||
| yara_sources.type | string | Body | required | Possible values:
| |
| skip__by__hash | object | Body | Optional | ||
| skip_by_hash.type | string | Body | required | Possible values:
|
Response HTTP Code
See details in the Response HTTP Code section in this page
Response Parameters
| Key | DataType | Description |
|---|---|---|
| total_applied | int | The number of instances will be applied the Yara rules and file hashes. Note that My OPSWAT Central Management will save this change and will send to MetaDefender Kiosk next time it checks in with My OPSWAT Central Management. |
Example
Example Request
Was this page helpful?