Blocked IPs

Blocked IPs prevent reports from being processed when the request originates from specific IP addresses or ranges. If a report is created from one of your blocked IPs, it will automatically be canceled right away. This feature must be enabled for your account.
Entries accept a single IPv4 or IPv6 address, or a range in CIDR notation. Ranges are capped in breadth - a prefix broader than /24 for IPv4 or /48 for IPv6 is rejected.
Unlike blocked SSNs, blocked IPs are returned in plaintext rather than masked.
Use this resource to manage the list of blocked IPs for your account.

List blocked IPs

Retrieve a paginated list of blocked IPs for your account. See Pagination.

SecurityApiKey
Request
query Parameters
page
integer

The page number to retrieve.

per_page
integer

The maximum number of results per page.

object

Filter the listing by IP.

Examples:
query[ip_cont]=203.0.113
Responses
200

List of blocked IPs

401

Unauthorized

403

Forbidden

get/blocked-ips
Request samples 
Response samples 
application/json
{
  • "object": "list",
  • "meta": {
    },
  • "data": [
    ]
}
Create a blocked IP
Add an IP address or CIDR range to the blocked list for your account. Reports created from a blocked IP will automatically be canceled right away.


SecurityApiKey 
Request 
Request Body schema: application/json
required
required
object
 
Responses 
201
Blocked IP was created successfully


400
Bad Request


401
Unauthorized


403
Forbidden


422
Unprocessable Entity


post/blocked-ips
Request samples 
application/json
{
  • "blocked_ip": {
    }
}
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "ip": "203.0.113.7",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Delete a blocked IP
Remove an IP address or range from the blocked list for your account.
This won't impact any previously-canceled reports from that IP. It will allow processing of future reports created from that IP.


SecurityApiKey 
Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the blocked IP to delete.


 
Responses 
204
Blocked IP was deleted successfully


401
Unauthorized


403
Forbidden


404
Not Found


delete/blocked-ips/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Blocked Emails