Sign in
IP Groups (iam/v2)

Read an IP Group

General Availability

Make a request to read an IP group.

get/iam/v2/ip-groups/{id}

Path parameters

idstring required

The unique identifier for the IP group.

Response

IP Group.

api_version'iam/v2' required

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

kind'IpGroup' required

Kind defines the object this REST resource represents.

idstring required

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

group_namestring required

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

cidr_blocksstring[] required

A list of CIDRs.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/ip-groups/ipg-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/ip-group=ipg-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"
  },
  "group_name": "CorpNet",
  "cidr_blocks": [
    "192.168.0.0/24",
    "192.168.7.0/24"
  ]
}

Changes

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