Skip to main content

ip_addresses

Creates, updates, deletes, gets or lists an ip_addresses resource.

Overview

Nameip_addresses
TypeResource
Idconfluent.networking.ip_addresses

Fields

The following fields are returned by SELECT queries:

IP Address.

NameDatatypeDescription
address_typestringWhether the address is used for egress or ingress. (example: EGRESS)
api_versionstringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
cloudstringThe cloud service provider in which the address exists. (example: AWS)
ip_prefixstringThe IP Address range. (pattern: ^\d+.\d+.\d+.\d+/\d+$, example: 10.200.0.0/28)
kindstringKind defines the object this REST resource represents. (IpAddress)
regionstringThe region/location where the IP Address is in use. (example: us-east-1)
servicesarrayThe service types that will use the address.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_networking_v1_ip_addressesselectcloud, region, services, address_type, page_size, page_tokenRelated guide: Use Public Egress IP addresses on Confluent Cloud

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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
address_typearrayFilter the results by exact match for address_type. Pass multiple times to see results matching any of the values. (example: [INGRESS, EGRESS])
cloudarrayFilter the results by exact match for cloud. Pass multiple times to see results matching any of the values. (example: [GCP, AWS])
page_sizeintegerA pagination size for collection requests.
page_tokenstringAn opaque pagination token for collection requests.
regionarrayFilter the results by exact match for region. Pass multiple times to see results matching any of the values. (example: [us-central1, us-east-1])
servicesarrayFilter the results by exact match for services. Pass multiple times to see results matching any of the values. (example: [KAFKA, CONNECT])

SELECT examples

Related guide: Use Public Egress IP addresses on Confluent Cloud

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

SELECT
address_type,
api_version,
cloud,
ip_prefix,
kind,
region,
services
FROM confluent.networking.ip_addresses
WHERE cloud = '{{ cloud }}'
AND region = '{{ region }}'
AND services = '{{ services }}'
AND address_type = '{{ address_type }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;