blocklist
The following APIs are available on Brekeke SIP Server 3.16.0 or later.
blocklist/list
Description:
List block list data
blocklist
Parameters:
condition -an object or an array of objects including the following two fields.
field – “ip” or “reason”
text – A search text. When the field is “ip”, ip of the entries start with the text will match. when the field is “reason”, reason of the entries contain with the text will match.
limit – the maximum number of search results to be returned.
offset – the starting position of the search.
Retruns:
data – an array of block list entry total – a total number of the entries that match the given conditions offset – a starting position of the data
Example of sending request:
blocklist/add
Description:
Add a block list entry
blocklist
Parameters:
ip – IP address
reason – reason for blocking
Example of sending request:
blocklist/delete
Description:
Delete a block list entry or an array of blocklist entries.
blocklist
Parameters:
ip – IP address
Example of sending request 1:
Example of sending request 2:
