Add IP to blacklist

POST

/api/v1/admin/security/ip-blacklist

curl --request POST \
  --url http://localhost:3001/api/v1/admin/security/ip-blacklist \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "expires_in": 1, "ip_address": "example", "reason": "example" }'

• Local development
• Production

Add an IP address or CIDR range to the blacklist. Requires admin:view_audit_logs permission.

Authorizations

• BearerAuth

Request Body^required

IP blacklist request

Media typeapplication/json

object

expires_in

Hours, 0 = permanent

integer

ip_address

string

reason

string

Example^generated

{
  "expires_in": 1,
  "ip_address": "example",
  "reason": "example"
}

Responses

200

OK

Media typeapplication/json

object

expires_at

string

id

integer

message

string

success

boolean

Example^generated

{
  "expires_at": "example",
  "id": 1,
  "message": "example",
  "success": true
}

400

Bad Request

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

403

Forbidden

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}