Sign in
IP Filters (iam/v2)

Create an IP Filter

General Availability

Make a request to create an IP filter.

post/iam/v2/ip-filters

Request body

api_version'iam/v2'

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

kind'IpFilter'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

filter_namestring required

A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: [, ], |, &, +, -, _, /, ., ,.

resource_groupstring required

Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple".

resource_scopestring uri

A CRN that specifies the scope of the ip filter, specifically the organization or environment. Without specifying this property, the ip filter would apply to the whole organization.

operation_groupsstring[]

Scope of resources covered by this IP filter. Resource group must be set to 'multiple' in order to use this property.During update operations, note that the operation groups passed in will replace the list of existing operation groups (passing in an empty list will remove all operation groups) from the filter (in line with the behavior for ip_groups).

Example request

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

Response

An IP Filter was created.

api_version'iam/v2'

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

kind'IpFilter'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

filter_namestring required

A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: [, ], |, &, +, -, _, /, ., ,.

resource_groupstring required

Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple".

resource_scopestring uri

A CRN that specifies the scope of the ip filter, specifically the organization or environment. Without specifying this property, the ip filter would apply to the whole organization.

operation_groupsstring[]

Scope of resources covered by this IP filter. Resource group must be set to 'multiple' in order to use this property.During update operations, note that the operation groups passed in will replace the list of existing operation groups (passing in an empty list will remove all operation groups) from the filter (in line with the behavior for ip_groups).

Example response

{
  "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.