v51

OpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-01133591927.1 KB

IP Filters

Get an IP filter

Retrieves a specific IP filter by its unique identifier

get/api/ip-filters/{ipFilterId}

Path parameters

ipFilterIdstring required

Response

The IP filter object

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"
}