Sign in
IP Access Control

Create a new IP access control rule

Changed on
post/ip-access-control

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ip-access-control
  • Auth: HTTP bearer

Request body

actionstring required

Action to take: "block" or "allow"

ip_addressstring required

IPv4 or IPv6 address, in CIDR notation for ranges (e.g., "192.168.1.1", "10.0.0.0/24", "2001:db8::1", or "2001:db8::/32")

reasonstring nullable

Optional reason for the action

Example request

{
  "action": "block",
  "ip_address": "192.168.1.100",
  "reason": "Malicious activity detected"
}

Response

IP access control rule created

actionstring required
created_atstring required
created_byinteger nullable
idinteger required
ip_addressstring required
reasonstring nullable
updated_atstring required

Example response

{
  "created_at": "2025-10-12T12:15:47.609Z",
  "updated_at": "2025-10-12T12:15:47.609Z"
}

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status