Update Yara rules and file hashes for MetaDefender Kiosk

API version1.0
Last Update06/17/2025
AuthenticationYES
HTTP MethodPOST
Content Typeapplication/json
Rate limitedYES
Requests per rate limit10/min
Response FormatJSON

Update Yara rules and file hashes for MetaDefender Kiosk.

API URL

Copy

Request Parameters

KeyDatatypeParameter TypeRequiredDescriptionDefault
AuthorizationstringHeaderYesBearer token for Authentication Authorization: Bearer ACCESS_TOKEN
apply_typestringBodyYes

Value:

  • all: apply for all instances
  • instances: apply for specific instances in apply_to
apply_toarray<string>BodyOptionalThe list of instance IDs will be updated the file hashes and Yara rules.20
yara_sourcesobjectBodyOptional
yara_sources.typestringBodyrequired

Possible values:

  • append: will append to existing yara rules
  • overwrite: will overwrite all yara rules
skip__by__hashobjectBodyOptional
skip_by_hash.typestringBodyrequired

Possible values:

  • append: will append to existing yara rules
  • overwrite: will overwrite all yara rules

Response HTTP Code

See details in the Response HTTP Code section in this page

Response Parameters

KeyDataTypeDescription
total_appliedintThe 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

Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Sample Code
On This Page
Update Yara rules and file hashes for MetaDefender KioskAPI URLRequest ParametersResponse HTTP CodeResponse ParametersExample