Get all blocked ips

GET
/api/users/[user_id]/blocked_ips

Query Parameters

page
number

Page Number

size
number

Page Size

filter
string

Ip address by which the blocked ips needs to be filtered.

sort
string

Value in 'sort_key:sort_order' format, by which results will be sorted. Sort order value can be '1' for ascending and '-1' for descending. Acceptable sort key values are 'block_until' and 'last_login_attempt'

Path Parameters

user_id
string
Required

User Id

Authentication

X-API-KEY
header
Required

Api key needed to access the endpoints. X-API-KEY: Your_API_Key

Headers

accept
string
  • application/json
  • application/problem+json

Responses

200
OK
400
Bad Request
422
Unprocessable Entity
404
Not Found
401
Unauthorized
403
Forbidden

Request Example

Request
curl -X GET "https://<your-domain>/api/users/{user_id}/blocked_ips?page=1&size=10&filter=1.1.1.1&sort=block_until:1" \
 -H "X-API-KEY: <your-api-key>" \
 -H "Accept: application/json"

Response Example

Response
200 OK
[
  {
    "login_count": 20,
    "ip": "1.1.1.1",
    "block_until": 1658129587,
    "failure_count": 4,
    "last_login_attempt": 1640975400
  }
]