Admin Guide¶
Synapse-VXIntel Admin Guide¶
Configuration¶
Synapse-VXIntel requires an API key. To create one, please visit the VXIntel site.
Setting an API key for global use¶
To set-up a global API key:
> vxintel.setup.apikey myapikey
Setting VXIntel API key for all users.
Using per-user API keys¶
A user may set-up their own API key:
> vxintel.setup.apikey --self myapikey
Setting VXIntel API key for the current user.
Permissions¶
Package (synapse-vxintel) defines the following permissions:
power-ups.vxintel.user : Allows a user to issue queries to the VXIntel API.
You may add rules to users/roles directly from storm:
> auth.user.addrule visi power-ups.vxintel.user
User (visi) added rule: power-ups.vxintel.user
or:
> auth.role.addrule ninjas power-ups.vxintel.user
Role (ninjas) added rule: power-ups.vxintel.user
Exported APIs¶
Synapse-VXIntel does not currently export any APIs.
Node Actions¶
Synapse-VXIntel provides the following node actions in Optic:
Name : download
Desc : download file bytes
Forms: file:bytes, hash:md5, hash:sha1, hash:sha256
Onload Events¶
Synapse-VXIntel uses an onload
event which creates the Storm Dmon used
by vxintel.files.daily
for downloading files in the background.