IP Filters (iam/v2)

List of IP Filters

General Availability

Retrieve a sorted, filtered, paginated list of all IP filters.

get/iam/v2/ip-filters

Query parameters

resource_scopestring

Lists all filters belonging to the specified resource scope.

include_parent_scopesstring

If set to true, this includes filters defined at the organization level. The resource scope must also be set to use this parameter.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

IP Filter.

api_version'iam/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'IpFilterList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/iam/v2/ip-filters",
    "last": "https://api.confluent.cloud/iam/v2/ip-filters?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/iam/v2/ip-filters?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/iam/v2/ip-filters?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/iam/v2/ip-filters/ipf-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/ip-filter=ipf-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "filter_name": "Management API Rules",
      "resource_group": "management",
      "resource_scope": "crn://confluent.cloud/organization=org-123/environment=env-abc",
      "operation_groups": [
        "MANAGEMENT",
        "SCHEMA",
        "FLINK"
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.