---
title: "Get an IP filter"
method: GET
path: "/api/ip-filters/{ipFilterId}"
tags: ["IP Filters"]
---

# Get an IP filter

`GET /api/ip-filters/{ipFilterId}`

Retrieves a specific IP filter by its unique identifier

## Path parameters

- `ipFilterId` string, required

## Response `200`

The IP filter object

- IPFilterDTO — Data Transfer Object for an IP filter. Represents a configured IP filter with its address and description.
  - `id` string, required — The unique identifier of the entity.
  - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
  - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
  - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
  - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string.
  - `address` string, 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.
  - `description` string, required — A description of the purpose or reason for this IP filter.

---

[API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/versions/743d1b62f042/schema)