The REST API

Quail's REST API

Basic Format:

http://hostname:port/secret/query?var=value
OR
http://hostname:port/secret/shortname/query?var=value

Explanation:

• hostname - Your computer's IP address, or a web page's hostname. Example: 192.168.1.1 or google.com
• port - The server's port, which is by default 8000 (Look in config.json).
• secret - The password needed to access the server (Look in config.json).
• query - The actual query that you want the server to respond to; it should be encoded as a normal url (%20 for space, etc).
• shortname - If this is specified, only the plugin with that specific shortname value will be queried. Shortname values are in a plugin's config. For more information, look here. For example, if
  input -> [one] -> output
input -> [two] -> somethingelse
http://hostname:port/secret/input -> output
  then
  http://hostname:port/secret/two/input -> somethingelse

Variables

• n - The amount of records to respond with. Set to one to receive only the packet that you requested. A value of zero will receive all packets. Default: 0