IP Filters

Create IP filter

Changed on

Creates a new IP filter with the provided configuration

post/api/ip-filters

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/ip-filters
  • Auth: none required

Request body

addressstring required

A regex pattern matched against the remote client's IP address. A plain IP address (e.g. 192.168.1.1) is treated as a literal pattern. Use * to allow all addresses, or a regex prefix like 192\.168\. to allow an entire subnet. Both IPv4 and IPv6 addresses (including IPv4-mapped IPv6) are supported.

descriptionstring required

A description of the purpose or reason for this IP filter.

Example request

{
  "address": "192\\.168\\.1\\..*",
  "description": "Allow traffic from the local admin workstation"
}

Response

IP filter created successfully

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

addressstring required

A regex pattern matched against the remote client's IP address. A plain IP address (e.g. 192.168.1.1) is treated as a literal pattern. Use * to allow all addresses, or a regex prefix like 192\.168\. to allow an entire subnet. Both IPv4 and IPv6 addresses (including IPv4-mapped IPv6) are supported.

descriptionstring required

A description of the purpose or reason for this IP filter.

Example response

{
  "id": "entity123",
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "2023-10-31T12:34:56.789Z",
  "address": "192\\.168\\.1\\..*",
  "description": "Allow traffic from the local admin workstation"
}

Changes

  • cdb5b7ea7199Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 108013c94629Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from 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