The DroneBL RPC WebService v1
-----------------------------

*Highly available querying and manipulation of the DroneBL database.*

## Deprecation Warning

RPC2 is now active, and documentation [is now available](rpc2).
We are currently working on standardizing RPC2 as a DNSBL provider interaction protocol.

However, RPC1 will continue to work for the forseeable future.

## Introduction

The DroneBL RPC WebService is used to connect the DroneBL to other codebases
and scripts. Mostly it is used internally to add and remove entries in the
database on demand. To use the WebService, you will need an RPCKEY, which
you can get by contacting us. Our BOPM reporting service is an example of
possible usage of the RPC webservice.

## Methods

Once you have acquired an RPCKEY, you can use these methods. Note that some
methods may not be available depending on what level of access your RPCKEY has.

Url to send requests to: **https://dronebl.org/rpc**

DroneBL supports POST and GET requests. Please use the following format:

### Parameters

 * **rpckey** (*mandatory*): your rpckey.
 
 * **action** (*mandatory*): what to perform.
 
   * **add**: Adds a new entry to the DroneBL.
     * **ip** (*mandatory*): The IP of the entry to add.
     * **type** (*mandatory*): The type of blocking class to add the IP to.
	 * **port**: The affected port. This will not be shown to the user on site, info is for reference only, and might be used in the future for rechecking.
     * **comment**: very basic description of the event (IRC flood / SSH brute force / list scrape / etc.)