Admin Guide

Synapse-Whoxy Admin Guide

Configuration

Synapse-Whoxy requires an API key. For information on how to signup, please visit the Whoxy API documentation.

Setting API key for global use

To set-up a global API key:

> whoxy.setup.apikey myapikey
Setting Whoxy API key for all users.

Using per-user API keys

A user may set-up their own API key:

> whoxy.setup.apikey --self myapikey
Setting Whoxy API key for the current user.

Permissions

Package (synapse-whoxy) defines the following permissions:
power-ups.whoxy.user             : Allows a user to issue queries to the Whoxy API. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule fred power-ups.whoxy.user
Added rule power-ups.whoxy.user to user fred.

or:

> auth.role.addrule ninjas power-ups.whoxy.user
Added rule power-ups.whoxy.user to role ninjas.

Exported APIs

Synapse-Whoxy does not currently export any APIs.

Node Actions

Synapse-Whoxy provides the following node actions in Optic:

Name : whoxy.whois.lookup
Desc : Ingest live WHOIS record.
Forms: inet:fqdn

Name : whoxy.whois.history
Desc : Ingest historical Whoxy WHOIS records.
Forms: inet:fqdn

Name : whoxy.whois.reverse
Desc : Search and ingest Whoxy WHOIS records.
Forms: ps:name, ou:name, inet:email

Onload Events

Synapse-Whoxy does not use any onload events.